TemplateDomain::createGlobal() - Code Metrics - Inspection of "Adds template domain tests, bugfix page bundle" - Synapse-Cmf/synapse-cmf - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — nyx-refactor-internal-api ( bc802c )

by Quentin

created 2016-11-23 16:00 UTC

TemplateDomain::createGlobal() C

↳ Parent: TemplateDomain

Complexity

Conditions	8
Paths	5

Size

Total Lines	36
Code Lines	23

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	72

Importance

Changes

Metric	Value
dl	0
loc	36
rs	5.3846
c	0
b	0
f	0
ccs	0
cts	26
cp	0
cc	8
eloc	23
nc	5
nop	3
crap	72

<?php

namespace Synapse\Cmf\Framework\Theme\Template\Domain;

use Majora\Framework\Domain\ActionDispatcherDomain;
use Majora\Framework\Domain\Action\ActionFactory;
use Synapse\Cmf\Framework\Theme\ContentType\Loader\LoaderInterface as ContentTypeLoader;
use Synapse\Cmf\Framework\Theme\ContentType\Model\ContentTypeInterface;
use Synapse\Cmf\Framework\Theme\Content\Entity\Content;
use Synapse\Cmf\Framework\Theme\Content\Model\ContentInterface;
use Synapse\Cmf\Framework\Theme\Content\Resolver\ContentResolver;
use Synapse\Cmf\Framework\Theme\TemplateType\Loader\LoaderInterface as TemplateTypeLoader;
use Synapse\Cmf\Framework\Theme\TemplateType\Model\TemplateTypeInterface;
use Synapse\Cmf\Framework\Theme\Template\Model\TemplateInterface;
use Synapse\Cmf\Framework\Theme\Zone\Entity\ZoneCollection;

/**
 * Template domain use cases class.
 */
class TemplateDomain extends ActionDispatcherDomain implements DomainInterface
{
    /**
     * @var ActionFactory
     */
    protected $commandFactory;

    /**
     * @var ContentResolver
     */
    protected $contentResolver;

    /**
     * @var ContentTypeLoader
     */
    protected $contentTypeLoader;

    /**
     * @var TemplateTypeLoader
     */
    protected $templateTypeLoader;

    /**
     * Construct.
     *
     * @param ActionFactory      $commandFactory
     * @param ContentResolver    $contentResolver
     * @param ContentTypeLoader  $contentTypeLoader
     * @param TemplateTypeLoader $templateTypeLoader
     */
    public function __construct(
        ActionFactory $commandFactory,
        ContentResolver $contentResolver,
        ContentTypeLoader  $contentTypeLoader,
        TemplateTypeLoader $templateTypeLoader
    ) {
        parent::__construct($commandFactory);

        $this->commandFactory = $commandFactory; // backward compatibility
        $this->contentResolver = $contentResolver;
        $this->contentTypeLoader = $contentTypeLoader;
        $this->templateTypeLoader = $templateTypeLoader;
    }

    /**
     * Resolve given template type name as TemplateType object.
     *
     * @param mixed $templateType
     *
     * @return TemplateTypeInterface
     *
     * @throws InvalidArgumentException If template type isnt a TemplateTypeInterface or an unknown name
     */
    private function resolveTemplateType($templateType)
    {
        if (is_string($templateType)
            && !$templateType = $this->templateTypeLoader->retrieve($templateTypeName = $templateType)) {
            throw new \InvalidArgumentException(sprintf('Given template type name is invalid, "%s" given.',
                $templateTypeName
            ));
        }
        if ($templateType instanceof TemplateTypeInterface) {
            return $templateType;
        }

        throw new \InvalidArgumentException(sprintf(
            '%s only supports template type names or template type objects, "%s" given.',
            __CLASS__,
            is_object($templateType) ? get_class($templateType) : $templateType
        ));
    }

    /**
     * @see DomainInterface::createLocal()
     */
    public function createLocal($content, $templateType, ZoneCollection $zones = null)
    {
        // create and resolve promise
        return $this->commandFactory
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
            ->createAction('create_local')
                ->setContent($content instanceof Content
                    ? $content
                    : $this->contentResolver->resolve($content)
                )
                ->setTemplateType($this->resolveTemplateType($templateType))
                ->setZones($zones ?: new ZoneCollection())
            ->resolve()
        ;
    }

