Issues in AddToEntityInstantiatorBehavior.php - New Issues - Inspection of "Merge branch 'issue_2'" - bazzline/php_propel_behavior_entity_instantiator - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( a97445...ea780c )

by arto

created 2017-11-07 15:12 UTC

source/AddToEntityInstantiatorBehavior.php (2 issues)

Labels

Duplication 2

Severity

Informational 2

Upgrade to new PHP Analysis Engine

These results are based on our legacy PHP analysis, consider migrating to our new PHP analysis engine instead. Learn more

<?php

use Net\Bazzline\Propel\Behavior\EntityInstantiator\Manager;
use Net\Bazzline\Propel\Behavior\EntityInstantiator\ObjectEntity;
use Net\Bazzline\Propel\Behavior\EntityInstantiator\QueryEntity;

//@todo do we need this if dependencies are managed via composer and composer autoloader?
$pathToClasses = __DIR__ . '/';

require_once($pathToClasses . 'AbstractEntity.php');
require_once($pathToClasses . 'Configuration.php');
require_once($pathToClasses . 'EntityCollection.php');
require_once($pathToClasses . 'FileContentGenerator.php');
require_once($pathToClasses . 'Manager.php');
require_once($pathToClasses . 'ObjectEntity.php');
require_once($pathToClasses . 'QueryEntity.php');

/**
 * @author stev leibelt <[email protected]>
 * @since 2015-08-02
 * @todo make parameters optional (only set them when they are set) - this would enable it to define everything in the database scope and the rest in the table scope without overwriting database scoped things
 */
class AddToEntityInstantiatorBehavior extends Behavior
{
    const PARAMETER_ENTITY_INSTANTIATOR_ADD_IT_TO_ENTITY_INSTANTIATOR   = 'entity_instantiator_add_to_entity_instantiator';
    const PARAMETER_ENTITY_INSTANTIATOR_DEFAULT_CONNECTION_MODE         = 'entity_instantiator_default_connection_mode';
    const PARAMETER_ENTITY_INSTANTIATOR_DEFAULT_CONNECTION_NAME         = 'entity_instantiator_default_connection_name';
    const PARAMETER_ENTITY_INSTANTIATOR_CLASS_NAME                      = 'entity_instantiator_class_name';
    const PARAMETER_ENTITY_INSTANTIATOR_EXTENDS                         = 'entity_instantiator_extends';
    const PARAMETER_ENTITY_INSTANTIATOR_INDENTION                       = 'entity_instantiator_indention';
    const PARAMETER_ENTITY_INSTANTIATOR_METHOD_NAME_PREFIX              = 'entity_instantiator_method_name_prefix';
    const PARAMETER_ENTITY_INSTANTIATOR_NAMESPACE                       = 'entity_instantiator_namespace';
    const PARAMETER_ENTITY_INSTANTIATOR_PATH_TO_OUTPUT                  = 'entity_instantiator_path_to_output';
    const PARAMETER_ENTITY_INSTANTIATOR_USE_FULLY_QUALIFIED_NAME        = 'entity_instantiator_use_fully_qualified_name';

    /** @var array */
    protected $parameters = [
        self::PARAMETER_ENTITY_INSTANTIATOR_ADD_IT_TO_ENTITY_INSTANTIATOR   => 'true',
        self::PARAMETER_ENTITY_INSTANTIATOR_DEFAULT_CONNECTION_MODE         => null,
        self::PARAMETER_ENTITY_INSTANTIATOR_DEFAULT_CONNECTION_NAME         => null,
        self::PARAMETER_ENTITY_INSTANTIATOR_CLASS_NAME                      => 'DatabaseEntityInstantiator',
        self::PARAMETER_ENTITY_INSTANTIATOR_INDENTION                       => '    ',
        self::PARAMETER_ENTITY_INSTANTIATOR_METHOD_NAME_PREFIX              => null,
        self::PARAMETER_ENTITY_INSTANTIATOR_NAMESPACE                       => null,
        self::PARAMETER_ENTITY_INSTANTIATOR_PATH_TO_OUTPUT                  => 'data',
        self::PARAMETER_ENTITY_INSTANTIATOR_USE_FULLY_QUALIFIED_NAME        => 'false'
    ];



