ContactInformationFieldHelper::getEntityLevelContactInfoColumns() - Code Metrics - Inspection of "Merge remote-tracking branch 'remotes/dev/1.10' in..." - orocrm/crm - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — 1.10 ( c4e320...ea813f )

unknown

created 2016-10-20 13:59 UTC

getEntityLevelContactInfoColumns() A

↳ Parent: ContactInformationFieldHelper

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes

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

<?php

namespace OroCRM\Bundle\MarketingListBundle\Model;

use Oro\Component\PhpUtils\ArrayUtil;

use Oro\Bundle\EntityBundle\ORM\DoctrineHelper;
use Oro\Bundle\EntityBundle\Provider\EntityFieldProvider;
use Oro\Bundle\EntityConfigBundle\Provider\ConfigProvider;
use Oro\Bundle\QueryDesignerBundle\Model\AbstractQueryDesigner;
use Oro\Bundle\QueryDesignerBundle\QueryDesigner\JoinIdentifierHelper;

class ContactInformationFieldHelper
{
    /** @var ConfigProvider */
    protected $configProvider;

    /** @var array */
    protected $entityContactInfoColumns = array();

    /** @var DoctrineHelper */
    protected $doctrineHelper;

    /** @var EntityFieldProvider */
    protected $fieldProvider;

    /**
     * @param ConfigProvider $configProvider
     * @param DoctrineHelper $doctrineHelper
     * @param EntityFieldProvider $fieldProvider
     */
    public function __construct(
        ConfigProvider $configProvider,
        DoctrineHelper $doctrineHelper,
        EntityFieldProvider $fieldProvider
    ) {
        $this->configProvider = $configProvider;
        $this->doctrineHelper = $doctrineHelper;
        $this->fieldProvider = $fieldProvider;
    }

    /**
     * @deprecated since 1.9.9 to be removed in 2.0.0 use getQueryContactInformationFields instead.
     *
     * @param AbstractQueryDesigner $queryDesigner
     *
     * @return array
     */
    public function getQueryContactInformationColumns(AbstractQueryDesigner $queryDesigner)
    {
        return $this->getQueryContactInformationFields($queryDesigner);
    }

    /**
     * @param AbstractQueryDesigner $queryDesigner
     *
     * @return array
     */
    public function getQueryContactInformationFields(AbstractQueryDesigner $queryDesigner)
    {
        $fields = [];

        // If definition is empty there is no one contact information field
        $definition = $queryDesigner->getDefinition();
        if (!$definition) {
            return $fields;
        }

        $definition = json_decode($definition, JSON_OBJECT_AS_ARRAY);
        if (empty($definition['columns'])) {
            return $fields;
        }

        $entity = $queryDesigner->getEntity();
        foreach ($definition['columns'] as $column) {
            $contactInformationType = $this->getContactInformationFieldType($entity, $column['name']);
            if (!empty($contactInformationType)) {
                $fields[$contactInformationType][] = $column;
            }
        }

        return $fields;
    }

    /**
     * Get entity contact information fields.
     *
     * @deprecated since 1.9.9 to be removed in 2.0.0 use getEntityContactInformationFields instead.
     *
     * @param string|object $entity
     * @return array
     */
    public function getEntityContactInformationColumns($entity)
    {
        return $this->getEntityContactInformationFields($entity);
    }

    /**
     * Get entity contact information fields.
     *
     * @param string|object $entity
     * @return array
     */
    public function getEntityContactInformationFields($entity)
    {
        $metadata = $this->doctrineHelper->getEntityMetadata($entity);
        $fields = $metadata->getFieldNames();
        $contactInformationFields = [];
        foreach ($fields as $field) {
            if ($type = $this->getContactInformationFieldType($entity, $field)) {

                $contactInformationFields[$field] = $type;
            }
        }

        return array_merge($contactInformationFields, $this->getEntityLevelContactInfoFields($entity));

    }

    /**
     * @deprecated since 1.9.9 to be removed in 2.0.0 use getEntityContactInformationFieldsInfo instead.
     *
     * @param string $entity
     * @return array
     */
    public function getEntityContactInformationColumnsInfo($entity)
    {
        return $this->getEntityContactInformationFieldsInfo($entity);
    }

    /**
     * @param string $entity
     * @return array
     */
    public function getEntityContactInformationFieldsInfo($entity)
    {
        $fields = [];
        $contactInformationFields = $this->getEntityContactInformationFields($entity);
        $entityFields = $this->fieldProvider->getFields($entity, false, true);

        foreach ($entityFields as $entityField) {
            if (array_key_exists($entityField['name'], $contactInformationFields)) {
                $entityField['contact_information_type'] = $contactInformationFields[$entityField['name']];
                $fields[] = $entityField;
            }
        }

        return $fields;
    }

