locomotivemtl / charcoal-cms

src/Charcoal/Cms/AbstractNews.php

Doc Comments +2 added lines, -2 removed lines

@@ -243,7 +243,7 @@ 
     }
 
     /**
-     * @param  string|DateTimeInterface $newsDate The news date.
+     * @param  string $newsDate The news date.
      * @throws InvalidArgumentException If the timestamp is invalid.
      * @return self
      */
@@ -360,7 +360,7 @@ 
     }
 
     /**
-     * @return Translation|string|null
+     * @return null|Translation
      */
     public function defaultMetaDescription()
     {

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/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()
     {

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

@@ -34,7 +34,7 @@ 
     {
         parent::__construct($data);
 
-        if (is_callable([ $this, 'defaultData' ])) {
+        if (is_callable([$this, 'defaultData'])) {
             $this->setData($this->defaultData());
         }
     }
@@ -88,9 +88,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/Service/Loader/EventLoader.php

Doc Comments +3 added lines, -3 removed lines

@@ -85,7 +85,7 @@ 
     }
 
     /**
-     * @param mixed $date The news date to filter
+     * @param DateTime $date The news date to filter
      *                    [startDate, endDate]
      *                    DateTimeInterface
      *                    string.
@@ -101,7 +101,7 @@ 
     }
 
     /**
-     * @param mixed $date The news date to filter
+     * @param DateTime $date The news date to filter
      *                    [startDate, endDate]
      *                    DateTimeInterface
      *                    string.
@@ -121,7 +121,7 @@ 
     // ==========================================================================
 
     /**
-     * @return mixed
+     * @return string
      */
     public function lifespan()
     {

Spacing +3 added lines, -3 removed lines

@@ -54,7 +54,7 @@ 
     {
         $now = new DateTime();
         $loader = $this->all();
-        $loader->addFilter('publish_date', $now->format('Y-m-d H:i:s'), [ 'operator' => '<=' ])
+        $loader->addFilter('publish_date', $now->format('Y-m-d H:i:s'), ['operator' => '<='])
             ->addOrder('start_date', 'asc');
 
         return $loader;
@@ -95,7 +95,7 @@ 
     {
         $date = $this->parseAsDate($date);
         $loader = $this->published();
-        $loader->addFilter('end_date', $date->format('Y-m-d H:i:s'), [ 'operator' => '>=' ]);
+        $loader->addFilter('end_date', $date->format('Y-m-d H:i:s'), ['operator' => '>=']);
 
         return $loader;
     }
@@ -111,7 +111,7 @@ 
     {
         $date = $this->parseAsDate($date);
         $loader = $this->published();
-        $loader->addFilter('end_date', $date->format('Y-m-d H:i:s'), [ 'operator' => '<' ]);
+        $loader->addFilter('end_date', $date->format('Y-m-d H:i:s'), ['operator' => '<']);
 
         return $loader;
     }

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

Doc Comments +1 added lines, -1 removed lines

@@ -213,7 +213,7 @@
     // ==========================================================================
 
     /**
-     * @return object
+     * @return string
      */
     public function objType()
     {

Spacing +1 added lines, -1 removed lines

@@ -73,7 +73,7 @@
         $loader = $this->all();
         $operator = [];
         if (!$this->baseSection()) {
-            $operator = [ 'operator' => 'IS NULL' ];
+            $operator = ['operator' => 'IS NULL'];
         }
         $loader->addFilter('master', $this->baseSection(), $operator);
 

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(),
         ];
     }