    /**
     * @param DataModelBuilder $builder
     * @return string
     * @throws InvalidArgumentException
     */
    public function queryMethods($builder)
    {
        $this->addQueryToGenerator($builder);

        return '';
    }



    /**
     * @param DataModelBuilder $builder
     * @return string
     * @throws InvalidArgumentException
     */
    public function objectMethods($builder)
    {
        $this->addObjectToGenerator($builder);

        return '';
    }

    /**
     * @param DataModelBuilder $builder
     * @throws InvalidArgumentException
     */
    public function addObjectToGenerator(DataModelBuilder $builder)

    {
        if ($this->addIt()) {
            $manager    = $this->getManager();
            $entity     = $this->buildEntityFromObject($builder);
            $manager->add($entity);
        }
    }

    /**
     * @param DataModelBuilder $builder
     * @throws InvalidArgumentException
     */
    public function addQueryToGenerator(DataModelBuilder $builder)

    {
        if ($this->addIt()) {
            $manager    = $this->getManager();
            $entity     = $this->buildEntityFromQuery($builder);
            $manager->add($entity);
        }
    }

    /**
     * @param DataModelBuilder $builder
     * @return ObjectEntity
     */
    private function buildEntityFromObject(DataModelBuilder $builder)
    {
        $methodNamePrefix = $this->returnDatabaseNameIfMethodNamePrefixIsNotProvided($builder);

        return new ObjectEntity(
            $builder->getStubObjectBuilder()->getClassname(),
            $builder->getDatabase()->getName(),
            $builder->getStubObjectBuilder()->getFullyQualifiedClassname(),
            $methodNamePrefix
        );
    }

    /**
     * @param DataModelBuilder $builder
     * @return QueryEntity
     */
    private function buildEntityFromQuery(DataModelBuilder $builder)
    {
        $methodNamePrefix = $this->returnDatabaseNameIfMethodNamePrefixIsNotProvided($builder);

        return new QueryEntity(
            $builder->getStubQueryBuilder()->getClassname(),
            $builder->getDatabase()->getName(),
            $builder->getStubQueryBuilder()->getFullyQualifiedClassname(),
            $methodNamePrefix
        );
    }

    /**
     * @param DataModelBuilder $builder
     * @return string
     */
    private function returnDatabaseNameIfMethodNamePrefixIsNotProvided(DataModelBuilder $builder)
    {
        $methodNamePrefix = (is_null($this->parameters[self::PARAMETER_ENTITY_INSTANTIATOR_METHOD_NAME_PREFIX]))
            ? 'create' . ucfirst($builder->getDatabase()->getName())
            : $this->parameters[self::PARAMETER_ENTITY_INSTANTIATOR_METHOD_NAME_PREFIX];

        return $methodNamePrefix;
    }

