Charcoal\Admin\Widget\Cms\SectionTableTrait

Complexity

Total Complexity

24

Size/Duplication

Total Lines	182
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	2

Importance

Changes

0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	setSectionFactory()	0	6	1
A	sectionFactory()	0	10	2
C	parsePropertyCell()	0	78	12
B	abridgeUri()	0	29	5
A	abridgeStr()	0	8	4

<?php

namespace Charcoal\Admin\Widget\Cms;

use Exception;
use RuntimeException;

// From 'charcoal-core'
use Charcoal\Model\ModelInterface;

// From 'charcoal-factory'
use Charcoal\Factory\FactoryInterface;

// From 'charcoal-property'
use Charcoal\Property\PropertyInterface;

// Local dependency
use Charcoal\Cms\AbstractSection;

/**
 *
 */
trait SectionTableTrait
{
    /**
     * Store the factory instance for the current class.
     *
     * @var FactoryInterface
     */
    private $sectionFactory;

    /**
     * Set an object model factory.
     *
     * @param FactoryInterface $factory The model factory, to create objects.
     * @return self
     */
    protected function setSectionFactory(FactoryInterface $factory)
    {
        $this->sectionFactory = $factory;

        return $this;
    }

    /**
     * Retrieve the object model factory.
     *
     * @throws RuntimeException If the model factory was not previously set.
     * @return FactoryInterface
     */
    public function sectionFactory()
    {
        if (!isset($this->sectionFactory)) {
            throw new RuntimeException(
                sprintf('Section Model Factory is not defined for "%s"', get_class($this))
            );
        }

        return $this->sectionFactory;
    }

