locomotivemtl / charcoal-cms

src/Charcoal/Cms/News.php

Doc Comments +7 added lines, -7 removed lines

@@ -95,7 +95,7 @@ 
 
     /**
     * @param mixed $title
-    * @return TranslationString
+    * @return News
     */
     public function setTitle($title)
     {
@@ -112,8 +112,8 @@ 
     }
 
     /**
-    * @param mixed $subbtitle
-    * @return Event Chainable
+    * @param mixed $subtitle
+    * @return News Chainable
     */
     public function setSubtitle($subtitle)
     {
@@ -131,7 +131,7 @@ 
 
     /**
     * @param mixed $content
-    * @return Event Chainable
+    * @return News Chainable
     */
     public function setContent($content)
     {
@@ -150,7 +150,7 @@ 
     /**
      * @param mixed $newsDate The news date.
      * @throws InvalidArgumentException If the timestamp is invalid.
-     * @return ObjectRevision Chainable
+     * @return News Chainable
      */
     public function setNewsDate($newsDate)
     {
@@ -171,7 +171,7 @@ 
     }
 
     /**
-     * @return DateTime|null
+     * @return DateTime
      */
     public function newsDate()
     {
@@ -207,7 +207,7 @@ 
     * @param RequestInterface $request
     * @param ResponseInterface $response
     * @throws InvalidArgumentException
-    * @return callable|null Route dispatcher
+    * @return \Closure|null Route dispatcher
     */
     public function routeHandler($path, RequestInterface $request, ResponseInterface $response)
     {

Indentation +48 added lines, -48 removed lines

@@ -44,59 +44,59 @@ 
     use SearchableTrait;
 
     /**
-    * @var TranslationString $title
-    */
+     * @var TranslationString $title
+     */
     private $title;
 
     /**
-    * @var TranslationString $title
-    */
+     * @var TranslationString $title
+     */
     private $subtitle;
 
     /**
-    * @var TranslationString $content
-    */
+     * @var TranslationString $content
+     */
     private $content;
 
     /**
-    * @var array $contentStructure
-    */
+     * @var array $contentStructure
+     */
     private $contentStructure;
 
     /**
-    * @var DateTime $newsDate
-    */
+     * @var DateTime $newsDate
+     */
     private $newsDate;
 
     /**
-    * @var TranslationString $image
-    */
+     * @var TranslationString $image
+     */
     private $image;
 
     /**
-    * @var Collection $documents
-    */
+     * @var Collection $documents
+     */
     public $documents;
 
     /**
-    * @var TranslationString $infoUrl
-    */
+     * @var TranslationString $infoUrl
+     */
     private $infoUrl;
 
     /**
-    * CategorizableTrait > categoryType()
-    *
-    * @return string
-    */
+     * CategorizableTrait > categoryType()
+     *
+     * @return string
+     */
     public function categoryType()
     {
         return 'charcoal/cms/news-category';
     }
 
     /**
-    * @param mixed $title
-    * @return TranslationString
-    */
+     * @param mixed $title
+     * @return TranslationString
+     */
     public function setTitle($title)
     {
         $this->title = new TranslationString($title);
@@ -104,17 +104,17 @@ 
     }
 
     /**
-    * @return TranslationString
-    */
+     * @return TranslationString
+     */
     public function title()
     {
         return $this->title;
     }
 
     /**
-    * @param mixed $subbtitle
-    * @return Event Chainable
-    */
+     * @param mixed $subbtitle
+     * @return Event Chainable
+     */
     public function setSubtitle($subtitle)
     {
         $this->subtitle = new TranslationString($subtitle);
@@ -122,17 +122,17 @@ 
     }
 
     /**
-    * @return TranslationString
-    */
+     * @return TranslationString
+     */
     public function subtitle()
     {
         return $this->subtitle;
     }
 
     /**
-    * @param mixed $content
-    * @return Event Chainable
-    */
+     * @param mixed $content
+     * @return Event Chainable
+     */
     public function setContent($content)
     {
         $this->content = new TranslationString($content);
@@ -140,8 +140,8 @@ 
     }
 
     /**
-    * @return TranslationString
-    */
+     * @return TranslationString
+     */
     public function content()
     {
         return $this->content;
@@ -190,25 +190,25 @@ 
     }
 
     /**
-    * MetatagTrait > canonical_url
-    *
-    * @return string
-    * @todo
-    */
+     * MetatagTrait > canonical_url
+     *
+     * @return string
+     * @todo
+     */
     public function canonicalUrl()
     {
         return '';
     }
 
     /**
-    * RoutableInterface > handle_route()
-    *
-    * @param string $path
-    * @param RequestInterface $request
-    * @param ResponseInterface $response
-    * @throws InvalidArgumentException
-    * @return callable|null Route dispatcher
-    */
+     * RoutableInterface > handle_route()
+     *
+     * @param string $path
+     * @param RequestInterface $request
+     * @param ResponseInterface $response
+     * @throws InvalidArgumentException
+     * @return callable|null Route dispatcher
+     */
     public function routeHandler($path, RequestInterface $request, ResponseInterface $response)
     {
         if (!is_string($path)) {

src/Charcoal/Cms/MetatagTrait.php

Indentation +60 added lines, -60 removed lines

@@ -10,35 +10,35 @@ 
 trait MetatagTrait
 {
     /**
-    * @var TranslationString $metaTitle
-    */
+     * @var TranslationString $metaTitle
+     */
     private $metaTitle;
     /**
-    * @var TranslationString $metaDescription
-    */
+     * @var TranslationString $metaDescription
+     */
     private $metaDescription;
     /**
-    * @var TranslationString $metaImage
-    */
+     * @var TranslationString $metaImage
+     */
     private $metaImage;
     /**
-    * @var TranslationString $metaAuthor
-    */
+     * @var TranslationString $metaAuthor
+     */
     private $metaAuthor;
 
     /**
-    * @var string $facebookAppId
-    */
+     * @var string $facebookAppId
+     */
     private $facebookAppId;
 
     /**
-    * @var TranslationString $opengraphTitle
-    */
+     * @var TranslationString $opengraphTitle
+     */
     private $opengraphTitle;
 
     /**
-    * @var TranslationString $siteName
-    */
+     * @var TranslationString $siteName
+     */
     private $opengraphSiteName;
     private $opengraphDescription;
     private $opengraphType;
@@ -48,14 +48,14 @@ 
 
 
     /**
-    * @return string
-    */
+     * @return string
+     */
     abstract public function canonicalUrl();
 
     /**
-    * @param mixed $title
-    * @return MetatagInterface Chainable
-    */
+     * @param mixed $title
+     * @return MetatagInterface Chainable
+     */
     public function setMetaTitle($title)
     {
         $this->metaTitle = new TranslationString($title);
@@ -63,17 +63,17 @@ 
     }
 
     /**
-    * @return TranslationString
-    */
+     * @return TranslationString
+     */
     public function metaTitle()
     {
         return $this->metaTitle();
     }
 
     /**
-    * @param mixed $description
-    * @return MetatagInterface Chainable
-    */
+     * @param mixed $description
+     * @return MetatagInterface Chainable
+     */
     public function setMetaDescription($description)
     {
         $this->metaDescription = new TranslationString($description);
@@ -81,17 +81,17 @@ 
     }
 
     /**
-    * @return TranslationString
-    */
+     * @return TranslationString
+     */
     public function metaDescription()
     {
         return $this->metaDescription();
     }
 
     /**
-    * @param mixed $image
-    * @return MetatagInterface Chainable
-    */
+     * @param mixed $image
+     * @return MetatagInterface Chainable
+     */
     public function setMetaImage($image)
     {
         $this->metaImage = new TranslationString($image);
@@ -99,17 +99,17 @@ 
     }
 
     /**
-    * @return TranslationString
-    */
+     * @return TranslationString
+     */
     public function metaImage()
     {
         return $this->metaImage();
     }
 
     /**
-    * @param mixed $author
-    * @return MetatagInterface Chainable
-    */
+     * @param mixed $author
+     * @return MetatagInterface Chainable
+     */
     public function setMetaAuthor($author)
     {
         $this->metaAuthor = new TranslationString($author);
@@ -117,16 +117,16 @@ 
     }
 
     /**
-    * @return TranslationString
-    */
+     * @return TranslationString
+     */
     public function metaAuthor()
     {
         return $this->metaAuthor();
     }
 
     /**
-    * @return string
-    */
+     * @return string
+     */
     public function metaTags()
     {
         $tags = '';
@@ -134,9 +134,9 @@ 
     }
 
     /**
-    * @param string $appId The facebook App ID (numeric string)
-    * @return MetatagInterface Chainable
-    */
+     * @param string $appId The facebook App ID (numeric string)
+     * @return MetatagInterface Chainable
+     */
     public function setFacebookAppId($appId)
     {
         $this->facebookAppId = $appId;
@@ -144,17 +144,17 @@ 
     }
 
     /**
-    * @return string
-    */
+     * @return string
+     */
     public function facebookAppId()
     {
         return $this->facebookAppId;
     }
 
     /**
-    * @param mixed $title
-    * @return MetatagInterface Chainable
-    */
+     * @param mixed $title
+     * @return MetatagInterface Chainable
+     */
     public function setOpengraphTitle($title)
     {
         $this->opengraphTitle = new TranslationString($title);
@@ -162,17 +162,17 @@ 
     }
 
     /**
-    * @return TranslationString
-    */
+     * @return TranslationString
+     */
     public function opengraphTitle()
     {
         return $this->opengraphTitle;
     }
 
     /**
-    * @param mixed $siteName
-    * @return MetatagInterface Chainable
-    */
+     * @param mixed $siteName
+     * @return MetatagInterface Chainable
+     */
     public function setOpengraphSiteName($siteName)
     {
         $this->opengraphSiteName = new TranslationString($siteName);
@@ -180,25 +180,25 @@ 
     }
 
     /**
-    * @return TranslationString
-    */
+     * @return TranslationString
+     */
     public function opengraphSiteName()
     {
         return $this->opengraphSiteName;
     }
 
     /**
-    * @param mixed $description
-    * @return MetatagInterface Chainable
-    */
+     * @param mixed $description
+     * @return MetatagInterface Chainable
+     */
     public function setOpengraphDescription($description)
     {
         $this->opengraphDescription = new TranslationString($description);
     }
 
     /**
-    * @return TranslationString
-    */
+     * @return TranslationString
+     */
     public function opengraphDescription()
     {
         return $this->opengraphDescription;
@@ -249,8 +249,8 @@ 
     }
 
     /**
-    * @return string
-    */
+     * @return string
+     */
     public function opengraphTags()
     {
         return '';

src/Charcoal/Cms/MetatagInterface.php

Indentation +44 added lines, -44 removed lines

@@ -8,96 +8,96 @@ 
 interface MetatagInterface
 {
     /**
-    * @return string
-    */
+     * @return string
+     */
     public function canonicalUrl();
 
     /**
-    * @param mixed $title
-    * @return MetatagInterface Chainable
-    */
+     * @param mixed $title
+     * @return MetatagInterface Chainable
+     */
     public function setMetaTitle($title);
 
     /**
-    * @return TranslationString
-    */
+     * @return TranslationString
+     */
     public function metaTitle();
 
     /**
-    * @param mixed $description
-    * @return MetatagInterface Chainable
-    */
+     * @param mixed $description
+     * @return MetatagInterface Chainable
+     */
     public function setMetaDescription($description);
 
     /**
-    * @return TranslationString
-    */
+     * @return TranslationString
+     */
     public function metaDescription();
 
     /**
-    * @param mixed $image
-    * @return MetatageInterface Chainable
-    */
+     * @param mixed $image
+     * @return MetatageInterface Chainable
+     */
     public function setMetaImage($image);
 
     /**
-    * @return TranslationString
-    */
+     * @return TranslationString
+     */
     public function metaImage();
 
     /**
-    * @param mixed $author
-    * @return MetatagInterface Chainable
-    */
+     * @param mixed $author
+     * @return MetatagInterface Chainable
+     */
     public function setMetaAuthor($author);
 
     /**
-    * @return TranslationString
-    */
+     * @return TranslationString
+     */
     public function metaAuthor();
 
     /**
-    * @return string
-    */
+     * @return string
+     */
     public function metaTags();
 
     /**
-    * @param string $appId The facebook App ID (numeric string)
-    * @return MetatagInterface Chainable
-    */
+     * @param string $appId The facebook App ID (numeric string)
+     * @return MetatagInterface Chainable
+     */
     public function setFacebookAppId($appId);
 
     /**
-    * @return string
-    */
+     * @return string
+     */
     public function facebookAppId();
 
     /**
-    * @param mixed $title
-    * @return MetatagInterface Chainable
-    */
+     * @param mixed $title
+     * @return MetatagInterface Chainable
+     */
     public function setOpengraphTitle($title);
 
     /**
-    * @return TranslationString
-    */
+     * @return TranslationString
+     */
     public function opengraphTitle();
 
     /**
-    * @param mixed $siteName
-    * @return MetatagInterface Chainable
-    */
+     * @param mixed $siteName
+     * @return MetatagInterface Chainable
+     */
     public function setOpengraphSiteName($siteName);
 
     /**
-    * @return TranslationString
-    */
+     * @return TranslationString
+     */
     public function opengraphSiteName();
 
     /**
-    * @param mixed $description
-    * @return MetatagInterface Chainable
-    */
+     * @param mixed $description
+     * @return MetatagInterface Chainable
+     */
     public function setOpengraphDescription($description);
     public function opengraphDescription();
     public function setOpengraphType($type);
@@ -110,7 +110,7 @@ 
     public function opengraphPublisher();
 
     /**
-    * @return string
-    */
+     * @return string
+     */
     public function opengraphTags();
 }

src/Charcoal/Cms/FaqCategory.php

Indentation +6 added lines, -6 removed lines

@@ -12,18 +12,18 @@
     use CategoryTrait;
 
     /**
-    * CategoryTrait > item_type()
-    *
-    * @return string
-    */
+     * CategoryTrait > item_type()
+     *
+     * @return string
+     */
     public function item_type()
     {
         return 'charcoal/cms/news';
     }
 
     /**
-    * @return Collection
-    */
+     * @return Collection
+     */
     public function load_items()
     {
         return [];