ArticleController.php 4.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146
  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. $article = $this->articleDao->getArticleById($articleId);
  45. if ($article == null) {
  46. throw new PageNotFoundException();
  47. }
  48. $this->sendJson($article);
  49. }
  50. /**
  51. * Diese Methode kannst du im Browser testen. Pfad: localhost/[ordner name vom projekt]/src-php/public/api/articles
  52. *
  53. * <ul>
  54. * <li>
  55. * Implementiere und nutze die Methode {@see ArticleDao::getArticles()}, um Artikel aus der Datenbank zu lesen
  56. * und gebe diese anschliessend im JSON Format zurück.
  57. *
  58. * Article-Objekte kannst du einfach {@see $this->sendJson()} übergeben, um einen validen JSON-Response zu
  59. * generieren.
  60. * </li>
  61. * <li>
  62. * Wird ein $categoryName übergeben, gebe nur die Artikel aus, die über diesen Kategorienamen verfügen.
  63. * </li>
  64. * </ul>
  65. *
  66. * @param string|null $categoryName
  67. * @return void
  68. */
  69. function getDoArticles(string $categoryName = null): void {
  70. if ($categoryName == null)
  71. {$article = $this->articleDao->getArticles();
  72. $this->sendJson($article);}
  73. else{
  74. $article = $this->articleDao->getArticlesByCategoryName($categoryName);
  75. $this->sendJson($article);
  76. }
  77. }
  78. /**
  79. * Speichere einen Artikel.
  80. *
  81. * <ul>
  82. * <li>
  83. * Der Kategoriename darf nur 'international','national' oder 'sport' sein.
  84. * Validiere dies und schmeisse im Fehlerfall eine: {@see BadRequestException}
  85. * </li>
  86. * <li>
  87. * Mache eine neue Entity {@see Article} und befülle sie mit den übergebenen Daten.
  88. * </li>
  89. * <li>
  90. * Implementiere eine neue Methode im {@see ArticleDao} und bennene sie "saveArticle".
  91. * </li>
  92. * </ul>
  93. *
  94. * Nenne die Methode {@see saveArticle(Article $article)}
  95. *
  96. * @return void
  97. */
  98. function postDoArticle(ParamBody $body): void {
  99. $body->parseJson();
  100. }
  101. /**
  102. * Editiere einen Artikel.
  103. *
  104. * <ul>
  105. * <li>
  106. * Der Kategoriename darf nur 'international','national' oder 'sport' sein.
  107. * Validiere dies und schmeisse im Fehlerfall eine: {@see BadRequestException}
  108. * </li>
  109. * <li>
  110. * Finde den dazugehörigen {@see Article} und passe die Daten mit denjenigen Daten von gestern ab.
  111. * </li>
  112. * <li>
  113. * Implementiere eine neue Methode im {@see ArticleDao} und nenne die Methode {@see saveArticle(Article $article)}.
  114. * </li>
  115. * </ul>
  116. *
  117. * @return void
  118. */
  119. function putDoArticle(int $articleId, ParamBody $body): void {
  120. }
  121. /**
  122. * Löscht den {@see Article} mit der dazugehörigen Id.
  123. *
  124. * <ul>
  125. * <li>Mache eine neue Methode im {@see ArticleDao} und benenne sie "removeArticle(int articleId) </li>
  126. * <ul>
  127. *
  128. * @return void
  129. */
  130. function deleteDoArticle(int $articleId): void {
  131. }
  132. }