    /**
     * @param string $entity
     * @param string $fieldName
     * @return string|null
     */
    public function getContactInformationFieldType($entity, $fieldName)
    {
        $contactInformationType = null;
        $identifierHelper = new JoinIdentifierHelper($entity);
        $className = $identifierHelper->getEntityClassName($fieldName);
        $fieldName = $identifierHelper->getFieldName($fieldName);

        if (!array_key_exists($className, $this->entityContactInfoColumns)) {
            $this->entityContactInfoColumns[$className] = $this->getEntityLevelContactInfoFields($className);
        }

        if (!empty($this->entityContactInfoColumns[$className][$fieldName])) {
            $contactInformationType = $this->entityContactInfoColumns[$className][$fieldName];
        } elseif ($this->configProvider->hasConfig($className, $fieldName)) {
            $fieldConfiguration = $this->configProvider->getConfig($className, $fieldName);
            $contactInformationType = $fieldConfiguration->get('contact_information');
        }

        return $contactInformationType;
    }

    /**
     * @deprecated since 1.9.9 to be removed in 2.0.0 use getEntityLevelContactInfoFields instead.
     *
     * @param string $entity
     * @return array
     */
    protected function getEntityLevelContactInfoColumns($entity)
    {
        return $this->getEntityLevelContactInfoFields($entity);
    }

    /**
     * @param string $entity
     * @return array
     */
    protected function getEntityLevelContactInfoFields($entity)
    {
        $result = [];
        if ($this->configProvider->hasConfig($entity)) {
            $entityContactInformation = $this->configProvider
                ->getConfig($entity)
                ->get('contact_information');

            if ($entityContactInformation) {
                foreach ($entityContactInformation as $contactInfoType => $contactInfoFields) {
                    $entityColumns = ArrayUtil::arrayColumn($contactInfoFields, 'fieldName');
                    foreach ($entityColumns as $entityColumn) {
                        $result[$entityColumn] = $contactInfoType;
                    }
                }
            }
        }

        return $result;
    }
}


