locomotivemtl / charcoal-cms

src/Charcoal/Cms/AbstractBlock.php

Doc Comments +1 added lines, -1 removed lines

@@ -134,7 +134,7 @@
     }
 
     /**
-    * @param mixed $subbtitle
+    * @param mixed $subtitle
     * @return Section Chainable
     */
     public function set_subtitle($subtitle)

Indentation +42 added lines, -42 removed lines

@@ -17,39 +17,39 @@ 
     const DEFAULT_TYPE = self::TYPE_CONTENT;
 
     /**
-    * @var string $parent_type
-    */
+     * @var string $parent_type
+     */
     private $parent_type;
 
     /**
-    * @var mixed $parent_id
-    */
+     * @var mixed $parent_id
+     */
     private $parent_id;
 
     /**
-    * @var string $block_type
-    */
+     * @var string $block_type
+     */
     private $block_type = self::DEFAULT_TYPE;
 
     /**
-    * @var TranslationString $title
-    */
+     * @var TranslationString $title
+     */
     private $title;
 
     /**
-    * @var TranslationString $subtitle
-    */
+     * @var TranslationString $subtitle
+     */
     private $subtitle;
 
     /**
-    * @var TranslationString $content
-    */
+     * @var TranslationString $content
+     */
     private $content;
 
     /**
-    * @param string $type
-    * @return BlockInterface Chainable
-    */
+     * @param string $type
+     * @return BlockInterface Chainable
+     */
     public function set_parent_type($type)
     {
         if (!is_string($type)) {
@@ -62,17 +62,17 @@ 
     }
 
     /**
-    * @return string
-    */
+     * @return string
+     */
     public function parent_type()
     {
         return $this->parent_type;
     }
 
     /**
-    * @param mixed $id
-    * @return BlockInterface Chainable
-    */
+     * @param mixed $id
+     * @return BlockInterface Chainable
+     */
     public function set_parent_id($id)
     {
         if (!is_scalar($id)) {
@@ -85,17 +85,17 @@ 
     }
 
     /**
-    * @return mixed
-    */
+     * @return mixed
+     */
     public function parent_id()
     {
         return $this->parent_id;
     }
 
     /**
-    * @param string $type
-    * @return Chainable
-    */
+     * @param string $type
+     * @return Chainable
+     */
     public function set_block_type($type)
     {
         if (!is_string($type)) {
@@ -108,17 +108,17 @@ 
     }
 
     /**
-    * @return string
-    */
+     * @return string
+     */
     public function block_type()
     {
         return $this->block_type;
     }
 
     /**
-    * @param mixed $title
-    * @return TranslationString
-    */
+     * @param mixed $title
+     * @return TranslationString
+     */
     public function set_title($title)
     {
         $this->title = new TranslationString($title);
@@ -126,17 +126,17 @@ 
     }
 
     /**
-    * @return TranslationString
-    */
+     * @return TranslationString
+     */
     public function title()
     {
         return $this->title;
     }
 
     /**
-    * @param mixed $subbtitle
-    * @return Section Chainable
-    */
+     * @param mixed $subbtitle
+     * @return Section Chainable
+     */
     public function set_subtitle($subtitle)
     {
         $this->subtitle = new TranslationString($subtitle);
@@ -144,17 +144,17 @@ 
     }
 
     /**
-    * @return TranslationString
-    */
+     * @return TranslationString
+     */
     public function subtitle()
     {
         return $this->subtitle;
     }
 
     /**
-    * @param mixed $content
-    * @return Section Chainable
-    */
+     * @param mixed $content
+     * @return Section Chainable
+     */
     public function set_content($content)
     {
         $this->content = new TranslationString($content);
@@ -162,8 +162,8 @@ 
     }
 
     /**
-    * @return TranslationString
-    */
+     * @return TranslationString
+     */
     public function content()
     {
         return $this->content;

src/Charcoal/Cms/AbstractSection.php

Doc Comments +3 added lines, -3 removed lines

@@ -120,7 +120,7 @@ 
 
     /**
     * @param mixed $title
-    * @return TranslationString
+    * @return AbstractSection
     */
     public function set_title($title)
     {
@@ -137,8 +137,8 @@ 
     }
 
     /**
-    * @param mixed $subbtitle
-    * @return Section Chainable
+    * @param mixed $subtitle
+    * @return AbstractSection Chainable
     */
     public function set_subtitle($subtitle)
     {

Indentation +47 added lines, -47 removed lines

@@ -60,38 +60,38 @@ 
     const DEFAULT_TYPE = self::TYPE_CONTENT;
 
     /**
-    * @var string $section_type
-    */
+     * @var string $section_type
+     */
     private $section_type = self::DEFAULT_TYPE;
 
     /**
-    * @var TranslationString $title
-    */
+     * @var TranslationString $title
+     */
     private $title;
     /**
-    * @var TranslationString $subtitle
-    */
+     * @var TranslationString $subtitle
+     */
     private $subtitle;
     /**
-    * @var TranslationString $content
-    */
+     * @var TranslationString $content
+     */
     private $content;
 
     /**
-    * @var mixed $template
-    */
+     * @var mixed $template
+     */
     private $template;
     /**
-    * @var array $template_options
-    */
+     * @var array $template_options
+     */
     private $template_options = [];
 
 
     /**
-    * @param string $section_type
-    * @throws InvalidArgumentException If the section type is not a string or not a valid section type.
-    * @return SectionInterface Chainable
-    */
+     * @param string $section_type
+     * @throws InvalidArgumentException If the section type is not a string or not a valid section type.
+     * @return SectionInterface Chainable
+     */
     public function set_section_type($section_type)
     {
         if (!is_string($section_type)) {
@@ -111,17 +111,17 @@ 
     }
 
     /**
-    * @return string
-    */
+     * @return string
+     */
     public function section_type()
     {
         return $this->section_type;
     }
 
     /**
-    * @param mixed $title
-    * @return TranslationString
-    */
+     * @param mixed $title
+     * @return TranslationString
+     */
     public function set_title($title)
     {
         $this->title = new TranslationString($title);
@@ -129,17 +129,17 @@ 
     }
 
     /**
-    * @return TranslationString
-    */
+     * @return TranslationString
+     */
     public function title()
     {
         return $this->title;
     }
 
     /**
-    * @param mixed $subbtitle
-    * @return Section Chainable
-    */
+     * @param mixed $subbtitle
+     * @return Section Chainable
+     */
     public function set_subtitle($subtitle)
     {
         $this->subtitle = new TranslationString($subtitle);
@@ -147,17 +147,17 @@ 
     }
 
     /**
-    * @return TranslationString
-    */
+     * @return TranslationString
+     */
     public function subtitle()
     {
         return $this->subtitle;
     }
 
     /**
-    * @param mixed $template
-    * @return SectionInterface Chainable
-    */
+     * @param mixed $template
+     * @return SectionInterface Chainable
+     */
     public function set_template($template)
     {
         $this->template = $template;
@@ -165,17 +165,17 @@ 
     }
 
     /**
-    * @return mixed
-    */
+     * @return mixed
+     */
     public function template()
     {
         return $this->template;
     }
 
     /**
-    * @param array $template_options
-    * @return SectionInterface Chainable
-    */
+     * @param array $template_options
+     * @return SectionInterface Chainable
+     */
     public function set_template_options(array $template_options)
     {
         $this->template_options = $template_options;
@@ -183,18 +183,18 @@ 
     }
 
     /**
-    * @return array
-    */
+     * @return array
+     */
     public function template_options()
     {
         return $this->template_options;
     }
 
     /**
-    * HierarchicalTrait > load_children
-    *
-    * @return array
-    */
+     * HierarchicalTrait > load_children
+     *
+     * @return array
+     */
     public function load_children()
     {
         $source = clone($this->source());
@@ -220,11 +220,11 @@ 
     }
 
     /**
-    * MetatagTrait > canonical_url
-    *
-    * @return string
-    * @todo
-    */
+     * MetatagTrait > canonical_url
+     *
+     * @return string
+     * @todo
+     */
     public function canonical_url()
     {
         return '';

src/Charcoal/Cms/Event.php

Doc Comments +4 added lines, -4 removed lines

@@ -89,7 +89,7 @@ 
 
     /**
     * @param mixed $title
-    * @return TranslationString
+    * @return Event
     */
     public function set_title($title)
     {
@@ -106,7 +106,7 @@ 
     }
 
     /**
-    * @param mixed $subbtitle
+    * @param mixed $subtitle
     * @return Event Chainable
     */
     public function set_subtitle($subtitle)
@@ -189,7 +189,7 @@ 
     }
 
     /**
-    * @return DateTime|null
+    * @return DateTime
     */
     public function start_date()
     {
@@ -225,7 +225,7 @@ 
     }
 
     /**
-    * @return DateTime|null
+    * @return DateTime
     */
     public function end_date()
     {

Indentation +56 added lines, -56 removed lines

@@ -35,62 +35,62 @@ 
     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 Collection $blocks
-    */
+     * @var Collection $blocks
+     */
     private $blocks;
 
     /**
-    * @var DateTime $start_date
-    */
+     * @var DateTime $start_date
+     */
     private $start_date;
     /**
-    * @var DateTime $start_date
-    */
+     * @var DateTime $start_date
+     */
     private $end_date;
 
     /**
-    * @var TranslationString $thumbnail
-    */
+     * @var TranslationString $thumbnail
+     */
     private $thumbnail;
     /**
-    * @var TranslationString $image
-    */
+     * @var TranslationString $image
+     */
     private $image;
 
     /**
-    * @var Collection $documents
-    */
+     * @var Collection $documents
+     */
     private $documents;
 
     /**
-    * CategorizableTrait > category_type()
-    *
-    * @return string
-    */
+     * CategorizableTrait > category_type()
+     *
+     * @return string
+     */
     public function category_type()
     {
         return 'charcoal/cms/event-category';
     }
 
     /**
-    * @param mixed $title
-    * @return TranslationString
-    */
+     * @param mixed $title
+     * @return TranslationString
+     */
     public function set_title($title)
     {
         $this->title = new TranslationString($title);
@@ -98,17 +98,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 set_subtitle($subtitle)
     {
         $this->subtitle = new TranslationString($subtitle);
@@ -116,17 +116,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 set_content($content)
     {
         $this->content = new TranslationString($content);
@@ -134,16 +134,16 @@ 
     }
 
     /**
-    * @return TranslationString
-    */
+     * @return TranslationString
+     */
     public function content()
     {
         return $this->content;
     }
 
     /**
-    * @return Collection
-    */
+     * @return Collection
+     */
     public function blocks()
     {
         if ($this->blocks === null) {
@@ -153,17 +153,17 @@ 
     }
 
     /**
-    * @return Collection
-    */
+     * @return Collection
+     */
     public function load_blocks()
     {
         // @todo
     }
 
     /**
-    * @param string|DateTime $start_date
-    * @throws InvalidArgumentException
-    */
+     * @param string|DateTime $start_date
+     * @throws InvalidArgumentException
+     */
     public function set_start_date($start_date)
     {
         if ($start_date === null) {
@@ -189,17 +189,17 @@ 
     }
 
     /**
-    * @return DateTime|null
-    */
+     * @return DateTime|null
+     */
     public function start_date()
     {
         return $this->start_date;
     }
 
     /**
-    * @param string|DateTime $end_date
-    * @throws InvalidArgumentException
-    */
+     * @param string|DateTime $end_date
+     * @throws InvalidArgumentException
+     */
     public function set_end_date($end_date)
     {
         if ($end_date === null) {
@@ -225,19 +225,19 @@ 
     }
 
     /**
-    * @return DateTime|null
-    */
+     * @return DateTime|null
+     */
     public function end_date()
     {
         return $this->end_date;
     }
 
     /**
-    * MetatagTrait > canonical_url
-    *
-    * @return string
-    * @todo
-    */
+     * MetatagTrait > canonical_url
+     *
+     * @return string
+     * @todo
+     */
     public function canonical_url()
     {
         return '';

src/Charcoal/Cms/Faq.php

Doc Comments +2 added lines, -2 removed lines

@@ -51,7 +51,7 @@ 
     }
 
     /**
-    * @return TranslationString|null
+    * @return TranslationString
     */
     public function question()
     {
@@ -69,7 +69,7 @@ 
     }
 
     /**
-    * @return TranslationString|null
+    * @return TranslationString
     */
     public function answer()
     {

Indentation +19 added lines, -19 removed lines

@@ -30,20 +30,20 @@ 
     use SearchableTrait;
 
     /**
-    * The question, or "title", of this entry
-    * @var TranslationString $question
-    */
+     * The question, or "title", of this entry
+     * @var TranslationString $question
+     */
     private $question;
 
     /**
-    * @var TranslationString $answer
-    */
+     * @var TranslationString $answer
+     */
     private $answer;
 
     /**
-    * @param mixed $question
-    * @return Faq Chainable
-    */
+     * @param mixed $question
+     * @return Faq Chainable
+     */
     public function set_question($question)
     {
         $this->question = new TranslationString($question);
@@ -51,17 +51,17 @@ 
     }
 
     /**
-    * @return TranslationString|null
-    */
+     * @return TranslationString|null
+     */
     public function question()
     {
         return $this->question;
     }
 
     /**
-    * @param mixed answer
-    * @return Faq Chainable
-    */
+     * @param mixed answer
+     * @return Faq Chainable
+     */
     public function set_answer($answer)
     {
         $this->answer = new TranslationString($answer);
@@ -69,18 +69,18 @@ 
     }
 
     /**
-    * @return TranslationString|null
-    */
+     * @return TranslationString|null
+     */
     public function answer()
     {
         return $this->answer;
     }
 
     /**
-    * CategorizableTrait > category_type()
-    *
-    * @return string
-    */
+     * CategorizableTrait > category_type()
+     *
+     * @return string
+     */
     public function category_type()
     {
         return 'charcoal/cms/faq-category';

src/Charcoal/Cms/SearchableInterface.php

Doc Comments +2 added lines, -2 removed lines

@@ -14,7 +14,7 @@ 
     public function set_searchable_data(array $data);
 
     /**
-    * @param array $_search_properties
+    * @param array $properties
     * @return SearchableInterface Chainable
     */
     public function set_search_properties(array $properties);
@@ -31,7 +31,7 @@ 
     public function set_search_keywords($keywords);
 
     /**
-    * @return TranslationString
+    * @return \Charcoal\Translation\TranslationString
     */
     public function search_keywords();
 }

Indentation +13 added lines, -13 removed lines

@@ -8,30 +8,30 @@
 interface SearchableInterface
 {
     /**
-    * @param array $data
-    * @return SearchableInterface Chainable
-    */
+     * @param array $data
+     * @return SearchableInterface Chainable
+     */
     public function set_searchable_data(array $data);
 
     /**
-    * @param array $_search_properties
-    * @return SearchableInterface Chainable
-    */
+     * @param array $_search_properties
+     * @return SearchableInterface Chainable
+     */
     public function set_search_properties(array $properties);
 
     /**
-    * @return array
-    */
+     * @return array
+     */
     public function search_properties();
 
     /**
-    * @param mixed $keywords
-    * @return SearchableInterface Chainable
-    */
+     * @param mixed $keywords
+     * @return SearchableInterface Chainable
+     */
     public function set_search_keywords($keywords);
 
     /**
-    * @return TranslationString
-    */
+     * @return TranslationString
+     */
     public function search_keywords();
 }

src/Charcoal/Cms/SearchableTrait.php

Doc Comments +3 added lines, -3 removed lines

@@ -34,8 +34,8 @@ 
     }
 
     /**
-    * @param array $search_properties
-    * @return SearchableInterface Chainable
+    * @param array $properties
+    * @return SearchableTrait Chainable
     */
     public function set_search_properties(array $properties)
     {
@@ -53,7 +53,7 @@ 
 
     /**
     * @param mixed $keywords
-    * @return SearchableInterface Chainable
+    * @return SearchableTrait Chainable
     */
     public function set_search_keywords($keywords)
     {

Indentation +16 added lines, -16 removed lines

@@ -10,18 +10,18 @@ 
 trait SearchableTrait
 {
     /**
-    * @var array $search_properties
-    */
+     * @var array $search_properties
+     */
     private $search_properties = [];
 
     /**
-    * @var TranslationString $search_keywords
-    */
+     * @var TranslationString $search_keywords
+     */
     private $search_keywords;
 
     /**
-    * @param array $data;
-    */
+     * @param array $data;
+     */
     public function set_searchable_data(array $data)
     {
         if (isset($data['search_properties']) && $data['search_properties'] !== null) {
@@ -34,9 +34,9 @@ 
     }
 
     /**
-    * @param array $search_properties
-    * @return SearchableInterface Chainable
-    */
+     * @param array $search_properties
+     * @return SearchableInterface Chainable
+     */
     public function set_search_properties(array $properties)
     {
         $this->search_properties = $properties;
@@ -44,17 +44,17 @@ 
     }
 
     /**
-    * @return array
-    */
+     * @return array
+     */
     public function search_properties()
     {
         return $this->search_properties;
     }
 
     /**
-    * @param mixed $keywords
-    * @return SearchableInterface Chainable
-    */
+     * @param mixed $keywords
+     * @return SearchableInterface Chainable
+     */
     public function set_search_keywords($keywords)
     {
         $this->search_keywords = new TranslationString($keywords);
@@ -62,8 +62,8 @@ 
     }
 
     /**
-    * @return TranslationString
-    */
+     * @return TranslationString
+     */
     public function search_keywords()
     {
         return $this->search_keywords;

src/Charcoal/Cms/Section/ContentSection.php

Doc Comments +1 added lines, -1 removed lines

@@ -17,7 +17,7 @@
 
     /**
     * @param mixed $content
-    * @return Section Chainable
+    * @return ContentSection Chainable
     */
     public function set_content($content)
     {

Indentation +7 added lines, -7 removed lines

@@ -8,17 +8,17 @@ 
 class ContentSection extends AbstractSection
 {
     /**
-    * @return string
-    */
+     * @return string
+     */
     public function section_type()
     {
         return AbstractSection::TYPE_CONTENT;
     }
 
     /**
-    * @param mixed $content
-    * @return Section Chainable
-    */
+     * @param mixed $content
+     * @return Section Chainable
+     */
     public function set_content($content)
     {
         $this->content = new TranslationString($content);
@@ -26,8 +26,8 @@ 
     }
 
     /**
-    * @return TranslationString
-    */
+     * @return TranslationString
+     */
     public function content()
     {
         return $this->content;

src/Charcoal/Cms/Template.php

Indentation +25 added lines, -25 removed lines

@@ -14,32 +14,32 @@ 
 class Template extends Content implements TemplateInterface
 {
     /**
-    * @var string $ident
-    */
+     * @var string $ident
+     */
     private $ident;
     /**
-    * @var TranslationString $title
-    */
+     * @var TranslationString $title
+     */
     private $title;
     /**
-    * @var array $options
-    */
+     * @var array $options
+     */
     private $options;
 
     /**
-    * IndexableInterface > key()
-    *
-    * @return string
-    */
+     * IndexableInterface > key()
+     *
+     * @return string
+     */
     public function key()
     {
         return 'ident';
     }
 
     /**
-    * @param string $ident
-    * @return TemplateInterface Chainable
-    */
+     * @param string $ident
+     * @return TemplateInterface Chainable
+     */
     public function set_ident($ident)
     {
         if (!is_string($ident)) {
@@ -52,17 +52,17 @@ 
     }
 
     /**
-    * @return string
-    */
+     * @return string
+     */
     public function ident()
     {
         return $this->ident;
     }
 
     /**
-    * @param mixed $title
-    * @return TemplateInterface Chainable
-    */
+     * @param mixed $title
+     * @return TemplateInterface Chainable
+     */
     public function set_title($title)
     {
         $this->title = new TranslationString($title);
@@ -70,17 +70,17 @@ 
     }
 
     /**
-    * @return TranslationString
-    */
+     * @return TranslationString
+     */
     public function title()
     {
         return $this->title;
     }
 
     /**
-    * @param array $options
-    * @return TemplateInterface Chainable
-    */
+     * @param array $options
+     * @return TemplateInterface Chainable
+     */
     public function set_options($options)
     {
         $this->options = $options;
@@ -88,8 +88,8 @@ 
     }
 
     /**
-    * @return array
-    */
+     * @return array
+     */
     public function options()
     {
         return $this->options;

src/Charcoal/Cms/BlockInterface.php

Indentation +30 added lines, -30 removed lines

@@ -8,68 +8,68 @@
 interface BlockInterface
 {
     /**
-    * @param string $type
-    * @return BlockInterface Chainable
-    */
+     * @param string $type
+     * @return BlockInterface Chainable
+     */
     public function set_parent_type($type);
 
     /**
-    * @return string
-    */
+     * @return string
+     */
     public function parent_type();
 
     /**
-    * @param mixed $id
-    * @return BlockInterface Chainable
-    */
+     * @param mixed $id
+     * @return BlockInterface Chainable
+     */
     public function set_parent_id($id);
 
     /**
-    * @return mixed
-    */
+     * @return mixed
+     */
     public function parent_id();
 
     /**
-    * @param string $type
-    * @return Chainable
-    */
+     * @param string $type
+     * @return Chainable
+     */
     public function set_block_type($type);
 
     /**
-    * @return string
-    */
+     * @return string
+     */
     public function block_type();
 
     /**
-    * @param mixed $title
-    * @return SectionInterface Chainable
-    */
+     * @param mixed $title
+     * @return SectionInterface Chainable
+     */
     public function set_title($title);
 
     /**
-    * @return TranslationString
-    */
+     * @return TranslationString
+     */
     public function title();
 
     /**
-    * @param mixed $subtitle
-    * @return SectionInterface Chainable
-    */
+     * @param mixed $subtitle
+     * @return SectionInterface Chainable
+     */
     public function set_subtitle($subtitle);
 
     /**
-    * @return TranslationString
-    */
+     * @return TranslationString
+     */
     public function subtitle();
 
     /**
-    * @param mixed $content
-    * @return SectionInterface Chainable
-    */
+     * @param mixed $content
+     * @return SectionInterface Chainable
+     */
     public function set_content($content);
 
     /**
-    * @return TranslationString
-    */
+     * @return TranslationString
+     */
     public function content();
 }