    /**
     * @return Manager
     * @throws InvalidArgumentException
     */
    private function getManager()
    {
        $manager = Manager::getInstance();

        if ($manager->isNotConfigured()) {
            $pathToOutput   = $this->parameters[self::PARAMETER_ENTITY_INSTANTIATOR_PATH_TO_OUTPUT];
            $isAbsolutePath = (strncmp($pathToOutput, DIRECTORY_SEPARATOR, strlen(DIRECTORY_SEPARATOR)) === 0);    //like /foo/bar
            $isResource     = (strpos($pathToOutput, '://') !== false);  //like vfs://

            $isAbsolutePathOrResource   = ($isAbsolutePath || $isResource);

            $absolutePathToOutput   = ($isAbsolutePathOrResource)
                ? $pathToOutput
                : getcwd() . (str_repeat(DIRECTORY_SEPARATOR . '..', 4)) . DIRECTORY_SEPARATOR . $pathToOutput;
            $className              = $this->parameters[self::PARAMETER_ENTITY_INSTANTIATOR_CLASS_NAME];
            $defaultConnectionMode  = $this->parameters[self::PARAMETER_ENTITY_INSTANTIATOR_DEFAULT_CONNECTION_MODE];
            $defaultConnectionName  = $this->parameters[self::PARAMETER_ENTITY_INSTANTIATOR_DEFAULT_CONNECTION_NAME];
            $extends                = $this->parameters[self::PARAMETER_ENTITY_INSTANTIATOR_EXTENDS];
            $indention              = $this->parameters[self::PARAMETER_ENTITY_INSTANTIATOR_INDENTION];
            $namespace              = $this->parameters[self::PARAMETER_ENTITY_INSTANTIATOR_NAMESPACE];
            $useFullyQualifiedName  = ($this->parameters[self::PARAMETER_ENTITY_INSTANTIATOR_USE_FULLY_QUALIFIED_NAME] === 'true');

            $manager->configure(
                $className,
                $indention,
                $absolutePathToOutput,
                $namespace,
                $extends,
                $defaultConnectionMode,
                $defaultConnectionName,
                $useFullyQualifiedName
            );
        }

        return $manager;
    }

    /**
     * @return bool
     */
    private function addIt()
    {
        return (isset($this->parameters[self::PARAMETER_ENTITY_INSTANTIATOR_ADD_IT_TO_ENTITY_INSTANTIATOR]))
            ? ($this->parameters[self::PARAMETER_ENTITY_INSTANTIATOR_ADD_IT_TO_ENTITY_INSTANTIATOR] === 'true')
            : false;
    }
}


