Generic::primary() - Code Metrics - samsoncms/api - Measure and Improve Code Quality continuously with Scrutinizer

Generic::primary() A
last analyzed 2016-10-05 09:42 UTC

↳ Parent: Generic

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	2

<?php declare(strict_types=1);
/**
 * Created by PhpStorm.
 * User: VITALYIEGOROV
 * Date: 08.12.15
 * Time: 23:11
 */
namespace samsoncms\api\query;

use samsoncms\api\generated\Material;
use samsonframework\orm\ArgumentInterface;

/**
 * TODO: We have create a Record class that lays behind Entity-Generic and we store entity fields in fieldIDs static variable
 * which cannot be accessed in parent function calls like orderBy, applySorting, to get intermediary static class variables
 * from Generic class. This affect code duplication of method in Record to Generic to give access to static class fields
 * described in fieldIDs.
 */

/**
 * Material with additional fields query.
 *
 * @package samsoncms\api
 */
class Generic extends Record
{
    /** @var string Table class name */
    public static $identifier = Material::class;

    /** @var string Database table name */
    public static $tableName = 'material';

    /** @var string Table primary field name */
    public static $primaryFieldName = Material::F_PRIMARY;

       /** @var array Collection of all supported entity fields */
    public static $fieldIDs = array(
        Material::F_PRIMARY=> Material::F_PRIMARY,
        Material::F_PRIORITY => Material::F_PRIORITY,
        Material::F_URL => Material::F_URL,
        Material::F_DELETION => Material::F_DELETION,
        Material::F_PUBLISHED => Material::F_PUBLISHED,
        Material::F_PARENTID => Material::F_PARENTID,
        Material::F_CREATED => Material::F_CREATED,
        Material::F_MODYFIED => Material::F_MODYFIED,
    );

    /** @var array Collection of all supported entity fields */
    public static $fieldNames = array(
        Material::F_PRIMARY => Material::F_PRIMARY,
        Material::F_PRIORITY => Material::F_PRIORITY,
        Material::F_URL => Material::F_URL,
        Material::F_DELETION => Material::F_DELETION,
        Material::F_PUBLISHED => Material::F_PUBLISHED,
        Material::F_PARENTID => Material::F_PARENTID,
        Material::F_CREATED => Material::F_CREATED,
        Material::F_MODYFIED => Material::F_MODYFIED
    );

    /** @var array Collection of entity field types */
    public static $fieldTypes = [
        'MaterialID' => 'int',
        'parent_id' => 'int',
        'priority' => 'int',
        'Name' => 'string',
        'Url' => 'string',
        'Created' => 'int',
        'Modyfied' => 'int',
        'UserID' => 'int',
        'Draft' => 'int',
        'type' => 'int',
        'Published' => 'int',
        'Active' => 'int',
        'system' => 'int',
        'remains' => 'float',
    ];

    /** @var array Collection of entity field database types */
    public static $fieldDataTypes = [
        'MaterialID' => 'int',
        'parent_id' => 'int',
        'priority' => 'int',
        'Name' => 'varchar',
        'Url' => 'varchar',
        'Created' => 'datetime',
        'Modyfied' => 'timestamp',
        'UserID' => 'int',
        'Draft' => 'int',
        'type' => 'int',
        'Published' => 'int',
        'Active' => 'int',
        'system' => 'int',
        'remains' => 'float',
    ];

    /** @var array Collection of entity field database default values */
    public static $fieldDefaults = [
        'MaterialID' => '',
        'parent_id' => '',
        'priority' => 0,
        'Name' => '',
        'Url' => '',
        'Created' => '',
        'Modyfied' => 'CURRENT_TIMESTAMP',
        'UserID' => '',
        'Draft' => 0,
        'type' => 0,
        'Published' => '',
        'Active' => '',
        'system' => 0,
        'remains' => 0,
    ];

    /** @var array Collection of entity field database is nullable values */
    public static $fieldNullable = [
        'MaterialID' => 'NO',
        'parent_id' => 'YES',
        'priority' => 'NO',
        'Name' => 'NO',
        'Url' => 'NO',
        'Created' => 'YES',
        'Modyfied' => 'NO',
        'UserID' => 'YES',
        'Draft' => 'NO',
        'type' => 'NO',
        'Published' => 'YES',
        'Active' => 'YES',
        'system' => 'NO',
        'remains' => 'NO',
    ];

