MixinStrategy::getPrimaryNodeType() - Code Metrics - Inspection of "Query builder" - sulu-io/sulu-document-manager - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#33)

by Daniel

created 2015-12-09 14:15 UTC

MixinStrategy::getPrimaryNodeType() A

↳ Parent: MixinStrategy

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
c	1
b	0
f	0
dl	0
loc	4
rs	10
cc	1
eloc	2
nc	1
nop	1

<?php

/*
 * This file is part of Sulu.
 *
 * (c) MASSIVE ART WebServices GmbH
 *
 * This source file is subject to the MIT license that is bundled
 * with this source code in the file LICENSE.
 */

namespace Sulu\Component\DocumentManager\Strategy;

use PHPCR\NodeInterface;
use PHPCR\Query\QOM\QueryObjectModelConstantsInterface as QOMConstants;
use PHPCR\Query\QOM\QueryObjectModelFactoryInterface;
use PHPCR\Util\UUIDHelper;
use Sulu\Component\DocumentManager\DocumentStrategyInterface;
use Sulu\Component\DocumentManager\MetadataFactoryInterface;

/**
 * Manage nodes via. a jcr mixin.
 */
class MixinStrategy implements DocumentStrategyInterface
{
    /**
     * @var MetadataFactoryInterface
     */
    private $metadataFactory;

    /**
     * @param MetadataFactoryInterface $metadataFactory
     */
    public function __construct(MetadataFactoryInterface $metadataFactory)
    {
        $this->metadataFactory = $metadataFactory;
    }

    /**
     * {@inheritdoc}
     */
    public function createNodeForDocument($document, NodeInterface $parentNode, $name)
    {
        $metadata = $this->metadataFactory->getMetadataForClass(get_class($document));

        $node = $parentNode->addNode($name);
        $node->addMixin($metadata->getPhpcrType());
        $node->setProperty('jcr:uuid', UUIDHelper::generateUUID());

        return $node;
    }

    /**
     * {@inheritdoc}
     */
    public function resolveMetadataForNode(NodeInterface $node)
    {
        if (false === $node->hasProperty('jcr:mixinTypes')) {
            return;
        }

        $mixinTypes = (array) $node->getPropertyValue('jcr:mixinTypes');

        foreach ($mixinTypes as $mixinType) {
            if (true == $this->metadataFactory->hasMetadataForPhpcrType($mixinType)) {

                return $this->metadataFactory->getMetadataForPhpcrType($mixinType);
            }
        }

        return;
    }

    /**
     * {@inheritdoc}
     */
    public function getPrimaryNodeType($classFqn)
    {
        return 'nt:unstructured';
    }

    /**
     * {@inheritdoc}
     */
    public function createSourceConstraint(QueryObjectModelFactoryInterface $qomf, $sourceAlias, $classFqn)
    {
        $metadata = $this->metadataFactory->getMetadataForClass($classFqn);

        return $qomf->comparison(
class Author {
    private $name;

    public function __construct($name) {
        $this->name = $name;
    }

    public function getName() {
        return $this->name;
    }
}

abstract class Post {
    public function getAuthor() {
        return 'Johannes';
    }
}

class BlogPost extends Post {
    public function getAuthor() {
        return new Author('Johannes');
    }
}

class ForumPost extends Post { /* ... */ }

function my_function(Post $post) {
    echo strtoupper($post->getAuthor());
}
            $qomf->propertyValue(
                $sourceAlias,
                'jcr:mixinTypes'
            ),
            QOMConstants::JCR_OPERATOR_EQUAL_TO,
            $qomf->literal($metadata->getPhpcrType())
        );
    }
}