1			<?php
2
3			namespace OroCRM\Bundle\MarketingListBundle\Model;
4
5			use Oro\Component\PhpUtils\ArrayUtil;
6
7			use Oro\Bundle\EntityBundle\ORM\DoctrineHelper;
8			use Oro\Bundle\EntityBundle\Provider\EntityFieldProvider;
9			use Oro\Bundle\EntityConfigBundle\Provider\ConfigProvider;
10			use Oro\Bundle\QueryDesignerBundle\Model\AbstractQueryDesigner;
11			use Oro\Bundle\QueryDesignerBundle\QueryDesigner\JoinIdentifierHelper;
12
13			class ContactInformationFieldHelper
14			{
15			/** @var ConfigProvider */
16			protected $configProvider;
17
18			/** @var array */
19			protected $entityContactInfoColumns = array();
20
21			/** @var DoctrineHelper */
22			protected $doctrineHelper;
23
24			/** @var EntityFieldProvider */
25			protected $fieldProvider;
26
27			/**
28			* @param ConfigProvider $configProvider
29			* @param DoctrineHelper $doctrineHelper
30			* @param EntityFieldProvider $fieldProvider
31			*/
32			public function __construct(
33			ConfigProvider $configProvider,
34			DoctrineHelper $doctrineHelper,
35			EntityFieldProvider $fieldProvider
36			) {
37			$this->configProvider = $configProvider;
38			$this->doctrineHelper = $doctrineHelper;
39			$this->fieldProvider = $fieldProvider;
40			}
41
42			/**
43			* @deprecated since 1.9.9 to be removed in 2.0.0 use getQueryContactInformationFields instead.
44			*
45			* @param AbstractQueryDesigner $queryDesigner
46			*
47			* @return array
48			*/
49			public function getQueryContactInformationColumns(AbstractQueryDesigner $queryDesigner)
50			{
51			return $this->getQueryContactInformationFields($queryDesigner);
52			}
53
54			/**
55			* @param AbstractQueryDesigner $queryDesigner
56			*
57			* @return array
58			*/
59			public function getQueryContactInformationFields(AbstractQueryDesigner $queryDesigner)
60			{
61			$fields = [];
62
63			// If definition is empty there is no one contact information field
64			$definition = $queryDesigner->getDefinition();
65			if (!$definition) {
66			return $fields;
67			}
68
69			$definition = json_decode($definition, JSON_OBJECT_AS_ARRAY);
70			if (empty($definition['columns'])) {
71			return $fields;
72			}
73
74			$entity = $queryDesigner->getEntity();
75			foreach ($definition['columns'] as $column) {
76			$contactInformationType = $this->getContactInformationFieldType($entity, $column['name']);
77			if (!empty($contactInformationType)) {
78			$fields[$contactInformationType][] = $column;
79			}
80			}
81
82			return $fields;
83			}
84
85			/**
86			* Get entity contact information fields.
87			*
88			* @deprecated since 1.9.9 to be removed in 2.0.0 use getEntityContactInformationFields instead.
89			*
90			* @param string\|object $entity
91			* @return array
92			*/
93			public function getEntityContactInformationColumns($entity)
94			{
95			return $this->getEntityContactInformationFields($entity);
96			}
97
98			/**
99			* Get entity contact information fields.
100			*
101			* @param string\|object $entity
102			* @return array
103			*/
104			public function getEntityContactInformationFields($entity)
105			{
106			$metadata = $this->doctrineHelper->getEntityMetadata($entity);
107			$fields = $metadata->getFieldNames();
108			$contactInformationFields = [];
109			foreach ($fields as $field) {
110			if ($type = $this->getContactInformationFieldType($entity, $field)) {
			0 ignored issues – show Bug introduced 2016-10-20 14:25 UTC by Report Bug Copy Issue Report It seems like `$entity` defined by parameter `$entity` on line 104 can also be of type `object`; however, `OroCRM\Bundle\MarketingL...tInformationFieldType()` does only seem to accept `string`, maybe add an additional type check? This check looks at variables that have been passed in as parameters and are passed out again to other methods. If the outgoing method call has stricter type requirements than the method itself, an issue is raised. An additional type check may prevent trouble. Loading history...
111			$contactInformationFields[$field] = $type;
112			}
113			}
114
115			return array_merge($contactInformationFields, $this->getEntityLevelContactInfoFields($entity));
			0 ignored issues – show Bug introduced 2016-10-20 14:25 UTC by Report Bug Copy Issue Report It seems like `$entity` defined by parameter `$entity` on line 104 can also be of type `object`; however, `OroCRM\Bundle\MarketingL...evelContactInfoFields()` does only seem to accept `string`, maybe add an additional type check? This check looks at variables that have been passed in as parameters and are passed out again to other methods. If the outgoing method call has stricter type requirements than the method itself, an issue is raised. An additional type check may prevent trouble. Loading history...
116			}
117
118			/**
119			* @deprecated since 1.9.9 to be removed in 2.0.0 use getEntityContactInformationFieldsInfo instead.
120			*
121			* @param string $entity
122			* @return array
123			*/
124			public function getEntityContactInformationColumnsInfo($entity)
125			{
126			return $this->getEntityContactInformationFieldsInfo($entity);
127			}
128
129			/**
130			* @param string $entity
131			* @return array
132			*/
133			public function getEntityContactInformationFieldsInfo($entity)
134			{
135			$fields = [];
136			$contactInformationFields = $this->getEntityContactInformationFields($entity);
137			$entityFields = $this->fieldProvider->getFields($entity, false, true);
138
139			foreach ($entityFields as $entityField) {
140			if (array_key_exists($entityField['name'], $contactInformationFields)) {
141			$entityField['contact_information_type'] = $contactInformationFields[$entityField['name']];
142			$fields[] = $entityField;
143			}
144			}
145
146			return $fields;
147			}
148
149			/**
150			* @param string $entity
151			* @param string $fieldName
152			* @return string\|null
153			*/
154			public function getContactInformationFieldType($entity, $fieldName)
155			{
156			$contactInformationType = null;
157			$identifierHelper = new JoinIdentifierHelper($entity);
158			$className = $identifierHelper->getEntityClassName($fieldName);
159			$fieldName = $identifierHelper->getFieldName($fieldName);
160
161			if (!array_key_exists($className, $this->entityContactInfoColumns)) {
162			$this->entityContactInfoColumns[$className] = $this->getEntityLevelContactInfoFields($className);
163			}
164
165			if (!empty($this->entityContactInfoColumns[$className][$fieldName])) {
166			$contactInformationType = $this->entityContactInfoColumns[$className][$fieldName];
167			} elseif ($this->configProvider->hasConfig($className, $fieldName)) {
168			$fieldConfiguration = $this->configProvider->getConfig($className, $fieldName);
169			$contactInformationType = $fieldConfiguration->get('contact_information');
170			}
171
172			return $contactInformationType;
173			}
174
175			/**
176			* @deprecated since 1.9.9 to be removed in 2.0.0 use getEntityLevelContactInfoFields instead.
177			*
178			* @param string $entity
179			* @return array
180			*/
181			protected function getEntityLevelContactInfoColumns($entity)
182			{
183			return $this->getEntityLevelContactInfoFields($entity);
184			}
185
186			/**
187			* @param string $entity
188			* @return array
189			*/
190			protected function getEntityLevelContactInfoFields($entity)
191			{
192			$result = [];
193			if ($this->configProvider->hasConfig($entity)) {
194			$entityContactInformation = $this->configProvider
195			->getConfig($entity)
196			->get('contact_information');
197
198			if ($entityContactInformation) {
199			foreach ($entityContactInformation as $contactInfoType => $contactInfoFields) {
200			$entityColumns = ArrayUtil::arrayColumn($contactInfoFields, 'fieldName');
201			foreach ($entityColumns as $entityColumn) {
202			$result[$entityColumn] = $contactInfoType;
203			}
204			}
205			}
206			}
207
208			return $result;
209			}
210			}
211

orocrm / crm

Push — 1.10 ( c4e320...ea813f )

getEntityLevelContactInfoColumns() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like