ArticleController.php 3.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130
  1. <?php
  2. namespace internship\controller;
  3. use n2n\web\http\controller\ControllerAdapter;
  4. use internship\model\ArticleDao;
  5. use n2n\context\attribute\Inject;
  6. use n2n\web\http\controller\ParamBody;
  7. use internship\bo\Article;
  8. use n2n\web\http\PageNotFoundException;
  9. /**
  10. * REST Controller
  11. * https://dev.n2n.rocks/de/n2n/docs/rest
  12. */
  13. class ArticleController extends ControllerAdapter {
  14. #[Inject]
  15. private ArticleDao $articleDao;
  16. /**
  17. * Gibt den {@see Article} mit der entsprechenden id im JSON Format zurück.
  18. *
  19. * <ul>
  20. * <li>
  21. * Gib "irgendöpis" mit dem {@code echo} command aus.
  22. * </li>
  23. * <li>
  24. * Ändere die Antwort nun zu einem gültigen json objekt {"hello" => "world"}. Übergebe dafür ein array der
  25. * Methode {@see $this->sendJson()}.
  26. * </li>
  27. * <li>
  28. * Implementiere und nutze die Methode {@see ArticleDao::getArticleById()}, um das entsprechende Artikel-Objekt
  29. * aus der Datenbank zu lesen und gebe diese anschliessend im JSON Format zurück.
  30. *
  31. * Das Article-Objekt kannst du einfach {@see $this->sendJson()} übergeben, um einen validen JSON-Response zu
  32. * generieren.
  33. * </li>
  34. * <li>
  35. * Kann der Artikel nicht gefunden werden, werfe eine {@link PageNotFoundException}.
  36. * </li>
  37. * </ul>
  38. *
  39. * @param int $articleId
  40. * @return void
  41. * @throws PageNotFoundException if Article could not be found.
  42. */
  43. function getDoArticle(int $articleId): void {
  44. }
  45. /**
  46. * Diese Methode kannst du im Browser testen. Pfad: localhost/[ordner name vom projekt]/src-php/public/api/articles
  47. *
  48. * <ul>
  49. * <li>
  50. * Implementiere und nutze die Methode {@see ArticleDao::getArticles()}, um Artikel aus der Datenbank zu lesen
  51. * und gebe diese anschliessend im JSON Format zurück.
  52. *
  53. * Article-Objekte kannst du einfach {@see $this->sendJson()} übergeben, um einen validen JSON-Response zu
  54. * generieren.
  55. * </li>
  56. * <li>
  57. * Wird ein $categoryName übergeben, gebe nur die Artikel aus, die über diesen Kategorienamen verfügen.
  58. * </li>
  59. * </ul>
  60. *
  61. * @param string|null $categoryName
  62. * @return void
  63. */
  64. function getDoArticles(string $categoryName = null): void {
  65. }
  66. /**
  67. * Speichere einen Artikel.
  68. *
  69. * <ul>
  70. * <li>
  71. * Der Kategoriename darf nur 'international','national' oder 'sport' sein.
  72. * Validiere dies und schmeisse im Fehlerfall eine: {@see BadRequestException}
  73. * </li>
  74. * <li>
  75. * Mache eine neue Entity {@see Article} und befülle sie mit den übergebenen Daten.
  76. * </li>
  77. * <li>
  78. * Implementiere eine neue Methode im {@see ArticleDao} und bennene sie "saveArticle".
  79. * </li>
  80. * </ul>
  81. *
  82. * Nenne die Methode {@see saveArticle(Article $article)}
  83. *
  84. * @return void
  85. */
  86. function postDoArticle(ParamBody $body): void {
  87. $body->parseJson();
  88. }
  89. /**
  90. * Editiere einen Artikel.
  91. *
  92. * <ul>
  93. * <li>
  94. * Der Kategoriename darf nur 'international','national' oder 'sport' sein.
  95. * Validiere dies und schmeisse im Fehlerfall eine: {@see BadRequestException}
  96. * </li>
  97. * <li>
  98. * Finde den dazugehörigen {@see Article} und passe die Daten mit denjenigen Daten von gestern ab.
  99. * </li>
  100. * <li>
  101. * Implementiere eine neue Methode im {@see ArticleDao} und nenne die Methode {@see saveArticle(Article $article)}.
  102. * </li>
  103. * </ul>
  104. *
  105. * @return void
  106. */
  107. function putDoArticle(ParamBody $body): void {
  108. }
  109. /**
  110. * Löscht den {@see Article} mit der dazugehörigen Id.
  111. *
  112. * <ul>
  113. * <li>Mache eine neue Methode im {@see ArticleDao} und bennene sie "removeArticle(int articleId) </li>
  114. * <ul>
  115. *
  116. * @return void
  117. */
  118. function deleteDoArticle(int $articleId): void {
  119. }
  120. }