locomotivemtl / charcoal-cms

src/Charcoal/Cms/Support/Traits/NewsManagerAwareTrait.php

Doc Comments +3 added lines, -3 removed lines

@@ -32,7 +32,7 @@ 
     /**
      * Formatted news list
      * Returns the entries for the current page.
-     * @return \Generator|void
+     * @return \Generator
      */
     public function newsList()
     {
@@ -45,7 +45,7 @@ 
     /**
      * Formatted news archive list
      * Returns the entries for the current page.
-     * @return \Generator|void
+     * @return \Generator
      */
     public function newsArchiveList()
     {
@@ -124,7 +124,7 @@ 
 
     /**
      * Amount of news (total)
-     * @return integer How many news?
+     * @return boolean How many news?
      */
     public function numNews()
     {

Spacing +8 added lines, -8 removed lines

@@ -192,8 +192,8 @@ 
     protected function newsFormatShort(NewsInterface $news)
     {
         return [
-            'title'        => (string)$news->title(),
-            'url'          => (string)$news->url(),
+            'title'        => (string) $news->title(),
+            'url'          => (string) $news->url(),
             'date'         => $this->getNewsDateFormat($news),
             'dateTime'     => $news->newsDate()->format('Y-m-d h:i'),
             'active'       => ($this->currentNews() && ($this->currentNews()['id'] == $news->id())),
@@ -212,7 +212,7 @@ 
         return [
             'date'         => $this->getNewsDateFormat($news),
             'dateTime'     => $news->newsDate()->format('Y-m-d h:i'),
-            'title'        => (string)$news->title(),
+            'title'        => (string) $news->title(),
             'url'          => $news->url(),
             'category'     => $news->category(),
             'categoryName' => $this->newsCategory($news)->name()
@@ -231,9 +231,9 @@ 
 
         return [
             'id'               => $news->id(),
-            'title'            => (string)$news->title(),
-            'summary'          => (string)$news->summary(),
-            'content'          => (string)$news->content(),
+            'title'            => (string) $news->title(),
+            'summary'          => (string) $news->summary(),
+            'content'          => (string) $news->content(),
             'image'            => $news->image(),
             'date'             => $this->getNewsDateFormat($news),
             'dateTime'         => $news->newsDate()->format('Y-m-d h:i'),
@@ -244,7 +244,7 @@ 
             'gallery'          => $gallery,
             'hasGallery'       => !!(count($gallery)),
             'url'              => $news->url(),
-            'metaTitle'        => (string)$news->metaTitle(),
+            'metaTitle'        => (string) $news->metaTitle(),
             'category'         => $news->category(),
             'categoryName'     => $this->newsCategory($news)->name()
         ];
@@ -258,7 +258,7 @@ 
     {
         return [
             'id'   => $category->id(),
-            'name' => (string)$category->name(),
+            'name' => (string) $category->name(),
         ];
     }
 

src/Charcoal/Cms/Support/Traits/SectionLoaderAwareTrait.php

Doc Comments +1 added lines, -1 removed lines

@@ -71,7 +71,7 @@
 
     /**
      * Gets latest route for the given slug.
-     * @return string The latest url.
+     * @return \Closure The latest url.
      */
     public function routes()
     {

Spacing +5 added lines, -5 removed lines

@@ -75,7 +75,7 @@ 
      */
     public function routes()
     {
-        return function ($arg) {
+        return function($arg) {
             return $this->sectionLoader()->resolveRoute($arg);
         };
     }
@@ -177,10 +177,10 @@ 
         $documents = $section->attachments('document');
 
         return [
-            'title'         => (string)$section->title(),
-            'summary'       => (string)$section->summary(),
-            'image'         => (string)$section->image(),
-            'content'       => (string)$section->content(),
+            'title'         => (string) $section->title(),
+            'summary'       => (string) $section->summary(),
+            'image'         => (string) $section->image(),
+            'content'       => (string) $section->content(),
             'contentBlocks' => $contentBlocks,
             'gallery'       => $gallery,
             'documents'     => $documents

src/Charcoal/Cms/Service/Loader/NewsLoader.php

Spacing +4 added lines, -4 removed lines

@@ -47,8 +47,8 @@ 
     {
         $now = new DateTime();
         $loader = $this->all();
-        $loader->addFilter('publish_date', $now->format('Y-m-d H:i:s'), [ 'operator' => '<=' ])
-            ->addFilter('expiry_date', $now->format('Y-m-d H:i:s'), [ 'operator' => '>=' ]);
+        $loader->addFilter('publish_date', $now->format('Y-m-d H:i:s'), ['operator' => '<='])
+            ->addFilter('expiry_date', $now->format('Y-m-d H:i:s'), ['operator' => '>=']);
 
         return $loader;
     }
@@ -60,8 +60,8 @@ 
     {
         $now = new DateTime();
         $loader = $this->all();
-        $loader->addFilter('publish_date', $now->format('Y-m-d H:i:s'), [ 'operator' => '<=' ])
-            ->addFilter('expiry_date', $now->format('Y-m-d H:i:s'), [ 'operator' => '<=' ]);
+        $loader->addFilter('publish_date', $now->format('Y-m-d H:i:s'), ['operator' => '<='])
+            ->addFilter('expiry_date', $now->format('Y-m-d H:i:s'), ['operator' => '<=']);
 
         return $loader;
     }

Doc Comments +1 added lines, -1 removed lines

@@ -98,7 +98,7 @@
     // ==========================================================================
 
     /**
-     * @return mixed
+     * @return string
      */
     public function median()
     {

src/Charcoal/Cms/Service/Manager/EventManager.php

Spacing +4 added lines, -4 removed lines

@@ -216,7 +216,7 @@ 
         }
 
         if ($this->category()) {
-            $loader->addFilter('category', $this->category(), [ 'operator' => 'in' ]);
+            $loader->addFilter('category', $this->category(), ['operator' => 'in']);
         }
 
         if ($this->numPerPage()) {
@@ -321,8 +321,8 @@ 
 
         $ids = explode(',', $ids);
 
-        $loader->addFilter('id', $ids, [ 'operator' => 'in' ])
-            ->addOrder('id', 'values', [ 'values' => $ids ]);
+        $loader->addFilter('id', $ids, ['operator' => 'in'])
+            ->addOrder('id', 'values', ['values' => $ids]);
 
         if (count($options) > 0) {
             foreach ($options as $key => $option) {
@@ -369,7 +369,7 @@ 
         $loader = $this->loader()->archive();
 
         if ($this->category()) {
-            $loader->addFilter('category', $this->category(), [ 'operator' => 'in' ]);
+            $loader->addFilter('category', $this->category(), ['operator' => 'in']);
         }
         if ($this->numPerPage()) {
             $loader->setPage($this->page());

Doc Comments +5 added lines, -5 removed lines

@@ -230,7 +230,7 @@ 
 
     /**
      * @param integer|null $id The event id.
-     * @return mixed
+     * @return EventInterface
      */
     public function entry($id = null)
     {
@@ -398,7 +398,7 @@ 
     }
 
     /**
-     * @return mixed The previous event
+     * @return EventInterface The previous event
      */
     public function prev()
     {
@@ -410,7 +410,7 @@ 
     }
 
     /**
-     * @return mixed The next event
+     * @return EventInterface The next event
      */
     public function next()
     {
@@ -504,7 +504,7 @@ 
 
     /**
      * Amount of event (total)
-     * @return integer How many event?
+     * @return boolean How many event?
      */
     public function numEvent()
     {
@@ -567,7 +567,7 @@ 
     }
 
     /**
-     * @return mixed
+     * @return string
      */
     public function featIdent()
     {

src/Charcoal/Cms/Service/Manager/NewsManager.php

Spacing +4 added lines, -4 removed lines

@@ -122,7 +122,7 @@ 
         $loader->addOrder('news_date', 'desc');
 
         if ($this->category()) {
-            $loader->addFilter('category', $this->category(), [ 'operator' => 'in' ]);
+            $loader->addFilter('category', $this->category(), ['operator' => 'in']);
         }
         if ($this->numPerPage()) {
             $loader->setPage($this->page());
@@ -223,8 +223,8 @@ 
 
         $ids = explode(',', $ids);
 
-        $loader->addFilter('id', $ids, [ 'operator' => 'in' ])
-            ->addOrder('id', 'values', [ 'values' => $ids ]);
+        $loader->addFilter('id', $ids, ['operator' => 'in'])
+            ->addOrder('id', 'values', ['values' => $ids]);
 
         if (count($options) > 0) {
             foreach ($options as $key => $option) {
@@ -272,7 +272,7 @@ 
         $loader->addOrder('news_date', 'desc');
 
         if ($this->category()) {
-            $loader->addFilter('category', $this->category(), [ 'operator' => 'in' ]);
+            $loader->addFilter('category', $this->category(), ['operator' => 'in']);
         }
         if ($this->numPerPage()) {
             $loader->setPage($this->page());

Doc Comments +6 added lines, -6 removed lines

@@ -149,7 +149,7 @@ 
 
     /**
      * @param integer|null $id The news id.
-     * @return mixed
+     * @return NewsInterface
      */
     public function entry($id = null)
     {
@@ -316,7 +316,7 @@ 
     }
 
     /**
-     * @return mixed The previous news
+     * @return NewsInterface The previous news
      */
     public function prev()
     {
@@ -328,7 +328,7 @@ 
     }
 
     /**
-     * @return mixed The next news
+     * @return NewsInterface The next news
      */
     public function next()
     {
@@ -400,7 +400,7 @@ 
 
     /**
      * Amount of news (total)
-     * @return integer How many news?
+     * @return boolean How many news?
      */
     public function numNews()
     {
@@ -442,7 +442,7 @@ 
     }
 
     /**
-     * @return mixed
+     * @return string
      */
     public function objType()
     {
@@ -450,7 +450,7 @@ 
     }
 
     /**
-     * @return mixed
+     * @return string
      */
     public function featIdent()
     {

src/Charcoal/Cms/AbstractEvent.php

Doc Comments +3 added lines, -3 removed lines

@@ -230,7 +230,7 @@ 
     }
 
     /**
-     * @param  string|DateTimeInterface $startDate Event starting date.
+     * @param  string $startDate Event starting date.
      * @throws InvalidArgumentException If the timestamp is invalid.
      * @return self
      */
@@ -263,7 +263,7 @@ 
     }
 
     /**
-     * @param  string|DateTimeInterface $endDate Event end date.
+     * @param  null|DateTimeInterface $endDate Event end date.
      * @throws InvalidArgumentException If the timestamp is invalid.
      * @return self
      */
@@ -319,7 +319,7 @@ 
     }
 
     /**
-     * @return Translation|string|null
+     * @return null|Translation
      */
     public function defaultMetaDescription()
     {

Unused Use Statements -3 removed lines

@@ -7,8 +7,6 @@ 
 use InvalidArgumentException;
 
 // From PSR-7
-use Psr\Http\Message\RequestInterface;
-use Psr\Http\Message\ResponseInterface;
 
 // From 'charcoal-object'
 use Charcoal\Object\Content;
@@ -26,7 +24,6 @@ 
 use Charcoal\Cms\MetatagInterface;
 use Charcoal\Cms\SearchableInterface;
 use Charcoal\Cms\TemplateableInterface;
-
 use Charcoal\Cms\MetatagTrait;
 use Charcoal\Cms\SearchableTrait;
 use Charcoal\Cms\TemplateableTrait;

Spacing +1 added lines, -1 removed lines

@@ -31,7 +31,7 @@
     {
         parent::__construct($data);
 
-        if (is_callable([ $this, 'defaultData' ])) {
+        if (is_callable([$this, 'defaultData'])) {
             $this->setData($this->defaultData());
         }
     }

src/Charcoal/Cms/Config/NewsConfig.php

Doc Comments +1 added lines, -1 removed lines

@@ -59,7 +59,7 @@
     }
 
     /**
-     * @return boolean Entry cycle.
+     * @return string Entry cycle.
      */
     public function entryCycle()
     {

src/Charcoal/Cms/Support/Helpers/DateHelper.php

Doc Comments +1 added lines, -1 removed lines

@@ -263,7 +263,7 @@
     }
 
     /**
-     * @param mixed $format DateTime to be formatted.
+     * @param string $format DateTime to be formatted.
      * @return mixed
      */
     private function crossPlatformFormat($format)

Spacing +6 added lines, -6 removed lines

@@ -199,18 +199,18 @@ 
                            ? $this->translator()->translation($case['formats']['to'])
                            : null;
 
-        $formats['from'] = $this->crossPlatformFormat((string)$formats['from']);
-        $formats['to']   = $this->crossPlatformFormat((string)$formats['to']);
+        $formats['from'] = $this->crossPlatformFormat((string) $formats['from']);
+        $formats['to']   = $this->crossPlatformFormat((string) $formats['to']);
 
         if (!$this->to || !$formats['to']) {
             return sprintf(
-                (string)$content,
+                (string) $content,
                 strftime($formats['from'], $this->from->getTimestamp())
             );
         }
 
         return sprintf(
-            (string)$content,
+            (string) $content,
             strftime($formats['from'], $this->from->getTimestamp()),
             strftime($formats['to'], $this->to->getTimestamp())
         );
@@ -235,13 +235,13 @@ 
 
         if (!$this->to || !$formats['to']) {
             return sprintf(
-                (string)$content,
+                (string) $content,
                 strftime($formats['from'], $this->from->getTimestamp())
             );
         }
 
         return sprintf(
-            (string)$content,
+            (string) $content,
             strftime($formats['from'], $this->from->getTimestamp()),
             strftime($formats['to'], $this->to->getTimestamp())
         );

src/Charcoal/Property/TemplateProperty.php

Unused Use Statements -2 removed lines

@@ -3,8 +3,6 @@
 namespace Charcoal\Property;
 
 use PDO;
-
-use RuntimeException;
 use InvalidArgumentException;
 
 // From Pimple

Spacing +3 added lines, -3 removed lines

@@ -99,7 +99,7 @@ 
                 }
 
                 $struct    = $this->availableTemplates[$choiceIdent];
-                $immutable = [ 'value' => $struct['value'] ];
+                $immutable = ['value' => $struct['value']];
 
                 return array_replace($struct, $choice, $immutable);
             } elseif (isset($choice['template']) || isset($choice['controller']) || isset($choice['class'])) {
@@ -139,7 +139,7 @@ 
                 return '';
             }
         } elseif ($val instanceof Translation) {
-            $propertyValue = (string)$val;
+            $propertyValue = (string) $val;
         } else {
             $propertyValue = $val;
         }
@@ -187,7 +187,7 @@ 
         $val = $this->val();
         if ($this->hasChoice($val)) {
             $choice = $this->choice($val);
-            $keys   = [ 'controller', 'template', 'class' ];
+            $keys   = ['controller', 'template', 'class'];
             foreach ($keys as $key) {
                 if (isset($choice[$key])) {
                     return $choice[$key];