    /** @var string Entity navigation identifiers */
    public static $navigationIDs = array();

    /**
     * Add primary field query condition.
     *
     * @param string $value Field value
     * @param string $relation @see ArgumentInterface types
     *
     * @return $this Chaining
     * @see Material::where()
     */
    public function primary($value, $relation = ArgumentInterface::EQUAL)
    {
        return $this->where(Material::F_PRIMARY, $value, $relation);
    }

    /**
     * Add identifier field query condition.
     *
     * @param string $value Field value
     * @param string $relation @see ArgumentInterface types
     *
     * @return $this Chaining
     * @see Material::where()
     */
    public function identifier($value, $relation = ArgumentInterface::EQUAL)
    {
        return $this->where(Material::F_URL, $value, $relation);
    }

    /**
     * Add active flag condition.
     *
     * @param bool $value Field value
     * @param string $relation @see ArgumentInterface types
     *
     * @return $this Chaining
     * @see Material::where()
     */
    public function active($value, $relation = ArgumentInterface::EQUAL)
    {
        return $this->where(Material::F_ACTIVE, $value, $relation);
    }

    /**
     * Add entity published field query condition.
     *
     * @param string $value Field value
     * @param string $relation @see ArgumentInterface types
     *
     * @return $this Chaining
     * @see Material::where()
     */
    public function published($value, $relation = ArgumentInterface::EQUAL)
    {
        return $this->where(Material::F_PUBLISHED, $value, $relation);
    }

    /**
     * Add entity creation field query condition.
     *
     * @param string $value Field value
     * @param string $relation @see ArgumentInterface types
     *
     * @return $this Chaining
     * @see Material::where()
     */
    public function created($value, $relation = ArgumentInterface::EQUAL)
    {
        return $this->where(Material::F_CREATED, $this->convertToDateTime($value), $relation);
    }

    /**
     * Add entity modification field query condition.
     *
     * @param string $value Field value
     * @param string $relation @see ArgumentInterface types
     * @return $this Chaining
     * @see Material::where()
     */
    public function modified($value, $relation = ArgumentInterface::EQUAL)
    {
        return $this->where(Material::F_MODIFIED, $this->convertToDateTime($value), $relation);
    }

    /**
     * Set field for sorting.
     * TODO: We have code duplication in Record::orderBy() due to late static binding
     * @param string $fieldName Additional field name
     * @param string $order     Sorting order
     *
     * @return $this Chaining
     */
    public function orderBy($fieldName, $order = 'ASC')

    {
        if (in_array($fieldName, self::$fieldIDs)) {
            $this->orderBy = array($fieldName, $order);
        }

        return $this;
    }

    /**
     * Add sorting to entity identifiers.
     * TODO: We have code duplication in Record::orderBy() due to late static binding
     * @param array  $entityIDs
     * @param string $fieldName Additional field name for sorting
     * @param string $order     Sorting order(ASC|DESC)
     *
     * @return array Collection of entity identifiers ordered by additional field value
     */
    protected function applySorting(array $entityIDs, $fieldName, $order = 'ASC')

    {
        if (array_key_exists($fieldName, self::$fieldIDs)) {
            // Order by parent fields
            return $this->query
                ->entity(static::$identifier)
                ->where(static::$primaryFieldName, $entityIDs)
                ->orderBy($fieldName, $order)
                ->fields(static::$primaryFieldName);
        } else { // Nothing is changed
            return $entityIDs;
        }
    }
}