    /**
     * @see DomainInterface::createGlobal()
     */
    public function createGlobal($contentType, $templateType, ZoneCollection $zones = null)
    {
        // resolve given content as content type
        switch (true) {

            case is_string($contentType) && is_a($contentType, ContentInterface::class, true):
                $contentType = $this->contentTypeTypeLoader->retrieveByContentClass($contentType);
class MyClass { }

$x = new MyClass();
$x->foo = true;
                break;

            case $contentType instanceof Content:
                $contentType = $contentType->getType();
                break;

            case is_string($contentType):

                $contentType = $this->contentTypeLoader->retrieve($contentType);

            case $contentType instanceof ContentTypeInterface:
                break;

            default:
                throw new \InvalidArgumentException(sprintf(
                    '%s() only supports content class or object, or content object or name, "%s" given.',
                    __CLASS__,
                    is_object($contentType) ? get_class($contentType) : $contentType
                ));
        }

        // create and resolve promise
        return $this->commandFactory
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
            ->createAction('create_global')
                ->setContentType($contentType)
                ->setTemplateType($this->resolveTemplateType($templateType))
                ->setZones($zones ?: new ZoneCollection())
            ->resolve()
        ;
    }

    /**
     * @see DomainInterface::edit()
     */
    public function edit(TemplateInterface $template, ...$arguments)
    {
        return $this->commandFactory
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
            ->createAction('edit')
                ->init($template)
                ->denormalize($arguments)
            ->resolve()
        ;
    }

    /**
     * @see DomainInterface::delete()
     */
    public function delete(TemplateInterface $template)
    {
        return $this->commandFactory
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
            ->createAction('delete')
                ->init($template)
            ->resolve()
        ;
    }
}