1		<?php
2
3		use Net\Bazzline\Propel\Behavior\EntityInstantiator\Manager;
4		use Net\Bazzline\Propel\Behavior\EntityInstantiator\ObjectEntity;
5		use Net\Bazzline\Propel\Behavior\EntityInstantiator\QueryEntity;
6
7		//@todo do we need this if dependencies are managed via composer and composer autoloader?
8		$pathToClasses = __DIR__ . '/';
9
10		require_once($pathToClasses . 'AbstractEntity.php');
11		require_once($pathToClasses . 'Configuration.php');
12		require_once($pathToClasses . 'EntityCollection.php');
13		require_once($pathToClasses . 'FileContentGenerator.php');
14		require_once($pathToClasses . 'Manager.php');
15		require_once($pathToClasses . 'ObjectEntity.php');
16		require_once($pathToClasses . 'QueryEntity.php');
17
18		/**
19		* @author stev leibelt <[email protected]>
20		* @since 2015-08-02
21		* @todo make parameters optional (only set them when they are set) - this would enable it to define everything in the database scope and the rest in the table scope without overwriting database scoped things
22		*/
23		class AddToEntityInstantiatorBehavior extends Behavior
24		{
25		const PARAMETER_ENTITY_INSTANTIATOR_ADD_IT_TO_ENTITY_INSTANTIATOR = 'entity_instantiator_add_to_entity_instantiator';
26		const PARAMETER_ENTITY_INSTANTIATOR_DEFAULT_CONNECTION_MODE = 'entity_instantiator_default_connection_mode';
27		const PARAMETER_ENTITY_INSTANTIATOR_DEFAULT_CONNECTION_NAME = 'entity_instantiator_default_connection_name';
28		const PARAMETER_ENTITY_INSTANTIATOR_CLASS_NAME = 'entity_instantiator_class_name';
29		const PARAMETER_ENTITY_INSTANTIATOR_EXTENDS = 'entity_instantiator_extends';
30		const PARAMETER_ENTITY_INSTANTIATOR_INDENTION = 'entity_instantiator_indention';
31		const PARAMETER_ENTITY_INSTANTIATOR_METHOD_NAME_PREFIX = 'entity_instantiator_method_name_prefix';
32		const PARAMETER_ENTITY_INSTANTIATOR_NAMESPACE = 'entity_instantiator_namespace';
33		const PARAMETER_ENTITY_INSTANTIATOR_PATH_TO_OUTPUT = 'entity_instantiator_path_to_output';
34		const PARAMETER_ENTITY_INSTANTIATOR_USE_FULLY_QUALIFIED_NAME = 'entity_instantiator_use_fully_qualified_name';
35
36		/** @var array */
37		protected $parameters = [
38		self::PARAMETER_ENTITY_INSTANTIATOR_ADD_IT_TO_ENTITY_INSTANTIATOR => 'true',
39		self::PARAMETER_ENTITY_INSTANTIATOR_DEFAULT_CONNECTION_MODE => null,
40		self::PARAMETER_ENTITY_INSTANTIATOR_DEFAULT_CONNECTION_NAME => null,
41		self::PARAMETER_ENTITY_INSTANTIATOR_CLASS_NAME => 'DatabaseEntityInstantiator',
42		self::PARAMETER_ENTITY_INSTANTIATOR_INDENTION => ' ',
43		self::PARAMETER_ENTITY_INSTANTIATOR_METHOD_NAME_PREFIX => null,
44		self::PARAMETER_ENTITY_INSTANTIATOR_NAMESPACE => null,
45		self::PARAMETER_ENTITY_INSTANTIATOR_PATH_TO_OUTPUT => 'data',
46		self::PARAMETER_ENTITY_INSTANTIATOR_USE_FULLY_QUALIFIED_NAME => 'false'
47		];
48
49
50
51		/**
52		* @param DataModelBuilder $builder
53		* @return string
54		* @throws InvalidArgumentException
55		*/
56		public function queryMethods($builder)
57		{
58		$this->addQueryToGenerator($builder);
59
60		return '';
61		}
62
63
64
65		/**
66		* @param DataModelBuilder $builder
67		* @return string
68		* @throws InvalidArgumentException
69		*/
70		public function objectMethods($builder)
71		{
72		$this->addObjectToGenerator($builder);
73
74		return '';
75		}
76
77		/**
78		* @param DataModelBuilder $builder
79		* @throws InvalidArgumentException
80		*/
81	View Code Duplication	public function addObjectToGenerator(DataModelBuilder $builder)
		0 ignored issues – show Duplication introduced 2017-11-07 15:23 UTC by Report Bug Copy Issue Report Show Similar Issues like this This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
82		{
83		if ($this->addIt()) {
84		$manager = $this->getManager();
85		$entity = $this->buildEntityFromObject($builder);
86		$manager->add($entity);
87		}
88		}
89
90		/**
91		* @param DataModelBuilder $builder
92		* @throws InvalidArgumentException
93		*/
94	View Code Duplication	public function addQueryToGenerator(DataModelBuilder $builder)
		0 ignored issues – show Duplication introduced 2017-11-07 15:23 UTC by Report Bug Copy Issue Report Show Similar Issues like this This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
95		{
96		if ($this->addIt()) {
97		$manager = $this->getManager();
98		$entity = $this->buildEntityFromQuery($builder);
99		$manager->add($entity);
100		}
101		}
102
103		/**
104		* @param DataModelBuilder $builder
105		* @return ObjectEntity
106		*/
107		private function buildEntityFromObject(DataModelBuilder $builder)
108		{
109		$methodNamePrefix = $this->returnDatabaseNameIfMethodNamePrefixIsNotProvided($builder);
110
111		return new ObjectEntity(
112		$builder->getStubObjectBuilder()->getClassname(),
113		$builder->getDatabase()->getName(),
114		$builder->getStubObjectBuilder()->getFullyQualifiedClassname(),
115		$methodNamePrefix
116		);
117		}
118
119		/**
120		* @param DataModelBuilder $builder
121		* @return QueryEntity
122		*/
123		private function buildEntityFromQuery(DataModelBuilder $builder)
124		{
125		$methodNamePrefix = $this->returnDatabaseNameIfMethodNamePrefixIsNotProvided($builder);
126
127		return new QueryEntity(
128		$builder->getStubQueryBuilder()->getClassname(),
129		$builder->getDatabase()->getName(),
130		$builder->getStubQueryBuilder()->getFullyQualifiedClassname(),
131		$methodNamePrefix
132		);
133		}
134
135		/**
136		* @param DataModelBuilder $builder
137		* @return string
138		*/
139		private function returnDatabaseNameIfMethodNamePrefixIsNotProvided(DataModelBuilder $builder)
140		{
141		$methodNamePrefix = (is_null($this->parameters[self::PARAMETER_ENTITY_INSTANTIATOR_METHOD_NAME_PREFIX]))
142		? 'create' . ucfirst($builder->getDatabase()->getName())
143		: $this->parameters[self::PARAMETER_ENTITY_INSTANTIATOR_METHOD_NAME_PREFIX];
144
145		return $methodNamePrefix;
146		}
147
148		/**
149		* @return Manager
150		* @throws InvalidArgumentException
151		*/
152		private function getManager()
153		{
154		$manager = Manager::getInstance();
155
156		if ($manager->isNotConfigured()) {
157		$pathToOutput = $this->parameters[self::PARAMETER_ENTITY_INSTANTIATOR_PATH_TO_OUTPUT];
158		$isAbsolutePath = (strncmp($pathToOutput, DIRECTORY_SEPARATOR, strlen(DIRECTORY_SEPARATOR)) === 0); //like /foo/bar
159		$isResource = (strpos($pathToOutput, '://') !== false); //like vfs://
160
161		$isAbsolutePathOrResource = ($isAbsolutePath \|\| $isResource);
162
163		$absolutePathToOutput = ($isAbsolutePathOrResource)
164		? $pathToOutput
165		: getcwd() . (str_repeat(DIRECTORY_SEPARATOR . '..', 4)) . DIRECTORY_SEPARATOR . $pathToOutput;
166		$className = $this->parameters[self::PARAMETER_ENTITY_INSTANTIATOR_CLASS_NAME];
167		$defaultConnectionMode = $this->parameters[self::PARAMETER_ENTITY_INSTANTIATOR_DEFAULT_CONNECTION_MODE];
168		$defaultConnectionName = $this->parameters[self::PARAMETER_ENTITY_INSTANTIATOR_DEFAULT_CONNECTION_NAME];
169		$extends = $this->parameters[self::PARAMETER_ENTITY_INSTANTIATOR_EXTENDS];
170		$indention = $this->parameters[self::PARAMETER_ENTITY_INSTANTIATOR_INDENTION];
171		$namespace = $this->parameters[self::PARAMETER_ENTITY_INSTANTIATOR_NAMESPACE];
172		$useFullyQualifiedName = ($this->parameters[self::PARAMETER_ENTITY_INSTANTIATOR_USE_FULLY_QUALIFIED_NAME] === 'true');
173
174		$manager->configure(
175		$className,
176		$indention,
177		$absolutePathToOutput,
178		$namespace,
179		$extends,
180		$defaultConnectionMode,
181		$defaultConnectionName,
182		$useFullyQualifiedName
183		);
184		}
185
186		return $manager;
187		}
188
189		/**
190		* @return bool
191		*/
192		private function addIt()
193		{
194		return (isset($this->parameters[self::PARAMETER_ENTITY_INSTANTIATOR_ADD_IT_TO_ENTITY_INSTANTIATOR]))
195		? ($this->parameters[self::PARAMETER_ENTITY_INSTANTIATOR_ADD_IT_TO_ENTITY_INSTANTIATOR] === 'true')
196		: false;
197		}
198		}
199

bazzline / php_propel_behavior_entity_instantiator

Push — master ( a97445...ea780c )

source/AddToEntityInstantiatorBehavior.php (2 issues)

Labels

Severity

Introduced By

Upgrade to new PHP Analysis Engine

Duplication Side-by-Side

Filter issues like