SectionLoaderAwareTrait::setSectionLoader() - Code Metrics - Inspection of "Merge pull request #2 from locomotivemtl/cms_servi..." - locomotivemtl/charcoal-cms - Measure and Improve Code Quality continuously with Scrutinizer

Test Failed

Push — master ( dc68d1...1f5199 )

by Mathieu

created 2017-04-03 15:56 UTC

SectionLoaderAwareTrait::setSectionLoader() A

↳ Parent: SectionLoaderAwareTrait

Complexity

Conditions	1
Paths	1

Size

Total Lines	6
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	6
rs	9.4285
c	0
b	0
f	0
cc	1
eloc	3
nc	1
nop	1

<?php

namespace Charcoal\Cms\Support\Traits;

use Charcoal\Cms\SectionInterface;
use Charcoal\Model\ModelInterface;
use Charcoal\Cms\Service\Loader\SectionLoader;
use Slim\Exception\ContainerException;

trait SectionLoaderAwareTrait
{
    /**
     * @var SectionInterface $section
     */
    private $section;

    /**
     * @var SectionInterface[] $sections
     */
    private $sections;

    /**
     * @var SectionInterface[] $masterSections
     */
    private $masterSections;

    /**
     * @var SectionInterface[] $childrenSections
     */
    private $childrenSections;

    /**
     * @var SectionLoader $sectionLoader City\\Loader\\SectionLoader.
     */
    private $sectionLoader;

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

    /**
     * Must call section if the context object is of type Section.
     * @param ModelInterface $context The current context.
     * @return mixed
     */
    abstract public function setContextObject(ModelInterface $context);

    /**
     * @return \ArrayAccess|\Traversable
     */
    public function sections()
    {
        return $this->sectionLoader()->all()->load();
    }

    /**
     * @return \ArrayAccess|\Traversable
     */
    public function masterSections()
    {
        return $this->sectionLoader()->masters();
    }

    /**
     * @return \ArrayAccess|\Traversable
     */
    public function childrenSections()
    {
        return $this->sectionLoader()->children();
    }

    /**
     * Gets latest route for the given slug.
     * @return string The latest url.
     */
    public function routes()
    {
        return function ($arg) {
            return $this->sectionLoader()->resolveRoute($arg);
        };
    }

    /**
     * Gets the current section based on AbstractTemplate::Section and context.
     * @param boolean $raw Option the receive the non-formatted section.
     * @return array|SectionInterface
     */
    public function currentSection($raw = false)
    {
        if ($raw) {
            return $this->section();
        }

        return $this->formatSection($this->section());
    }

    /**
     * @param string $slug The section slug to load from.
     * @return SectionInterface|array
     */
    public function sectionFromSlug($slug)
    {
        return $this->sectionLoader()->fromSlug($slug);
    }

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

    /**
     * @return SectionInterface
     */
    protected function section()
    {
        return $this->section;
    }

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

    /**
     * @param SectionInterface $section The current section.
     * @return self
     */
    protected function setSection(SectionInterface $section)
    {
        $this->section = $section;

        return $this;
    }

    // ==========================================================================
    // DEPENDENCIES
    // ==========================================================================

    /**
     * @return SectionLoader
     * @throws ContainerException When dependency is missing.
     */
    protected function sectionLoader()
    {
        if (!$this->sectionLoader instanceof SectionLoader) {
            throw new ContainerException(sprintf(
                'Missing dependency for %s: %s',
                get_called_class(),
                SectionLoader::class
            ));
        }

        return $this->sectionLoader;
    }

    /**
     * @param SectionLoader $loader The section loader.
     * @return self
     */
    protected function setSectionLoader(SectionLoader $loader)
    {
        $this->sectionLoader = $loader;

        return $this;
    }

    // ==========================================================================
    // FORMATTER
    // ==========================================================================

    /**
     * @param SectionInterface $section The section to format.
     * @return array
     */
    protected function formatSection(SectionInterface $section)
    {
        $contentBlocks = $section->attachments('content');

        $gallery = $section->attachments('image-gallery');

        $documents = $section->attachments('document');


        return [
            'title'         => (string)$section->title(),
            'summary'       => (string)$section->summary(),
            'image'         => (string)$section->image(),
            'content'       => (string)$section->content(),
            'contentBlocks' => $contentBlocks,
            'gallery'       => $gallery,
            'documents'     => $documents
        ];
    }
}