    /**
     * Filter the property before its assigned to the object row.
     *
     * This method is useful for classes using this trait.
     *
     * @param  ModelInterface    $object        The current row's object.
     * @param  PropertyInterface $property      The current property.
     * @param  string            $propertyValue The property $key's display value.
     * @return array
     */
    protected function parsePropertyCell(
        ModelInterface $object,
        PropertyInterface $property,
        $propertyValue
    ) {
        $propertyIdent = $property->ident();

        switch ($propertyIdent) {
            case 'template_ident':
                if ($object->templateIdent() === 'volleyball/template/page') {

It seems like you code against a concrete implementation and not the interface Charcoal\Model\ModelInterface as the method templateIdent() does only exist in the following implementations of said interface: Charcoal\Attachment\Object\Accordion, Charcoal\Attachment\Object\Attachment, Charcoal\Attachment\Object\Category\Generic, Charcoal\Attachment\Object\Container, Charcoal\Attachment\Object\Embed, Charcoal\Attachment\Object\File, Charcoal\Attachment\Object\Gallery, Charcoal\Attachment\Object\Image, Charcoal\Attachment\Object\Join, Charcoal\Attachment\Object\Link, Charcoal\Attachment\Object\Text, Charcoal\Attachment\Object\Video, Charcoal\Cms\AbstractDocument, Charcoal\Cms\AbstractEvent, Charcoal\Cms\AbstractFaq, Charcoal\Cms\AbstractImage, Charcoal\Cms\AbstractNews, Charcoal\Cms\AbstractSection, Charcoal\Cms\AbstractText, Charcoal\Cms\AbstractVideo, Charcoal\Cms\Config, Charcoal\Cms\Document, Charcoal\Cms\DocumentCategory, Charcoal\Cms\EmptySection, Charcoal\Cms\Event, Charcoal\Cms\EventCategory, Charcoal\Cms\ExternalSection, Charcoal\Cms\Faq, Charcoal\Cms\FaqCategory, Charcoal\Cms\Image, Charcoal\Cms\ImageCategory, Charcoal\Cms\News, Charcoal\Cms\NewsCategory, Charcoal\Cms\Section, Charcoal\Cms\Section\BlocksSection, Charcoal\Cms\Section\ContentSection, Charcoal\Cms\Tag, Charcoal\Cms\Text, Charcoal\Cms\TextCategory, Charcoal\Cms\Video, Charcoal\Cms\VideoCategory, Charcoal\Model\AbstractModel, Charcoal\Model\Model, Charcoal\Object\Content, Charcoal\Object\ObjectRevision, Charcoal\Object\ObjectRoute, Charcoal\Object\ObjectSchedule, Charcoal\Object\Tests\Mocks\RoutableClass, Charcoal\Object\UserData.

                    $propertyValue = sprintf(
                        '<span aria-hidden="true">─</span><span class="sr-only">%s</span>',
                        $this->translator()->translation([

It seems like translator() must be provided by classes using this trait. How about adding it as abstract method to this trait?

                            'en' => 'Default Template',
                            'fr' => 'Modèle par défaut'
                        ])
                    );
                }
                break;

            case 'title':
            case 'menu_label':
                $sectionTag = null;

$sectionTag is not used, you could remove the assignment.

                $sectionType = $object->sectionType();

It seems like you code against a concrete implementation and not the interface Charcoal\Model\ModelInterface as the method sectionType() does only exist in the following implementations of said interface: Charcoal\Cms\AbstractSection, Charcoal\Cms\EmptySection, Charcoal\Cms\ExternalSection, Charcoal\Cms\Section, Charcoal\Cms\Section\BlocksSection, Charcoal\Cms\Section\ContentSection.

                switch ($sectionType) {
                    case AbstractSection::TYPE_EXTERNAL:
                        $externalUrl = (string)$object->externalUrl();

It seems like you code against a concrete implementation and not the interface Charcoal\Model\ModelInterface as the method externalUrl() does only exist in the following implementations of said interface: Charcoal\Cms\AbstractSection, Charcoal\Cms\EmptySection, Charcoal\Cms\ExternalSection, Charcoal\Cms\Section, Charcoal\Cms\Section\BlocksSection, Charcoal\Cms\Section\ContentSection.

                        $linkExcerpt = '';
                        $tagTemplate = '<span class="glyphicon glyphicon-link" data-toggle="tooltip" '.
                            'data-placement="auto" title="%1$s"></span>';

                        if ($externalUrl) {
                            $tagTemplate = '<a class="btn btn-default btn-xs" href="%2$s" target="_blank">'.
                                '<span class="glyphicon glyphicon-link" aria-hidden="true"></span> '.
                                '<span class="sr-only">URL:</span> %3$s'.
                                '</a>';

                            $linkExcerpt = $this->abridgeUri($externalUrl);
                        }

                        $p = $object->p('section_type');
                        $propertyValue .= sprintf(
                            ' &nbsp; '.$tagTemplate,
                            $p->displayVal($p->val()),
                            $externalUrl,
                            $linkExcerpt
                        );
                        break;
                }
                break;
        }

        if ($propertyIdent === 'title') {
            if (is_callable([ $object, 'navMenu' ]) && $object->navMenu()) {

The method navMenu() does not seem to exist on object<Charcoal\Model\ModelInterface>.

                $propertyValue .= sprintf(
                    '   '.
                    '<span class="glyphicon glyphicon-list" data-toggle="tooltip" '.
                    'data-placement="auto" title="%s"></span>',
                    $this->translator()->translation([

It seems like translator() must be provided by classes using this trait. How about adding it as abstract method to this trait?

                        'en' => 'Present in a menu',
                        'fr' => 'Présent dans un menu'
                    ])
                );
            }

            if (is_callable([ $object, 'locked' ]) && $object->locked()) {

It seems like you code against a concrete implementation and not the interface Charcoal\Model\ModelInterface as the method locked() does only exist in the following implementations of said interface: Charcoal\Cms\AbstractSection, Charcoal\Cms\EmptySection, Charcoal\Cms\ExternalSection, Charcoal\Cms\Section, Charcoal\Cms\Section\BlocksSection, Charcoal\Cms\Section\ContentSection.

                $propertyValue .= sprintf(
                    '   '.
                    '<span class="glyphicon glyphicon-lock" data-toggle="tooltip" '.
                    'data-placement="auto" title="%s"></span>',
                    $object->p('locked')->label()
                );
            }
        }

        return parent::parsePropertyCell($object, $property, $propertyValue);
    }

    /**
     * Retrieve an abridged variant to the given URI.
     *
     * @param string $uri A URI to possibly truncate.
     * @return string
     */
    private function abridgeUri($uri)
    {
        $i = 30;
        $j = 12;

        if (mb_strlen($uri) <= $i) {
            return $uri;
        }

        $host = rtrim(parse_url($uri, PHP_URL_HOST), '/');
        $path = '/'.ltrim(parse_url($uri, PHP_URL_PATH), '/');

        if ($host === getenv('HTTP_HOST')) {
            $i = 50;
            $j = 22;

            $host = '';
        } else {
            if (mb_strlen($host) > $i && mb_strlen($path) > $i) {
                return $this->abridgeStr($uri, 50, 22);
            }

            $host = $this->abridgeStr($host, 20, 7);
        }

        $path = $this->abridgeStr($path, $i, $j);

        return $host.$path;
    }

    /**
     * Retrieve an abridged variant to the given URI.
     *
     * @param string  $str The string to possibly truncate.
     * @param integer $l   Optional. The soft-limit of the string.
     * @param integer $a   Optional. The hard-limit to keep from the beginning of the string.
     * @param integer $z   Optional. The hard-limit to keep from the end of the string.
     * @return string
     */
    private function abridgeStr($str, $l = 30, $a = 12, $z = 12)
    {
        if (mb_strlen($str) > $l) {
            $str = (($a > 0) ? mb_substr($str, 0, $a) : '').'&hellip;'.(($z > 0) ? mb_substr($str, -$z) : '');
        }

        return $str;
    }
}