Charcoal\Cms\AbstractSection

Complexity

Total Complexity

51

Size/Duplication

Total Lines	535
Duplicated Lines	9.53 %

Coupling/Cohesion

Components	3
Dependencies	9

Importance

Changes

0

34 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	8	8	2
A	isDeletable()	0	4	2
A	hierarchicalLabel()	0	4	1
A	loadChildren()	0	23	1
A	setSectionType()	0	12	2
A	setInMenu()	0	6	1
A	setKeywords()	0	6	1
A	setSummary()	0	6	1
A	setExternalUrl()	0	6	1
A	setLocked()	0	6	1
A	setTitle()	0	6	1
A	setSubtitle()	0	6	1
A	setContent()	0	6	1
A	setImage()	0	6	1
A	sectionType()	0	4	1
A	title()	0	4	1
A	subtitle()	0	4	1
A	content()	0	4	1
A	image()	0	4	1
A	inMenu()	0	4	1
A	keywords()	0	4	1
A	summary()	0	4	1
A	externalUrl()	0	4	1
A	locked()	0	4	1
A	canonicalUrl()	0	4	1
A	defaultMetaTitle()	0	4	1
A	defaultMetaDescription()	14	14	3
A	defaultMetaImage()	0	4	1
C	parseAsMultiple()	29	29	8
A	postSave()	0	9	2
A	postUpdate()	0	8	2
A	preSave()	0	8	2
A	preUpdate()	0	8	2
A	preDelete()	0	11	2

<?php

namespace Charcoal\Cms;

use InvalidArgumentException;

// From 'charcoal-core'
use Charcoal\Model\Collection;
use Charcoal\Loader\CollectionLoader;

// From 'charcoal-object'
use Charcoal\Object\Content;
use Charcoal\Object\HierarchicalInterface;
use Charcoal\Object\HierarchicalTrait;
use Charcoal\Object\RoutableInterface;
use Charcoal\Object\RoutableTrait;

// From 'charcoal-translator'
use Charcoal\Translator\Translation;

// From 'charcoal-cms'
use Charcoal\Cms\MetatagInterface;
use Charcoal\Cms\SearchableInterface;
use Charcoal\Cms\SectionInterface;
use Charcoal\Cms\TemplateableInterface;

/**
 * A Section is a unique, reachable page.
 *
 * ## Types of sections
 * There can be different types of section. 4 exists in the CMS module:
 * - `blocks`
 * - `content`
 * - `empty`
 * - `external`
 *
 * ## External implementations
 * Sections implement the following _Interface_ / _Trait_:
 * - From the `Charcoal\Object` namespace (in `charcoal-base`)
 *   - `Hierarchical`
 *   - `Routable`
 * - From the local `Charcoal\Cms` namespace
 *   - `Metatag`
 *   - `Searchable`
 *
 */