1			<?php
2
3			/*
4			* This file is part of Sulu.
5			*
6			* (c) MASSIVE ART WebServices GmbH
7			*
8			* This source file is subject to the MIT license that is bundled
9			* with this source code in the file LICENSE.
10			*/
11
12			namespace Sulu\Component\DocumentManager\Strategy;
13
14			use PHPCR\NodeInterface;
15			use PHPCR\Query\QOM\QueryObjectModelConstantsInterface as QOMConstants;
16			use PHPCR\Query\QOM\QueryObjectModelFactoryInterface;
17			use PHPCR\Util\UUIDHelper;
18			use Sulu\Component\DocumentManager\DocumentStrategyInterface;
19			use Sulu\Component\DocumentManager\MetadataFactoryInterface;
20
21			/**
22			* Manage nodes via. a jcr mixin.
23			*/
24			class MixinStrategy implements DocumentStrategyInterface
25			{
26			/**
27			* @var MetadataFactoryInterface
28			*/
29			private $metadataFactory;
30
31			/**
32			* @param MetadataFactoryInterface $metadataFactory
33			*/
34			public function __construct(MetadataFactoryInterface $metadataFactory)
35			{
36			$this->metadataFactory = $metadataFactory;
37			}
38
39			/**
40			* {@inheritdoc}
41			*/
42			public function createNodeForDocument($document, NodeInterface $parentNode, $name)
43			{
44			$metadata = $this->metadataFactory->getMetadataForClass(get_class($document));
45
46			$node = $parentNode->addNode($name);
47			$node->addMixin($metadata->getPhpcrType());
48			$node->setProperty('jcr:uuid', UUIDHelper::generateUUID());
49
50			return $node;
51			}
52
53			/**
54			* {@inheritdoc}
55			*/
56			public function resolveMetadataForNode(NodeInterface $node)
57			{
58			if (false === $node->hasProperty('jcr:mixinTypes')) {
59			return;
60			}
61
62			$mixinTypes = (array) $node->getPropertyValue('jcr:mixinTypes');
63
64			foreach ($mixinTypes as $mixinType) {
65			if (true == $this->metadataFactory->hasMetadataForPhpcrType($mixinType)) {
			0 ignored issues – show Coding Style Best Practice introduced 2015-12-01 15:26 UTC by Report Bug Copy Issue Report It seems like you are loosely comparing two booleans. Considering using the strict comparison `===` instead. When comparing two booleans, it is generally considered safer to use the strict comparison operator. Loading history...
66			return $this->metadataFactory->getMetadataForPhpcrType($mixinType);
67			}
68			}
69
70			return;
71			}
72
73			/**
74			* {@inheritdoc}
75			*/
76			public function getPrimaryNodeType($classFqn)
77			{
78			return 'nt:unstructured';
79			}
80
81			/**
82			* {@inheritdoc}
83			*/
84			public function createSourceConstraint(QueryObjectModelFactoryInterface $qomf, $sourceAlias, $classFqn)
85			{
86			$metadata = $this->metadataFactory->getMetadataForClass($classFqn);
87
88			return $qomf->comparison(
			0 ignored issues – show Bug Best Practice introduced 2015-12-09 14:07 UTC by Report Bug Copy Issue Report The return type of `return $qomf->comparison...data->getPhpcrType()));` (`PHPCR\Query\QOM\ComparisonInterface`) is incompatible with the return type declared by the interface `Sulu\Component\DocumentM...:createSourceConstraint` of type `Sulu\Component\DocumentM...QOM\ConstraintInterface`. If you return a value from a function or method, it should be a sub-type of the type that is given by the parent type f.e. an interface, or abstract method. This is more formally defined by the Lizkov substitution principle, and guarantees that classes that depend on the parent type can use any instance of a child type interchangably. This principle also belongs to the SOLID principles for object oriented design. Let’s take a look at an example: class Author { private $name; public function __construct($name) { $this->name = $name; } public function getName() { return $this->name; } } abstract class Post { public function getAuthor() { return 'Johannes'; } } class BlogPost extends Post { public function getAuthor() { return new Author('Johannes'); } } class ForumPost extends Post { /* ... */ } function my_function(Post $post) { echo strtoupper($post->getAuthor()); } Our function `my_function` expects a `Post` object, and outputs the author of the post. The base class `Post` returns a simple string and outputting a simple string will work just fine. However, the child class `BlogPost` which is a sub-type of `Post` instead decided to return an `object`, and is therefore violating the SOLID principles. If a `BlogPost` were passed to `my_function`, PHP would not complain, but ultimately fail when executing the `strtoupper` call in its body. Loading history...
89			$qomf->propertyValue(
90			$sourceAlias,
91			'jcr:mixinTypes'
92			),
93			QOMConstants::JCR_OPERATOR_EQUAL_TO,
94			$qomf->literal($metadata->getPhpcrType())
95			);
96			}
97			}
98

sulu-io / sulu-document-manager

Pull Request — master (#33)

MixinStrategy::getPrimaryNodeType() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like