1		<?php declare(strict_types=1);
2		/**
3		* Created by PhpStorm.
4		* User: VITALYIEGOROV
5		* Date: 08.12.15
6		* Time: 23:11
7		*/
8		namespace samsoncms\api\query;
9
10		use samsoncms\api\generated\Material;
11		use samsonframework\orm\ArgumentInterface;
12
13		/**
14		* TODO: We have create a Record class that lays behind Entity-Generic and we store entity fields in fieldIDs static variable
15		* which cannot be accessed in parent function calls like orderBy, applySorting, to get intermediary static class variables
16		* from Generic class. This affect code duplication of method in Record to Generic to give access to static class fields
17		* described in fieldIDs.
18		*/
19
20		/**
21		* Material with additional fields query.
22		*
23		* @package samsoncms\api
24		*/
25		class Generic extends Record
26		{
27		/** @var string Table class name */
28		public static $identifier = Material::class;
29
30		/** @var string Database table name */
31		public static $tableName = 'material';
32
33		/** @var string Table primary field name */
34		public static $primaryFieldName = Material::F_PRIMARY;
35
36		/** @var array Collection of all supported entity fields */
37		public static $fieldIDs = array(
38		Material::F_PRIMARY=> Material::F_PRIMARY,
39		Material::F_PRIORITY => Material::F_PRIORITY,
40		Material::F_URL => Material::F_URL,
41		Material::F_DELETION => Material::F_DELETION,
42		Material::F_PUBLISHED => Material::F_PUBLISHED,
43		Material::F_PARENTID => Material::F_PARENTID,
44		Material::F_CREATED => Material::F_CREATED,
45		Material::F_MODYFIED => Material::F_MODYFIED,
46		);
47
48		/** @var array Collection of all supported entity fields */
49		public static $fieldNames = array(
50		Material::F_PRIMARY => Material::F_PRIMARY,
51		Material::F_PRIORITY => Material::F_PRIORITY,
52		Material::F_URL => Material::F_URL,
53		Material::F_DELETION => Material::F_DELETION,
54		Material::F_PUBLISHED => Material::F_PUBLISHED,
55		Material::F_PARENTID => Material::F_PARENTID,
56		Material::F_CREATED => Material::F_CREATED,
57		Material::F_MODYFIED => Material::F_MODYFIED
58		);
59
60		/** @var array Collection of entity field types */
61		public static $fieldTypes = [
62		'MaterialID' => 'int',
63		'parent_id' => 'int',
64		'priority' => 'int',
65		'Name' => 'string',
66		'Url' => 'string',
67		'Created' => 'int',
68		'Modyfied' => 'int',
69		'UserID' => 'int',
70		'Draft' => 'int',
71		'type' => 'int',
72		'Published' => 'int',
73		'Active' => 'int',
74		'system' => 'int',
75		'remains' => 'float',
76		];
77
78		/** @var array Collection of entity field database types */
79		public static $fieldDataTypes = [
80		'MaterialID' => 'int',
81		'parent_id' => 'int',
82		'priority' => 'int',
83		'Name' => 'varchar',
84		'Url' => 'varchar',
85		'Created' => 'datetime',
86		'Modyfied' => 'timestamp',
87		'UserID' => 'int',
88		'Draft' => 'int',
89		'type' => 'int',
90		'Published' => 'int',
91		'Active' => 'int',
92		'system' => 'int',
93		'remains' => 'float',
94		];
95
96		/** @var array Collection of entity field database default values */
97		public static $fieldDefaults = [
98		'MaterialID' => '',
99		'parent_id' => '',
100		'priority' => 0,
101		'Name' => '',
102		'Url' => '',
103		'Created' => '',
104		'Modyfied' => 'CURRENT_TIMESTAMP',
105		'UserID' => '',
106		'Draft' => 0,
107		'type' => 0,
108		'Published' => '',
109		'Active' => '',
110		'system' => 0,
111		'remains' => 0,
112		];
113
114		/** @var array Collection of entity field database is nullable values */
115		public static $fieldNullable = [
116		'MaterialID' => 'NO',
117		'parent_id' => 'YES',
118		'priority' => 'NO',
119		'Name' => 'NO',
120		'Url' => 'NO',
121		'Created' => 'YES',
122		'Modyfied' => 'NO',
123		'UserID' => 'YES',
124		'Draft' => 'NO',
125		'type' => 'NO',
126		'Published' => 'YES',
127		'Active' => 'YES',
128		'system' => 'NO',
129		'remains' => 'NO',
130		];
131
132		/** @var string Entity navigation identifiers */
133		public static $navigationIDs = array();
134
135		/**
136		* Add primary field query condition.
137		*
138		* @param string $value Field value
139		* @param string $relation @see ArgumentInterface types
140		*
141		* @return $this Chaining
142		* @see Material::where()
143		*/
144		public function primary($value, $relation = ArgumentInterface::EQUAL)
145		{
146		return $this->where(Material::F_PRIMARY, $value, $relation);
147		}
148
149		/**
150		* Add identifier field query condition.
151		*
152		* @param string $value Field value
153		* @param string $relation @see ArgumentInterface types
154		*
155		* @return $this Chaining
156		* @see Material::where()
157		*/
158		public function identifier($value, $relation = ArgumentInterface::EQUAL)
159		{
160		return $this->where(Material::F_URL, $value, $relation);
161		}
162
163		/**
164		* Add active flag condition.
165		*
166		* @param bool $value Field value
167		* @param string $relation @see ArgumentInterface types
168		*
169		* @return $this Chaining
170		* @see Material::where()
171		*/
172		public function active($value, $relation = ArgumentInterface::EQUAL)
173		{
174		return $this->where(Material::F_ACTIVE, $value, $relation);
175		}
176
177		/**
178		* Add entity published field query condition.
179		*
180		* @param string $value Field value
181		* @param string $relation @see ArgumentInterface types
182		*
183		* @return $this Chaining
184		* @see Material::where()
185		*/
186		public function published($value, $relation = ArgumentInterface::EQUAL)
187		{
188		return $this->where(Material::F_PUBLISHED, $value, $relation);
189		}
190
191		/**
192		* Add entity creation field query condition.
193		*
194		* @param string $value Field value
195		* @param string $relation @see ArgumentInterface types
196		*
197		* @return $this Chaining
198		* @see Material::where()
199		*/
200		public function created($value, $relation = ArgumentInterface::EQUAL)
201		{
202		return $this->where(Material::F_CREATED, $this->convertToDateTime($value), $relation);
203		}
204
205		/**
206		* Add entity modification field query condition.
207		*
208		* @param string $value Field value
209		* @param string $relation @see ArgumentInterface types
210		* @return $this Chaining
211		* @see Material::where()
212		*/
213		public function modified($value, $relation = ArgumentInterface::EQUAL)
214		{
215		return $this->where(Material::F_MODIFIED, $this->convertToDateTime($value), $relation);
216		}
217
218		/**
219		* Set field for sorting.
220		* TODO: We have code duplication in Record::orderBy() due to late static binding
221		* @param string $fieldName Additional field name
222		* @param string $order Sorting order
223		*
224		* @return $this Chaining
225		*/
226	View Code Duplication	public function orderBy($fieldName, $order = 'ASC')
		0 ignored issues – show Duplication introduced 2016-03-29 10:38 UTC by Report Bug Copy Issue Report 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...
227		{
228		if (in_array($fieldName, self::$fieldIDs)) {
229		$this->orderBy = array($fieldName, $order);
230		}
231
232		return $this;
233		}
234
235		/**
236		* Add sorting to entity identifiers.
237		* TODO: We have code duplication in Record::orderBy() due to late static binding
238		* @param array $entityIDs
239		* @param string $fieldName Additional field name for sorting
240		* @param string $order Sorting order(ASC\|DESC)
241		*
242		* @return array Collection of entity identifiers ordered by additional field value
243		*/
244	View Code Duplication	protected function applySorting(array $entityIDs, $fieldName, $order = 'ASC')
		0 ignored issues – show Duplication introduced 2016-05-11 10:06 UTC by Report Bug Copy Issue Report 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...
245		{
246		if (array_key_exists($fieldName, self::$fieldIDs)) {
247		// Order by parent fields
248		return $this->query
249		->entity(static::$identifier)
250		->where(static::$primaryFieldName, $entityIDs)
251		->orderBy($fieldName, $order)
252		->fields(static::$primaryFieldName);
253		} else { // Nothing is changed
254		return $entityIDs;
255		}
256		}
257		}
258

samsoncms / api

Generic::primary() A last analyzed 2016-10-05 09:42 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

Generic::primary() A
last analyzed 2016-10-05 09:42 UTC