new: comment dto object now inherits from interface for extensibility

Author: Marvin Kuhn

Classes/Dto/CommentDto.php

@@ -1,7 +1,7 @@
 <?php
 namespace Breadlesscode\Commentable\Dto;
 
-class CommentDto
+class CommentDto implements CommentDtoInterface
 {
     /**
      * @var string

Classes/Dto/CommentDtoInterface.php

@@ -0,0 +1,55 @@
+<?php
+namespace Breadlesscode\Commentable\Dto;
+
+interface CommentDtoInterface
+{
+    /**
+     * @return string
+     */
+    public function getEmail(): string;
+
+    /**
+     * @param string $email
+     */
+    public function setEmail(string $email): void;
+
+    /**
+     * @return string
+     */
+    public function getName(): string;
+
+    /**
+     * @param string $name
+     */
+    public function setName(string $name): void;
+
+    /**
+     * @return string
+     */
+    public function getContent(): string;
+
+    /**
+     * @param string $content
+     */
+    public function setContent(string $content): void;
+
+    /**
+     * @return \DateTime
+     */
+    public function getCreatedAt(): \DateTime;
+
+    /**
+     * @param \DateTime $createdAt
+     */
+    public function setCreatedAt(\DateTime $createdAt): void;
+
+    /**
+     * @return bool
+     */
+    public function isHidden(): bool;
+
+    /**
+     * @param bool $isHidden
+     */
+    public function setIsHidden(bool $isHidden): void;
+}

Classes/Form/Finisher/AddCommentFormFinisher.php

@@ -1,14 +1,20 @@
 <?php
 namespace Breadlesscode\Commentable\Form\Finisher;
 
-use Breadlesscode\Commentable\Dto\CommentDto;
+use Breadlesscode\Commentable\Dto\CommentDtoInterface;
 use Breadlesscode\Commentable\Exception\InvalidNodeTypeException;
 use Breadlesscode\Commentable\Service\CommentService;
 use Neos\Form\Core\Model\AbstractFinisher;
 use Neos\Flow\Annotations as Flow;
 
 class AddCommentFormFinisher extends AbstractFinisher
 {
+    /**
+     * @var \Neos\Flow\ObjectManagement\ObjectManagerInterface
+     * @Flow\Inject()
+     */
+    protected $objectManager;
+
     /**
      * @var CommentService
      * @Flow\Inject()
@@ -40,24 +46,24 @@ protected function executeInternal()
     }
 
     /**
-     * @return CommentDto
+     * @return CommentDtoInterface
      */
-    protected function getCommentDto(): CommentDto
+    protected function getCommentDto(): CommentDtoInterface
     {
-        $comment = new CommentDto();
+        $comment = $this->objectManager->get(CommentDtoInterface::class);
         $comment->setName($this->parseOption('name'));
         $comment->setEmail($this->parseOption('email'));
         $comment->setContent($this->parseOption('content'));
         $comment->setIsHidden($this->defaultHidden);
 
         return $comment;
     }
-    
+
     /**
      * @return mixed
      */
     public function getOption($optionName)
     {
-        return $this->parseOption($optionName);   
+        return $this->parseOption($optionName);
     }
 }

Classes/Service/CommentService.php

@@ -1,7 +1,7 @@
 <?php
 namespace Breadlesscode\Commentable\Service;
 
-use Breadlesscode\Commentable\Dto\CommentDto;
+use Breadlesscode\Commentable\Dto\CommentDtoInterface;
 use Breadlesscode\Commentable\Exception\InvalidNodeTypeException;
 use Neos\ContentRepository\Domain\Model\NodeInterface;
 use Neos\ContentRepository\Domain\Model\NodeTemplate;
@@ -43,11 +43,11 @@ class CommentService
      * creates a comment node from the CommentDto
      *
      * @param NodeInterface $commentCollection
-     * @param CommentDto $comment
+     * @param CommentDtoInterface $comment
      * @return NodeInterface
      * @throws \Neos\ContentRepository\Exception\NodeTypeNotFoundException
      */
-    protected function createNode(NodeInterface $commentCollection, CommentDto $comment): NodeInterface
+    protected function createNode(NodeInterface $commentCollection, CommentDtoInterface $comment): NodeInterface
     {
         $commentNodeType = $this->nodeTypeManager->getNodeType(self::COMMENT_NODE_TYPE);
         $commentNodeTemplate = new NodeTemplate();
@@ -72,11 +72,11 @@ protected function createNode(NodeInterface $commentCollection, CommentDto $comm
      * adds a comment node to a blog post node
      *
      * @param NodeInterface $commentableNode
-     * @param CommentDto $comment
+     * @param CommentDtoInterface $comment
      * @throws InvalidNodeTypeException
      * @throws \Neos\ContentRepository\Exception\NodeTypeNotFoundException
      */
-    public function addComment(NodeInterface $commentableNode, CommentDto $comment)
+    public function addComment(NodeInterface $commentableNode, CommentDtoInterface $comment)
     {
         if (!$this->isCommentableNode($commentableNode)) {
             throw new InvalidNodeTypeException('The commentable node type should implement the mixin '.self::COMMENTABLE_NODE_TYPE, 1536244558);

Configuration/Objects.yaml

@@ -0,0 +1,2 @@
+Breadlesscode\Commentable\Dto\CommentDtoInterface:
+  className: 'Breadlesscode\Commentable\Dto\CommentDto'