abstract class AbstractSection extends Content implements
    HierarchicalInterface,
    MetatagInterface,
    RoutableInterface,
    SearchableInterface,
    SectionInterface,
    TemplateableInterface
{
    use HierarchicalTrait;
    use MetatagTrait;
    use RoutableTrait;
    use SearchableTrait;
    use TemplateableTrait;

    const TYPE_BLOCKS = 'charcoal/cms/section/blocks-section';
    const TYPE_CONTENT = 'charcoal/cms/section/content-section';
    const TYPE_EMPTY = 'charcoal/cms/section/empty-section';
    const TYPE_EXTERNAL = 'charcoal/cms/section/external-section';
    const DEFAULT_TYPE = self::TYPE_CONTENT;

    /**
     * @var string
     */
    private $sectionType = self::DEFAULT_TYPE;

    /**
     * @var Translation|string|null
     */
    private $title;

    /**
     * @var Translation|string|null
     */
    private $subtitle;

    /**
     * @var Translation|string|null
     */
    private $content;

    /**
     * @var Translation|string|null
     */
    private $image;

    /**
     * The menus this object is shown in.
     *
     * @var string[]
     */
    protected $inMenu;

    /**
     * @var array
     */
    protected $keywords;

    /**
     * @var Translation|string $summary
     */
    protected $summary;

    /**
     * @var string $externalUrl
     */
    protected $externalUrl;

    /**
     * @var boolean $locked
     */
    protected $locked;

    // ==========================================================================
    // INIT
    // ==========================================================================

    /**
     * Section constructor.
     * @param array $data Init data.
     */
    public function __construct(array $data = null)

This method seems to be duplicated in your project.

    {
        parent::__construct($data);

        if (is_callable([ $this, 'defaultData' ])) {
            $this->setData($this->defaultData());
        }
    }

    // ==========================================================================
    // FUNCTIONS
    // ==========================================================================

    /**
     * Determine if the object can be deleted.
     *
     * @return boolean
     */
    public function isDeletable()
    {
        return !!$this->id() && !$this->locked();
    }

    /**
     * Retrieve the object's title.
     *
     * @return string
     */
    public function hierarchicalLabel()
    {
        return str_repeat('— ', ($this->hierarchyLevel() - 1)).$this->title();
    }

    /**
     * HierarchicalTrait > loadChildren
     *
     * @return \ArrayAccess|\Traversable
     */
    public function loadChildren()
    {
        $loader = new CollectionLoader([
            'logger'  => $this->logger,
            'factory' => $this->modelFactory()
        ]);
        $loader->setModel($this);
        $loader->addFilter([
            'property' => 'master',
            'val'      => $this->id()
        ]);
        $loader->addFilter([
            'property' => 'active',
            'val'      => true
        ]);

        $loader->addOrder([
            'property' => 'position',
            'mode'     => 'asc'
        ]);

        return $loader->load();
    }

    // ==========================================================================
    // SETTERS
    // ==========================================================================

    /**
     * Set the section's type.
     *
     * @param  string $type The section type.
     * @throws InvalidArgumentException If the section type is not a string or not a valid section type.
     * @return self
     */
    public function setSectionType($type)
    {
        if (!is_string($type)) {
            throw new InvalidArgumentException(
                'Section type must be a string'
            );
        }

        $this->sectionType = $type;

        return $this;
    }

    /**
     * Set the menus this object belongs to.
     *
     * @param  string|string[] $menu One or more menu identifiers.
     * @return self
     */
    public function setInMenu($menu)
    {
        $this->inMenu = $menu;

It seems like $menu can also be of type string. However, the property $inMenu is declared as type array<integer,string>. Maybe add an additional type check?

        return $this;
    }

    /**
     * Set the object's keywords.
     *
     * @param  string|string[] $keywords One or more entries.
     * @return self
     */
    public function setKeywords($keywords)
    {
        $this->keywords = $this->parseAsMultiple($keywords);

        return $this;
    }

    /**
     * @param Translation|string|null $summary The summary.
     * @return self
     */
    public function setSummary($summary)
    {
        $this->summary = $this->translator()->translation($summary);

        return $this;
    }

    /**
     * @param Translation|string|null $externalUrl The external url.
     * @return self
     */
    public function setExternalUrl($externalUrl)
    {
        $this->externalUrl = $this->translator()->translation($externalUrl);

It seems like $this->translator()->translation($externalUrl) can also be of type object<Charcoal\Translator\Translation>. However, the property $externalUrl is declared as type string. Maybe add an additional type check?

        return $this;
    }

    /**
     * Section is locked when you can't change the URL
     * @param boolean $locked Prevent new route creation about that object.
     * @return self
     */
    public function setLocked($locked)
    {
        $this->locked = $locked;

        return $this;
    }

    /**
     * @param Translation|string|null $title The section title (localized).
     * @return self
     */
    public function setTitle($title)
    {
        $this->title = $this->translator()->translation($title);

        return $this;
    }

    /**
     * @param Translation|string|null $subtitle The section subtitle (localized).
     * @return self
     */
    public function setSubtitle($subtitle)
    {
        $this->subtitle = $this->translator()->translation($subtitle);

        return $this;
    }

    /**
     * @param Translation|string|null $content The section content (localized).
     * @return self
     */
    public function setContent($content)
    {
        $this->content = $this->translator()->translation($content);

        return $this;
    }

    /**
     * @param mixed $image The section main image (localized).
     * @return self
     */
    public function setImage($image)
    {
        $this->image = $this->translator()->translation($image);

        return $this;
    }

    // ==========================================================================
    // GETTERS
    // ==========================================================================

    /**
     * Retrieve the section's type.
     *
     * @return string
     */
    public function sectionType()
    {
        return $this->sectionType;
    }

    /**
     * @return Translation|string|null
     */
    public function title()
    {
        return $this->title;
    }

    /**
     * @return Translation|string|null
     */
    public function subtitle()
    {
        return $this->subtitle;
    }

    /**
     * @return Translation|string|null
     */
    public function content()
    {
        return $this->content;

The expression $this->content; of type Charcoal\Translator\Translation|string|null adds the type string to the return on line 352 which is incompatible with the return type declared by the interface Charcoal\Cms\SectionInterface::content of type Charcoal\Translator\Translation.

    }

    /**
     * @return Translation|string|null
     */
    public function image()
    {
        return $this->image;

The expression $this->image; of type Charcoal\Translator\Translation|string|null adds the type string to the return on line 360 which is incompatible with the return type declared by the interface Charcoal\Cms\SectionInterface::image of type Charcoal\Translator\Translation.

    }

    /**
     * Retrieve the menus this object belongs to.
     *
     * @return Translation|string|null
     */
    public function inMenu()
    {
        return $this->inMenu;

The return type of return $this->inMenu; (string[]) is incompatible with the return type declared by the interface Charcoal\Cms\SectionInterface::inMenu of type string|Charcoal\Translator\Translation.

    }

    /**
     * Retrieve the object's keywords.
     *
     * @return string[]
     */
    public function keywords()
    {
        return $this->keywords;
    }

    /**
     * HierarchicalTrait > loadChildren
     *
     * @return Translation|string|null
     */
    public function summary()
    {
        return $this->summary;

The expression $this->summary; of type Charcoal\Translator\Translation|string adds the type string to the return on line 390 which is incompatible with the return type declared by the interface Charcoal\Cms\SectionInterface::summary of type Charcoal\Translator\Translation.

    }

    /**
     * @return Translation|string|null
     */
    public function externalUrl()
    {
        return $this->externalUrl;
    }

    /**
     * @return boolean Or Null.
     */
    public function locked()
    {
        return $this->locked;
    }

    // ==========================================================================
    // DEFAULT META
    // ==========================================================================

    /**
     * MetatagTrait > canonicalUrl
     *
     * @todo
     * @return string
     */
    public function canonicalUrl()
    {
        return $this->url();
    }

    /**
     * @return Translation|string|null
     */
    public function defaultMetaTitle()
    {
        return $this->title();

The expression $this->title(); of type Charcoal\Translator\Translation|string|null adds the type string to the return on line 429 which is incompatible with the return type declared by the interface Charcoal\Cms\SectionInterface::defaultMetaTitle of type Charcoal\Translator\Translation.

    }

    /**
     * @return Translation|string|null
     */
    public function defaultMetaDescription()

This method seems to be duplicated in your project.

    {
        $content = $this->translator()->translation($this->content());
        if ($content instanceof Translation) {
            $desc = [];
            foreach ($content->data() as $lang => $text) {
                $desc[$lang] = strip_tags($text);
            }

            return $this->translator()->translation($desc);
        }

        return null;
    }

    /**
     * @return Translation|string|null
     */
    public function defaultMetaImage()
    {
        return $this->image();

The expression $this->image(); of type Charcoal\Translator\Translation|string|null adds the type string to the return on line 455 which is incompatible with the return type declared by the interface Charcoal\Cms\SectionInterface::defaultMetaImage of type Charcoal\Translator\Translation.

    }

    // ==========================================================================
    // Utils
    // ==========================================================================

    /**
     * Parse the property value as a "multiple" value type.
     *
     * @param  mixed                    $value     The value being converted to an array.
     * @param  string|PropertyInterface $separator The boundary string.
     * @return array
     */
    public function parseAsMultiple($value, $separator = ',')

This method seems to be duplicated in your project.

    {
        if (!isset($value) ||
            (is_string($value) && !strlen(trim($value))) ||
            (is_array($value) && !count(array_filter($value, 'strlen')))
        ) {
            return [];
        }

        /**
         * This property is marked as "multiple".
         * Manually handling the resolution to array
         * until the property itself manages this.
         */
        if (is_string($value)) {
            return explode($separator, $value);
        }

        /**
         * If the parameter isn't an array yet,
         * means we might be dealing with an integer,
         * an empty string, or an object.
         */
        if (!is_array($value)) {
            return [ $value ];
        }

        return $value;
    }

    // ==========================================================================
    // EVENTS
    // ==========================================================================

    /**
     * Route generated on postSave in case
     * it contains the ID of the section, which
     * you only get once you have save
     *
     * @return boolean
     */
    public function postSave()
    {
        // RoutableTrait
        if (!$this->locked()) {
            $this->generateObjectRoute($this->slug());
        }

        return parent::postSave();
    }

    /**
     * Check whatever before the update.
     *
     * @param  array|null $properties Properties.
     * @return boolean
     */
    public function postUpdate(array $properties = null)
    {
        if (!$this->locked()) {
            $this->generateObjectRoute($this->slug());
        }

        return parent::postUpdate($properties);

It seems like $properties defined by parameter $properties on line 526 can also be of type array; however, Charcoal\Source\StorableTrait::postUpdate() does only seem to accept null|array<integer,string>, maybe add an additional type check?

    }

    /**
     * {@inheritdoc}
     *
     * @return boolean
     */
    public function preSave()
    {
        if (!$this->locked()) {
            $this->setSlug($this->generateSlug());
        }

        return parent::preSave();
    }

    /**
     * {@inheritdoc}
     *
     * @param array $properties Optional properties to update.
     * @return boolean
     */
    public function preUpdate(array $properties = null)
    {
        if (!$this->locked()) {
            $this->setSlug($this->generateSlug());
        }

        return parent::preUpdate($properties);
    }

    /**
     * Event called before _deleting_ the object.
     *
     * @see    \Charcoal\Model\AbstractModel::preDelete() For the "delete" Event.
     * @return boolean
     */
    public function preDelete()
    {
        if ($this->locked()) {
            return false;
        }
        // Routable trait
        // Remove all unnecessary routes.
        $this->deleteObjectRoutes();

        return parent::preDelete();
    }
}