locomotivemtl / charcoal-cms

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

Doc Comments +6 added lines, -6 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()
     {
@@ -559,7 +559,7 @@ 
     }
 
     /**
-     * @return mixed
+     * @return string
      */
     public function objType()
     {
@@ -567,7 +567,7 @@ 
     }
 
     /**
-     * @return mixed
+     * @return string
      */
     public function featIdent()
     {

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());

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

Doc Comments +5 added lines, -5 removed lines

@@ -135,7 +135,7 @@ 
 
     /**
      * @param integer|null $id The news id.
-     * @return mixed
+     * @return NewsInterface
      */
     public function entry($id = null)
     {
@@ -301,7 +301,7 @@ 
     }
 
     /**
-     * @return mixed The previous news
+     * @return NewsInterface The previous news
      */
     public function prev()
     {
@@ -313,7 +313,7 @@ 
     }
 
     /**
-     * @return mixed The next news
+     * @return NewsInterface The next news
      */
     public function next()
     {
@@ -385,7 +385,7 @@ 
 
     /**
      * Amount of news (total)
-     * @return integer How many news?
+     * @return boolean How many news?
      */
     public function numNews()
     {
@@ -448,7 +448,7 @@ 
     }
 
     /**
-     * @return mixed
+     * @return string
      */
     public function featIdent()
     {

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());

src/Charcoal/Cms/ServiceProvider/CmsServiceProvider.php

Unused Use Statements -2 removed lines

@@ -12,13 +12,11 @@
 use Pimple\ServiceProviderInterface;
 
 // Local dependencies
-use Charcoal\Cms\Config;
 
 // Cms Loaders
 use Charcoal\Cms\Service\Loader\SectionLoader;
 
 // dependencies from `charcoal-core`
-use Charcoal\Model\AbstractModel;
 
 // dependencies from `charcoal-cms`
 use Charcoal\Cms\SectionInterface;

Spacing +9 added lines, -9 removed lines

@@ -51,7 +51,7 @@ 
          * @param Container $container
          * @return CmsConfig Website configurations (from cms.json).
          */
-        $container['cms/config'] = function (Container $container) {
+        $container['cms/config'] = function(Container $container) {
             $appConfig = $container['config'];
             $cms = $appConfig->get('cms');
 
@@ -83,7 +83,7 @@ 
          * @param Container $container Pimple DI Container.
          * @return DateHelper
          */
-        $container['date/helper'] = function (Container $container) {
+        $container['date/helper'] = function(Container $container) {
 
             trigger_error(sprintf(
                 '%s is deprecated, use %s instead',
@@ -102,7 +102,7 @@ 
          * @param Container $container Pimple DI Container.
          * @return DateHelper
          */
-        $container['cms/date/helper'] = function (Container $container) {
+        $container['cms/date/helper'] = function(Container $container) {
 
             return new DateHelper([
                 'date_formats' => $container['cms/config']->get('date_formats'),
@@ -126,7 +126,7 @@ 
          * @param Container $container Pimple DI Container.
          * @return GenericFactory
          */
-        $container['cms/section/factory'] = function (Container $container) {
+        $container['cms/section/factory'] = function(Container $container) {
             return new GenericFactory([
                 'base_class'       => SectionInterface::class,
                 'arguments'        => $container['model/factory']->arguments(),
@@ -140,7 +140,7 @@ 
          * @param Container $container Pimple DI Container.
          * @return SectionLoader
          */
-        $container['cms/section/loader'] = function (Container $container) {
+        $container['cms/section/loader'] = function(Container $container) {
             $sectionLoader = new SectionLoader([
                 'loader'     => $container['model/collection/loader'],
                 'factory'    => $container['model/factory'],
@@ -169,7 +169,7 @@ 
          * @param Container $container Pimple DI Container.
          * @return NewsLoader
          */
-        $container['cms/news/loader'] = function (Container $container) {
+        $container['cms/news/loader'] = function(Container $container) {
             $newsLoader = new NewsLoader([
                 'loader'     => $container['model/collection/loader'],
                 'factory'    => $container['model/factory'],
@@ -190,7 +190,7 @@ 
          * @param Container $container
          * @return NewsManager
          */
-        $container['cms/news/manager'] = function (Container $container) {
+        $container['cms/news/manager'] = function(Container $container) {
 
             $newsManager = new NewsManager([
                 'loader'      => $container['model/collection/loader'],
@@ -215,7 +215,7 @@ 
          * @param Container $container Pimple DI Container.
          * @return EventLoader
          */
-        $container['cms/event/loader'] = function (Container $container) {
+        $container['cms/event/loader'] = function(Container $container) {
             $eventLoader = new EventLoader([
                 'loader'     => $container['model/collection/loader'],
                 'factory'    => $container['model/factory'],
@@ -239,7 +239,7 @@ 
          * @param Container $container
          * @return EventManager
          */
-        $container['cms/event/manager'] = function (Container $container) {
+        $container['cms/event/manager'] = function(Container $container) {
 
             $eventManager = new EventManager([
                 'loader'       => $container['model/collection/loader'],

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

Doc Comments +4 added lines, -4 removed lines

@@ -27,7 +27,7 @@ 
     /**
      * Formatted event list
      * Return the entries for the current page
-     * @return \Generator|void
+     * @return \Generator
      */
     public function eventsList()
     {
@@ -41,7 +41,7 @@ 
     /**
      * Formatted event archive list
      * Returns the entries for the current page.
-     * @return \Generator|void
+     * @return \Generator
      */
     public function eventArchiveList()
     {
@@ -73,7 +73,7 @@ 
     }
 
     /**
-     * @return mixed
+     * @return \Generator
      */
     public function featEvents()
     {
@@ -122,7 +122,7 @@ 
 
     /**
      * Amount of events (total)
-     * @return integer How many events?
+     * @return boolean How many events?
      */
     public function numEvent()
     {

Spacing +10 added lines, -10 removed lines

@@ -232,8 +232,8 @@ 
     protected function eventFormatShort(EventInterface $event)
     {
         return [
-            'title'     => (string)$event->title(),
-            'url'       => (string)$event->url(),
+            'title'     => (string) $event->title(),
+            'url'       => (string) $event->url(),
             'startDate' => $this->getEventStartDateFormat($event),
             'endDate'   => $this->getEventEndDateFormat($event),
             'date'      => $this->getEventDateFormat($event),
@@ -254,7 +254,7 @@ 
             'endDate'   => $this->getEventEndDateFormat($event),
             'date'      => $this->getEventDateFormat($event),
             'time'      => $this->getEventTimeFormat($event),
-            'title'     => (string)$event->title(),
+            'title'     => (string) $event->title(),
             'url'       => $event->url()
         ];
     }
@@ -271,9 +271,9 @@ 
 
         return [
             'id'               => $event->id(),
-            'title'            => (string)$event->title(),
-            'summary'          => (string)$event->summary(),
-            'content'          => (string)$event->content(),
+            'title'            => (string) $event->title(),
+            'summary'          => (string) $event->summary(),
+            'content'          => (string) $event->content(),
             'image'            => $event->image(),
             'startDate'        => $this->getEventStartDateFormat($event),
             'endDate'          => $this->getEventEndDateFormat($event),
@@ -286,9 +286,9 @@ 
             'gallery'          => $gallery,
             'hasGallery'       => !!(count($gallery)),
             'url'              => $event->url(),
-            'metaTitle'        => (string)$event->metaTitle(),
-            'locationName'     => (string)$event->locationName(),
-            'dateNotes'        => (string)$event->dateNotes(),
+            'metaTitle'        => (string) $event->metaTitle(),
+            'locationName'     => (string) $event->locationName(),
+            'dateNotes'        => (string) $event->dateNotes(),
             'category'         => $event->category()
         ];
     }
@@ -301,7 +301,7 @@ 
     {
         return [
             'id'   => $category->id(),
-            'name' => (string)$category->name(),
+            'name' => (string) $category->name(),
         ];
     }
 

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),
             'active'       => ($this->currentNews() && ($this->currentNews()['id'] == $news->id())),
             'category'     => $news->category(),
@@ -210,7 +210,7 @@ 
     {
         return [
             'date'         => $this->getNewsDateFormat($news),
-            'title'        => (string)$news->title(),
+            'title'        => (string) $news->title(),
             'url'          => $news->url(),
             'category'     => $news->category(),
             'categoryName' => $this->newsCategory($news)->name()
@@ -229,9 +229,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),
             'contentBlocks'    => $contentBlocks,
@@ -241,7 +241,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()
         ];
@@ -255,7 +255,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/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()
     {