1		<?php
2
3		namespace Synapse\Cmf\Framework\Theme\Template\Domain;
4
5		use Majora\Framework\Domain\ActionDispatcherDomain;
6		use Majora\Framework\Domain\Action\ActionFactory;
7		use Synapse\Cmf\Framework\Theme\ContentType\Loader\LoaderInterface as ContentTypeLoader;
8		use Synapse\Cmf\Framework\Theme\ContentType\Model\ContentTypeInterface;
9		use Synapse\Cmf\Framework\Theme\Content\Entity\Content;
10		use Synapse\Cmf\Framework\Theme\Content\Model\ContentInterface;
11		use Synapse\Cmf\Framework\Theme\Content\Resolver\ContentResolver;
12		use Synapse\Cmf\Framework\Theme\TemplateType\Loader\LoaderInterface as TemplateTypeLoader;
13		use Synapse\Cmf\Framework\Theme\TemplateType\Model\TemplateTypeInterface;
14		use Synapse\Cmf\Framework\Theme\Template\Model\TemplateInterface;
15		use Synapse\Cmf\Framework\Theme\Zone\Entity\ZoneCollection;
16
17		/**
18		* Template domain use cases class.
19		*/
20		class TemplateDomain extends ActionDispatcherDomain implements DomainInterface
21		{
22		/**
23		* @var ActionFactory
24		*/
25		protected $commandFactory;
26
27		/**
28		* @var ContentResolver
29		*/
30		protected $contentResolver;
31
32		/**
33		* @var ContentTypeLoader
34		*/
35		protected $contentTypeLoader;
36
37		/**
38		* @var TemplateTypeLoader
39		*/
40		protected $templateTypeLoader;
41
42		/**
43		* Construct.
44		*
45		* @param ActionFactory $commandFactory
46		* @param ContentResolver $contentResolver
47		* @param ContentTypeLoader $contentTypeLoader
48		* @param TemplateTypeLoader $templateTypeLoader
49		*/
50	4	public function __construct(
51		ActionFactory $commandFactory,
52		ContentResolver $contentResolver,
53		ContentTypeLoader $contentTypeLoader,
54		TemplateTypeLoader $templateTypeLoader
55		) {
56	4	parent::__construct($commandFactory);
57
58	4	$this->commandFactory = $commandFactory; // backward compatibility
59	4	$this->contentResolver = $contentResolver;
60	4	$this->contentTypeLoader = $contentTypeLoader;
61	4	$this->templateTypeLoader = $templateTypeLoader;
62	4	}
63
64		/**
65		* Resolve given template type name as TemplateType object.
66		*
67		* @param mixed $templateType
68		*
69		* @return TemplateTypeInterface
70		*
71		* @throws InvalidArgumentException If template type isnt a TemplateTypeInterface or an unknown name
72		*/
73	4	private function resolveTemplateType($templateType)
74		{
75	4	if (is_string($templateType)
76	4	&& !$templateType = $this->templateTypeLoader->retrieve($templateTypeName = $templateType)) {
77		throw new \InvalidArgumentException(sprintf('Given template type name is invalid, "%s" given.',
78		$templateTypeName
79		));
80		}
81	4	if ($templateType instanceof TemplateTypeInterface) {
82	4	return $templateType;
83		}
84
85		throw new \InvalidArgumentException(sprintf(
86		'%s only supports template type names or template type objects, "%s" given.',
87		__CLASS__,
88		is_object($templateType) ? get_class($templateType) : $templateType
89		));
90		}
91
92		/**
93		* @see DomainInterface::createLocal()
94		*/
95	4	public function createLocal($content, $templateType, ZoneCollection $zones = null)
96		{
97		// create and resolve promise
98	4	return $this->commandFactory
		0 ignored issues – show Bug introduced 2016-10-20 13:31 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Majora\Framework\Domain\Action\ActionInterface` as the method `setContent()` does only exist in the following implementations of said interface: `Synapse\Cmf\Framework\Th...mand\CreateLocalCommand`. Let’s take a look at an example: interface User { /** @return string / public function getPassword(); } class MyUser implements User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different implementation of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the interface: interface User { /** @return string / public function getPassword(); /* @return string */ public function getDisplayName(); } Loading history...
99	4	->createAction('create_local')
100	4	->setContent($content instanceof Content
101	3	? $content
102	4	: $this->contentResolver->resolve($content)
103	2	)
104	4	->setTemplateType($this->resolveTemplateType($templateType))
105	4	->setZones($zones ?: new ZoneCollection())
106	4	->resolve()
107	2	;
108		}
109
110		/**
111		* @see DomainInterface::createGlobal()
112		*/
113		public function createGlobal($contentType, $templateType, ZoneCollection $zones = null)
114		{
115		// resolve given content as content type
116		switch (true) {
117
118		case is_string($contentType) && is_a($contentType, ContentInterface::class, true):
119		$contentType = $this->contentTypeTypeLoader->retrieveByContentClass($contentType);
		0 ignored issues – show Bug introduced 2016-10-13 09:48 UTC by Report Bug Copy Issue Report The property `contentTypeTypeLoader` does not exist. Did you maybe forget to declare it? In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code: class MyClass { } $x = new MyClass(); $x->foo = true; Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion: class MyClass { public $foo; } $x = new MyClass(); $x->foo = true; Loading history...
120		break;
121
122		case $contentType instanceof Content:
123		$contentType = $contentType->getType();
124		break;
125
126		case is_string($contentType):
		0 ignored issues – show Coding Style introduced 2016-10-13 09:48 UTC by Report Bug Copy Issue Report There must be a comment when fall-through is intentional in a non-empty case body Loading history...
127		$contentType = $this->contentTypeLoader->retrieve($contentType);
128
129		case $contentType instanceof ContentTypeInterface:
130		break;
131
132		default:
133		throw new \InvalidArgumentException(sprintf(
134		'%s() only supports content class or object, or content object or name, "%s" given.',
135		__CLASS__,
136		is_object($contentType) ? get_class($contentType) : $contentType
137		));
138		}
139
140		// create and resolve promise
141		return $this->commandFactory
		0 ignored issues – show Bug introduced 2016-10-20 13:31 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Majora\Framework\Domain\Action\ActionInterface` as the method `setContentType()` does only exist in the following implementations of said interface: `Synapse\Cmf\Framework\Th...and\CreateGlobalCommand`. Let’s take a look at an example: interface User { /** @return string / public function getPassword(); } class MyUser implements User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different implementation of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the interface: interface User { /** @return string / public function getPassword(); /* @return string */ public function getDisplayName(); } Loading history...
142		->createAction('create_global')
143		->setContentType($contentType)
144		->setTemplateType($this->resolveTemplateType($templateType))
145		->setZones($zones ?: new ZoneCollection())
146		->resolve()
147		;
148		}
149
150		/**
151		* @see DomainInterface::edit()
152		*/
153		public function edit(TemplateInterface $template, ...$arguments)
154		{
155		return $this->commandFactory
		0 ignored issues – show Bug introduced 2016-10-20 13:31 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Majora\Framework\Domain\Action\ActionInterface` as the method `init()` does only exist in the following implementations of said interface: `Majora\Framework\Domain\Action\AbstractAction`, `Synapse\Cmf\Framework\Me...e\Action\AbstractAction`, `Synapse\Cmf\Framework\Me...n\Dal\AbstractDalAction`, `Synapse\Cmf\Framework\Me...Action\Dal\CreateAction`, `Synapse\Cmf\Framework\Me...Action\Dal\UploadAction`, `Synapse\Cmf\Framework\Me...e\Action\AbstractAction`, `Synapse\Cmf\Framework\Me...n\Dal\AbstractDalAction`, `Synapse\Cmf\Framework\Me...Action\Dal\CreateAction`, `Synapse\Cmf\Framework\Me...Action\Dal\DeleteAction`, `Synapse\Cmf\Framework\Me...Action\Dal\UpdateAction`, `Synapse\Cmf\Framework\Me...e\Action\AbstractAction`, `Synapse\Cmf\Framework\Me...n\Dal\AbstractDalAction`, `Synapse\Cmf\Framework\Me...Action\Dal\CreateAction`, `Synapse\Cmf\Framework\Me...Action\Dal\DeleteAction`, `Synapse\Cmf\Framework\Me...Action\Dal\FormatAction`, `Synapse\Cmf\Framework\Me...Action\Dal\UpdateAction`, `Synapse\Cmf\Framework\Me...Action\Dal\UploadAction`, `Synapse\Cmf\Framework\Th...n\Command\DeleteCommand`, `Synapse\Cmf\Framework\Th...n\Command\UpdateCommand`, `Synapse\Cmf\Framework\Th...n\Command\UpdateCommand`, `Synapse\Cmf\Framework\Th...and\AddComponentCommand`, `Synapse\Cmf\Framework\Th...n\Command\UpdateCommand`, `Synapse\Page\Bundle\Action\Page\AbstractAction`, `Synapse\Page\Bundle\Action\Page\CreateAction`, `Synapse\Page\Bundle\Action\Page\DeleteAction`, `Synapse\Page\Bundle\Action\Page\UpdateAction`. Let’s take a look at an example: interface User { /** @return string / public function getPassword(); } class MyUser implements User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different implementation of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the interface: interface User { /** @return string / public function getPassword(); /* @return string */ public function getDisplayName(); } Loading history...
156		->createAction('edit')
157		->init($template)
158		->denormalize($arguments)
159		->resolve()
160		;
161		}
162
163		/**
164		* @see DomainInterface::delete()
165		*/
166		public function delete(TemplateInterface $template)
167		{
168		return $this->commandFactory
		0 ignored issues – show Bug introduced 2016-10-20 13:31 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Majora\Framework\Domain\Action\ActionInterface` as the method `init()` does only exist in the following implementations of said interface: `Majora\Framework\Domain\Action\AbstractAction`, `Synapse\Cmf\Framework\Me...e\Action\AbstractAction`, `Synapse\Cmf\Framework\Me...n\Dal\AbstractDalAction`, `Synapse\Cmf\Framework\Me...Action\Dal\CreateAction`, `Synapse\Cmf\Framework\Me...Action\Dal\UploadAction`, `Synapse\Cmf\Framework\Me...e\Action\AbstractAction`, `Synapse\Cmf\Framework\Me...n\Dal\AbstractDalAction`, `Synapse\Cmf\Framework\Me...Action\Dal\CreateAction`, `Synapse\Cmf\Framework\Me...Action\Dal\DeleteAction`, `Synapse\Cmf\Framework\Me...Action\Dal\UpdateAction`, `Synapse\Cmf\Framework\Me...e\Action\AbstractAction`, `Synapse\Cmf\Framework\Me...n\Dal\AbstractDalAction`, `Synapse\Cmf\Framework\Me...Action\Dal\CreateAction`, `Synapse\Cmf\Framework\Me...Action\Dal\DeleteAction`, `Synapse\Cmf\Framework\Me...Action\Dal\FormatAction`, `Synapse\Cmf\Framework\Me...Action\Dal\UpdateAction`, `Synapse\Cmf\Framework\Me...Action\Dal\UploadAction`, `Synapse\Cmf\Framework\Th...n\Command\DeleteCommand`, `Synapse\Cmf\Framework\Th...n\Command\UpdateCommand`, `Synapse\Cmf\Framework\Th...n\Command\UpdateCommand`, `Synapse\Cmf\Framework\Th...and\AddComponentCommand`, `Synapse\Cmf\Framework\Th...n\Command\UpdateCommand`, `Synapse\Page\Bundle\Action\Page\AbstractAction`, `Synapse\Page\Bundle\Action\Page\CreateAction`, `Synapse\Page\Bundle\Action\Page\DeleteAction`, `Synapse\Page\Bundle\Action\Page\UpdateAction`. Let’s take a look at an example: interface User { /** @return string / public function getPassword(); } class MyUser implements User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different implementation of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the interface: interface User { /** @return string / public function getPassword(); /* @return string */ public function getDisplayName(); } Loading history...
169		->createAction('delete')
170		->init($template)
171		->resolve()
172		;
173		}
174		}
175

Synapse-Cmf / synapse-cmf

Push — nyx-refactor-internal-api ( bc802c )

TemplateDomain::createGlobal() C

Complexity

Size

Duplication

Code Coverage

Importance

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like