internship-playground/src-php/app/internship/controller/ArticleApiController.php

<?php
namespace internship\controller;

use n2n\web\http\controller\ControllerAdapter;
use internship\model\ArticleDao;
use n2n\context\attribute\Inject;
use n2n\web\http\controller\ParamBody;
use internship\bo\Article;
use n2n\web\http\PageNotFoundException;
use n2n\web\http\BadRequestException;
use n2n\web\http\StatusException;

/**
 * REST Controller
 * https://dev.n2n.rocks/de/n2n/docs/rest
 */
class ArticleApiController extends ControllerAdapter {
	#[Inject]
	private ArticleDao $articleDao;

	/**
	 * Gibt den {@see Article} mit der entsprechenden id im JSON Format zurück.
	 *
	 * <ul>
	 * 	<li>
	 * 		Gib "irgendöpis" mit dem {@code echo} command aus.
	 * 	</li>
	 *	<li>
	 * 		Ändere die Antwort nun zu einem gültigen json objekt {"hello" => "world"}. Übergebe dafür ein array der
	 * 		Methode {@see $this->sendJson()}.
	 * 	</li>
	 * 	<li>
	 * 		Implementiere und nutze die Methode {@see ArticleDao::getArticleById()}, um das entsprechende Artikel-Objekt
	 * 		aus der Datenbank zu lesen und gebe diese anschliessend im JSON Format zurück.
	 *
	 * 		Das Article-Objekt kannst du einfach {@see $this->sendJson()} übergeben, um einen validen JSON-Response zu
	 * 		generieren.
	 * 	</li>
	 * 	<li>
	 * 		Kann der Artikel nicht gefunden werden, werfe eine {@link PageNotFoundException}.
	 * 	</li>
	 * </ul>
	 *
	 * @param int $articleId
	 * @return void
	 * @throws PageNotFoundException if Article could not be found.
	 */
	function getDoArticle(int $articleId): void {
		$article = $this->articleDao->getArticleById($articleId);
		if ($article === null) {
			throw new PageNotFoundException();
		} else {
			$this->sendJson($article);
		}
	}

	/**
	 * Diese Methode kannst du im Browser testen. Pfad: localhost/[ordner name vom projekt]/src-php/public/api/articles
	 *
	 * <ul>
	 * 	<li>
 	 *		Implementiere und nutze die Methode {@see ArticleDao::getArticles()}, um Artikel aus der Datenbank zu lesen
	 * 		und gebe diese anschliessend im JSON Format zurück.
	 *
	 * 		Article-Objekte kannst du einfach {@see $this->sendJson()} übergeben, um einen validen JSON-Response zu
	 * 		generieren.
	 * 	</li>
	 * 	<li>
	 * 		Wird ein $categoryName übergeben, gebe nur die Artikel aus, die über diesen Kategorienamen verfügen.
	 * 	</li>
	 * </ul>
	 *
	 * @param string|null $categoryName
	 * @return void
	 */
	function getDoArticles(?string $categoryName = null): void {
		if ($categoryName == null) {
			$articlesToShow = $this->articleDao->getArticles();
		} else {
			$articlesToShow = $this->articleDao->getArticlesByCategoryName($categoryName);
		}

		$this->sendJson($articlesToShow);

		/*
		$articles = $this->articleDao->getArticles();
		$articlesToShow = [];
		if ($categoryName !== null) {
			foreach ($articles as $article) {
				if($article->getCategoryName() === $categoryName) {
					array_push($articlesToShow, $article);
				}
			}
		}
		else {
			$articlesToShow = $articles;
		}
		$this->sendJson($articlesToShow);
		*/
	}

	/**
	 * Speichere einen Artikel.
	 *
	 * <ul>
	 *    <li>
	 *        Der Kategoriename darf nur 'international','national' oder 'sport' sein.
	 *        Validiere dies und schmeisse im Fehlerfall eine: {@see BadRequestException}
	 *    </li>
	 *    <li>
	 *        Mache eine neue Entity {@see Article} und befülle sie mit den übergebenen Daten.
	 *    </li>
	 *  <li>
	 *        Implementiere eine neue Methode im {@see ArticleDao} und bennene sie "saveArticle".
	 *     </li>
	 * </ul>
	 *
	 * Nenne die Methode {@see saveArticle(Article $article)}
	 *
	 * @return void
	 * @throws StatusException
	 */
	function postDoArticle(ParamBody $body): void {

        $httpData = $body->parseJsonToHttpData();
        $title = $httpData->reqString('title');
        $text = $httpData->reqString('text');
        $categoryName = $httpData->reqString('categoryName');

        $isValidCategory = $this->isValidArticleCategory($categoryName);

        if ($isValidCategory) {

            $articleToAdd = $this->prepareArticle($title, $text, $categoryName);

            $this->beginTransaction();
            $this->articleDao->saveArticle($articleToAdd);
            $this->commit();

        } else {
            throw new BadRequestException();
        }

	}


	/**
	 * Editiere einen Artikel.
	 *
	 * <ul>
	 *    <li>
	 *        Der Kategoriename darf nur 'international','national' oder 'sport' sein.
	 *        Validiere dies und schmeisse im Fehlerfall eine: {@see BadRequestException}
	 *    </li>
	 *    <li>
	 *        Finde den dazugehörigen {@see Article} und passe die Daten mit denjenigen Daten von gestern ab.
	 *    </li>
	 *  <li>
	 *        Implementiere eine neue Methode im {@see ArticleDao} und nenne die Methode {@see saveArticle(Article $article)}.
	 *     </li>
	 * </ul>
	 *
	 * @return void
	 * @throws StatusException
	 */
	function putDoArticle(int $articleId, ParamBody $body): void {

		$httpData = $body->parseJsonToHttpData();
		$title = $httpData->reqString('title');
        $text = $httpData->reqString('text');
		$categoryName = $httpData->reqString('categoryName');

		$isValidCategory = $this->isValidArticleCategory($categoryName);
        $article =  $this->articleDao->getArticleById($articleId);

		if ($isValidCategory && $article) {

            $article->setCategoryName($categoryName);
            $article->setTitle($title);
            $article->setText($text);

			$this->beginTransaction();
			$this->articleDao->saveArticle($article);
            $this->commit();

		} else {
			throw new BadRequestException();
		}

	}

	/**
	 * Löscht den {@see Article} mit der dazugehörigen Id.
	 *
	 * <ul>
	 * 	<li>Mache eine neue Methode im {@see ArticleDao} und benenne sie "removeArticle(int articleId) </li>
	 * <ul>
	 *
	 * @return void
	 */
	function deleteDoArticle(int $articleId): void {
		$this->beginTransaction();
		$this->articleDao->removeArticle($articleId);
		$this->commit();
	}

	/*
	 * Überprüft, ob die Article Category einen gültigen Wert enthält.
	 * @return boolean
	 */
	function isValidArticleCategory($category){
		$categories = array('international', 'national', 'sport');
		return in_array($category, $categories);
	}

    /*
     * Stellt aus den Input Parametern ein Article Objekt zur Verfügung.
     * @return Article
     */
	function prepareArticle($title, $text, $categoryName): Article {
		$article = new Article();
		$article->setCategoryName($categoryName);
		$article->setTitle($title);
		$article->setText($text);
		return $article;
	}
}