locomotivemtl / charcoal-cms

src/Charcoal/Admin/Widget/Cms/SectionTableTrait.php

Unused Use Statements -1 removed lines

@@ -2,7 +2,6 @@
 
 namespace Charcoal\Admin\Widget\Cms;
 
-use Exception;
 use RuntimeException;
 
 // From 'charcoal-core'

Spacing +3 added lines, -3 removed lines

@@ -96,7 +96,7 @@ 
 
                 switch ($sectionType) {
                     case AbstractSection::TYPE_EXTERNAL:
-                        $externalUrl = (string)$object->externalUrl();
+                        $externalUrl = (string) $object->externalUrl();
                         $linkExcerpt = '';
                         $tagTemplate = '<span class="fa fa-link" data-toggle="tooltip" '.
                             'data-placement="auto" title="%1$s"></span>';
@@ -123,7 +123,7 @@ 
         }
 
         if ($propertyIdent === 'title') {
-            if (is_callable([ $object, 'navMenu' ]) && $object->navMenu()) {
+            if (is_callable([$object, 'navMenu']) && $object->navMenu()) {
                 $propertyValue .= sprintf(
                     ' &nbsp; '.
                     '<span class="fa fa-list" data-toggle="tooltip" '.
@@ -135,7 +135,7 @@ 
                 );
             }
 
-            if (is_callable([ $object, 'locked' ]) && $object->locked()) {
+            if (is_callable([$object, 'locked']) && $object->locked()) {
                 $propertyValue .= sprintf(
                     ' &nbsp; '.
                     '<span class="fa fa-lock" data-toggle="tooltip" '.

src/Charcoal/Cms/AbstractSection.php

Doc Comments +2 added lines, -2 removed lines

@@ -363,7 +363,7 @@ 
     /**
      * Retrieve the menus this object belongs to.
      *
-     * @return Translation|string|null
+     * @return string[]
      */
     public function inMenu()
     {
@@ -430,7 +430,7 @@ 
     }
 
     /**
-     * @return Translation|string|null
+     * @return null|Translation
      */
     public function defaultMetaDescription()
     {

Unused Use Statements -1 removed lines

@@ -5,7 +5,6 @@
 use InvalidArgumentException;
 
 // From 'charcoal-core'
-use Charcoal\Model\Collection;
 use Charcoal\Loader\CollectionLoader;
 
 // From 'charcoal-object'

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.php

Doc Comments +4 added lines, -4 removed lines

@@ -83,7 +83,7 @@ 
     // ==========================================================================
 
     /**
-     * @return mixed
+     * @return string
      */
     public function defaultMetaTitle()
     {
@@ -91,7 +91,7 @@ 
     }
 
     /**
-     * @return mixed
+     * @return string
      */
     public function defaultMetaDescription()
     {
@@ -99,7 +99,7 @@ 
     }
 
     /**
-     * @return mixed
+     * @return string
      */
     public function defaultMetaImage()
     {
@@ -107,7 +107,7 @@ 
     }
 
     /**
-     * @return mixed
+     * @return string
      */
     public function defaultMetaUrl()
     {

src/Charcoal/Cms/Config/CmsConfig.php

Doc Comments +1 added lines, -1 removed lines

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

src/Charcoal/Cms/Config/EventConfig.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/NewsCategory.php

Doc Comments +1 added lines, -1 removed lines

@@ -55,7 +55,7 @@
     }
 
     /**
-     * @return mixed
+     * @return string[]
      */
     public function name()
     {

Spacing +3 added lines, -3 removed lines

@@ -31,7 +31,7 @@ 
     {
         parent::__construct($data);
 
-        if (is_callable([ $this, 'defaultData' ])) {
+        if (is_callable([$this, 'defaultData'])) {
             $this->setData($this->defaultData());
         }
     }
@@ -82,9 +82,9 @@ 
         parent::validate($v);
 
         foreach ($this->translator()->locales() as $locale => $value) {
-            if (!(string)$this['name'][$locale]) {
+            if (!(string) $this['name'][$locale]) {
                 $this->validator()->error(
-                    (string)$this->translator()->translation([
+                    (string) $this->translator()->translation([
                         'fr' => 'Le NOM doit être rempli dans toutes les langues.',
                         'en' => 'The NAME must be filled in all languages.',
                     ])

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

@@ -228,8 +228,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),
             'startDateTime' => $event->startDate()->format('Y-m-d h:i'),
             'endDate'       => $this->getEventEndDateFormat($event),
@@ -254,7 +254,7 @@ 
             'endDateTime'   => $event->endDate()->format('Y-m-d h:i'),
             '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),
             'startDateTime'    => $event->startDate()->format('Y-m-d h:i'),
@@ -288,9 +288,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()
         ];
     }
@@ -303,7 +303,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),
             '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/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()
     {