ArticleController.php 3.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128
  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"}. Nutze dafür {@see $this->sendJson()}.
  25. * </li>
  26. * <li>
  27. * Implementiere und nutze die Methode {@see ArticleDao::getArticleById()}, um das entsprechende Artikel-Objekt
  28. * aus der Datenbank zu lesen und gebe diese anschliessend im JSON Format zurück.
  29. *
  30. * Das Article-Objekt kannst du einfach {@see $this->sendJson()} übergeben, um einen validen JSON-Response zu
  31. * generieren.
  32. * </li>
  33. * <li>
  34. * Kann der Artikel nicht gefunden werden, werfe eine {@link PageNotFoundException}.
  35. * </li>
  36. * </ul>
  37. *
  38. * @param int $articleId
  39. * @return void
  40. * @throws PageNotFoundException if Article could not be found.
  41. */
  42. function getDoArticle(int $articleId): void {
  43. }
  44. /**
  45. * Diese Methode kannst du im Browser testen. Pfad: localhost/[ordner name vom projekt]/src-php/public/api/articles
  46. *
  47. * <ul>
  48. * <li>
  49. * Implementiere und nutze die Methode {@see ArticleDao::getArticles()}, um Artikel aus der Datenbank zu lesen
  50. * und gebe diese anschliessend im JSON Format zurück.
  51. *
  52. * Article-Objekte kannst du einfach {@see $this->sendJson()} übergeben, um einen validen JSON-Response zu
  53. * generieren.
  54. * </li>
  55. * <li>
  56. * Wird ein $categoryName übergeben, gebe nur die Artikel aus, die über diesen Kategorienamen verfügen.
  57. * </li>
  58. * </ul>
  59. *
  60. * @param string|null $categoryName
  61. * @return void
  62. */
  63. function getDoArticles(string $categoryName = null): void {
  64. }
  65. /**
  66. * Speichere einen Artikel.
  67. *
  68. * <ul>
  69. * <li>
  70. * Der Kategoriename darf nur 'international','national' oder 'sport' sein.
  71. * Validiere dies und schmeisse im Fehlerfall eine: {@see BadRequestException}
  72. * </li>
  73. * <li>
  74. * Mache eine neue Entity {@see Article} und befülle sie mit den übergebenen Daten.
  75. * </li>
  76. * <li>
  77. * Implementiere eine neue Methode im {@see ArticleDao} und bennene sie "saveArticle".
  78. * </li>
  79. * </ul>
  80. *
  81. * Nenne die Methode {@see saveArticle(Article $article)}
  82. *
  83. * @return void
  84. */
  85. function postDoArticle(ParamBody $body): void {
  86. $body->toArray();
  87. }
  88. /**
  89. * Editiere einen Artikel.
  90. *
  91. * <ul>
  92. * <li>
  93. * Der Kategoriename darf nur 'international','national' oder 'sport' sein.
  94. * Validiere dies und schmeisse im Fehlerfall eine: {@see BadRequestException}
  95. * </li>
  96. * <li>
  97. * Finde den dazugehörigen {@see Article} und passe die Daten mit denjenigen Daten von gestern ab.
  98. * </li>
  99. * <li>
  100. * Implementiere eine neue Methode im {@see ArticleDao} und nenne die Methode {@see saveArticle(Article $article)}.
  101. * </li>
  102. * </ul>
  103. *
  104. * @return void
  105. */
  106. function putDoArticle(ParamBody $body): void {
  107. }
  108. /**
  109. * Löscht den {@see Article} mit der dazugehörigen Id.
  110. *
  111. * <ul>
  112. * <li>Mache eine neue Methode im {@see ArticleDao} und bennene sie "removeArticle(int articleId) </li>
  113. * <ul>
  114. *
  115. * @return void
  116. */
  117. function deleteDoArticle(int $articleId): void {
  118. }
  119. }