1			<?php
2
3			namespace Charcoal\Cms\Support\Traits;
4
5			use Charcoal\Cms\SectionInterface;
6			use Charcoal\Model\ModelInterface;
7			use Charcoal\Cms\Service\Loader\SectionLoader;
8			use Slim\Exception\ContainerException;
9
10			trait SectionLoaderAwareTrait
11			{
12			/**
13			* @var SectionInterface $section
14			*/
15			private $section;
16
17			/**
18			* @var SectionInterface[] $sections
19			*/
20			private $sections;
21
22			/**
23			* @var SectionInterface[] $masterSections
24			*/
25			private $masterSections;
26
27			/**
28			* @var SectionInterface[] $childrenSections
29			*/
30			private $childrenSections;
31
32			/**
33			* @var SectionLoader $sectionLoader City\\Loader\\SectionLoader.
34			*/
35			private $sectionLoader;
36
37			// ==========================================================================
38			// INIT
39			// ==========================================================================
40
41			/**
42			* Must call section if the context object is of type Section.
43			* @param ModelInterface $context The current context.
44			* @return mixed
45			*/
46			abstract public function setContextObject(ModelInterface $context);
47
48			/**
49			* @return \ArrayAccess\|\Traversable
50			*/
51			public function sections()
52			{
53			return $this->sectionLoader()->all()->load();
54			}
55
56			/**
57			* @return \ArrayAccess\|\Traversable
58			*/
59			public function masterSections()
60			{
61			return $this->sectionLoader()->masters();
62			}
63
64			/**
65			* @return \ArrayAccess\|\Traversable
66			*/
67			public function childrenSections()
68			{
69			return $this->sectionLoader()->children();
70			}
71
72			/**
73			* Gets latest route for the given slug.
74			* @return string The latest url.
75			*/
76			public function routes()
77			{
78			return function ($arg) {
79			return $this->sectionLoader()->resolveRoute($arg);
80			};
81			}
82
83			/**
84			* Gets the current section based on AbstractTemplate::Section and context.
85			* @param boolean $raw Option the receive the non-formatted section.
86			* @return array\|SectionInterface
87			*/
88			public function currentSection($raw = false)
89			{
90			if ($raw) {
91			return $this->section();
92			}
93
94			return $this->formatSection($this->section());
95			}
96
97			/**
98			* @param string $slug The section slug to load from.
99			* @return SectionInterface\|array
100			*/
101			public function sectionFromSlug($slug)
102			{
103			return $this->sectionLoader()->fromSlug($slug);
104			}
105
106			// ==========================================================================
107			// GETTERS
108			// ==========================================================================
109
110			/**
111			* @return SectionInterface
112			*/
113			protected function section()
114			{
115			return $this->section;
116			}
117
118			// ==========================================================================
119			// SETTERS
120			// ==========================================================================
121
122			/**
123			* @param SectionInterface $section The current section.
124			* @return self
125			*/
126			protected function setSection(SectionInterface $section)
127			{
128			$this->section = $section;
129
130			return $this;
131			}
132
133			// ==========================================================================
134			// DEPENDENCIES
135			// ==========================================================================
136
137			/**
138			* @return SectionLoader
139			* @throws ContainerException When dependency is missing.
140			*/
141			protected function sectionLoader()
142			{
143			if (!$this->sectionLoader instanceof SectionLoader) {
144			throw new ContainerException(sprintf(
145			'Missing dependency for %s: %s',
146			get_called_class(),
147			SectionLoader::class
148			));
149			}
150
151			return $this->sectionLoader;
152			}
153
154			/**
155			* @param SectionLoader $loader The section loader.
156			* @return self
157			*/
158			protected function setSectionLoader(SectionLoader $loader)
159			{
160			$this->sectionLoader = $loader;
161
162			return $this;
163			}
164
165			// ==========================================================================
166			// FORMATTER
167			// ==========================================================================
168
169			/**
170			* @param SectionInterface $section The section to format.
171			* @return array
172			*/
173			protected function formatSection(SectionInterface $section)
174			{
175			$contentBlocks = $section->attachments('content');
			0 ignored issues – show Bug introduced 2017-03-28 16:58 UTC by Report Bug Copy Issue Report The method `attachments()` does not seem to exist on `object<Charcoal\Cms\SectionInterface>`. This check looks for calls to methods that do not seem to exist on a given type. It looks for the method on the type itself as well as in inherited classes or implemented interfaces. This is most likely a typographical error or the method has been renamed. Loading history...
176			$gallery = $section->attachments('image-gallery');
			0 ignored issues – show Bug introduced 2017-03-28 16:58 UTC by Report Bug Copy Issue Report The method `attachments()` does not seem to exist on `object<Charcoal\Cms\SectionInterface>`. This check looks for calls to methods that do not seem to exist on a given type. It looks for the method on the type itself as well as in inherited classes or implemented interfaces. This is most likely a typographical error or the method has been renamed. Loading history...
177			$documents = $section->attachments('document');
			0 ignored issues – show Bug introduced 2017-03-28 16:58 UTC by Report Bug Copy Issue Report The method `attachments()` does not seem to exist on `object<Charcoal\Cms\SectionInterface>`. This check looks for calls to methods that do not seem to exist on a given type. It looks for the method on the type itself as well as in inherited classes or implemented interfaces. This is most likely a typographical error or the method has been renamed. Loading history...
178
179			return [
180			'title' => (string)$section->title(),
181			'summary' => (string)$section->summary(),
182			'image' => (string)$section->image(),
183			'content' => (string)$section->content(),
184			'contentBlocks' => $contentBlocks,
185			'gallery' => $gallery,
186			'documents' => $documents
187			];
188			}
189			}
190

locomotivemtl / charcoal-cms

Push — master ( dc68d1...1f5199 )

SectionLoaderAwareTrait::setSectionLoader() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like