Generator::fieldName() - Code Metrics - Inspection of "Refactored" - samsoncms/api - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( c27b7b...22286c )

by Vitaly

created 2015-12-11 10:01 UTC

Generator::fieldName() A

↳ Parent: Generator

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes	2
Bugs	0	Features	0

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

<?php
/**
 * Created by PhpStorm.
 * User: VITALYIEGOROV
 * Date: 09.12.15
 * Time: 14:34
 */
namespace samsoncms\api;

use samsonframework\orm\DatabaseInterface;

/**
 * Entity classes generator.
 * @package samsoncms\api
 */
class Generator
{
    /** @var DatabaseInterface */
    protected $database;

    /**
     * Transliterate string to english.
     *
     * @param string $string Source string
     * @return string Transliterated string
     */
    protected function transliterated($string)
    {
        return str_replace(
            ' ',
            '',
            ucwords(iconv("UTF-8", "UTF-8//IGNORE", strtr($string, array(
                            "'" => "",
                            "`" => "",
                            "-" => " ",
                            "_" => " ",
                            "а" => "a", "А" => "a",
                            "б" => "b", "Б" => "b",
                            "в" => "v", "В" => "v",
                            "г" => "g", "Г" => "g",
                            "д" => "d", "Д" => "d",
                            "е" => "e", "Е" => "e",
                            "ж" => "zh", "Ж" => "zh",
                            "з" => "z", "З" => "z",
                            "и" => "i", "И" => "i",
                            "й" => "y", "Й" => "y",
                            "к" => "k", "К" => "k",
                            "л" => "l", "Л" => "l",
                            "м" => "m", "М" => "m",
                            "н" => "n", "Н" => "n",
                            "о" => "o", "О" => "o",
                            "п" => "p", "П" => "p",
                            "р" => "r", "Р" => "r",
                            "с" => "s", "С" => "s",
                            "т" => "t", "Т" => "t",
                            "у" => "u", "У" => "u",
                            "ф" => "f", "Ф" => "f",
                            "х" => "h", "Х" => "h",
                            "ц" => "c", "Ц" => "c",
                            "ч" => "ch", "Ч" => "ch",
                            "ш" => "sh", "Ш" => "sh",
                            "щ" => "sch", "Щ" => "sch",
                            "ъ" => "", "Ъ" => "",
                            "ы" => "y", "Ы" => "y",
                            "ь" => "", "Ь" => "",
                            "э" => "e", "Э" => "e",
                            "ю" => "yu", "Ю" => "yu",
                            "я" => "ya", "Я" => "ya",
                            "і" => "i", "І" => "i",
                            "ї" => "yi", "Ї" => "yi",
                            "є" => "e", "Є" => "e"
                        )
                    )
                )
            )
        );
    }

    /**
     * Get class constant name by its value.
     *
     * @param string $value Constant value
     * @param string $className Class name
     * @return string Full constant name
     */
    protected function constantNameByValue($value, $className = Field::ENTITY)
    {
        // Get array where class constants are values and their values are keys
        $nameByValue = array_flip((new \ReflectionClass($className))->getConstants());

        // Try to find constant by its value
        if (isset($nameByValue[$value])) {
            // Return constant name
            return $nameByValue[$value];
        }
    }

    /**
     * Get correct entity name.
     *
     * @param string $navigationName Original navigation entity name
     * @return string Correct PHP-supported entity name
     */
    protected function entityName($navigationName)
    {
        return ucfirst($this->transliterated($navigationName));
    }

    /**
     * Get correct full entity name with name space.
     *
     * @param string $navigationName Original navigation entity name
     * @param string $namespace Namespace
     * @return string Correct PHP-supported entity name
     */
    protected function fullEntityName($navigationName, $namespace = __NAMESPACE__)
    {
        return $namespace.$this->entityName($navigationName);
    }

    /**
     * Get correct field name.
     *
     * @param string $fieldName Original field name
     * @return string Correct PHP-supported field name
     */
    protected function fieldName($fieldName)
    {
        return $fieldName = lcfirst($this->transliterated($fieldName));
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}
    }

    /**
     * Get additional field type in form of Field constant name
     * by database additional field type identifier.
     *
     * @param integer $fieldType Additional field type identifier
     * @return string Additional field type constant
     */
    protected function additionalFieldType($fieldType)
    {
        return 'Field::'.$this->constantNameByValue($fieldType);
    }

    /**
     * Create entity PHP class code.
     *
     * @param string $navigationName Original entity name
     * @param string $entityName PHP entity name
     * @param array $navigationFields Collection of entity additional fields
     * @return string Generated entity query PHP class code
     */
    protected function createEntityClass($navigationName, $entityName, $navigationFields)
    {
        $class = "\n\n" . '/** Class for getting "'.$navigationName.'" instances from database */';
        $class .= "\n" . 'class ' . $entityName . ' extends Generic';
        $class .= "\n" . '{';

        // Iterate additional fields
        foreach ($navigationFields as $fieldID => $fieldRow) {
            $fieldName = $this->fieldName($fieldRow['Name']);

            $class .= "\n\t" . '/** @var ' . Field::phpType($fieldRow['Type']) . ' Field #' . $fieldID . '*/';
            $class .= "\n\t" . 'protected $' . $fieldName . ';';
        }

        $class .= "\n\t";
        $class .= "\n\t" . '/** @var string Not transliterated entity name */';
        $class .= "\n\t" . 'protected static $viewName = "' . $navigationName . '";';
        $class .= "\n" . '}';

        return $class;
    }

    /**
     * Generate Query::where() analog for specific field.
     *
     * @param string $fieldName Field name
     * @param string $fieldId Field primary identifier
     * @param string $fieldType Field PHP type
     * @return string Generated PHP method code
     */
    protected function generateFieldConditionMethod($fieldName, $fieldId, $fieldType)
    {
        $code = "\n\t" . '/**';
        $code .= "\n\t" . ' * Add '.$fieldName.'(#' . $fieldId . ') field query condition.';
        $code .= "\n\t" . ' * @param '.Field::phpType($fieldType).' $value Field value';
        $code .= "\n\t" . ' * @return self Chaining';
        $code .= "\n\t" . ' * @see Generic::where()';
        $code .= "\n\t" . ' */';
        $code .= "\n\t" . 'public function ' . $fieldName . '($value)';
        $code .= "\n\t" . "{";
        $code .= "\n\t\t" . 'return $this->where("'.$fieldName.'", $value);';

        return $code . "\n\t" . "}"."\n";
    }

    /**
     * Create entity query PHP class code.
     *
     * @param integer $navigationID Entity navigation identifier
     * @param string $navigationName Original entity name
     * @param string $entityName PHP entity name
     * @param array $navigationFields Collection of entity additional fields
     * @return string Generated entity query PHP class code
     */
    protected function createQueryClass($navigationID, $navigationName, $entityName, $navigationFields)
    {
        $class = "\n\n" . '/** Class for getting "'.$navigationName.'" instances from database */';
        $class .= "\n" . 'class ' . $entityName . ' extends Generic';
        $class .= "\n" . '{';

        // Iterate additional fields
        $fieldIDs = array();
        foreach ($navigationFields as $fieldID => $fieldRow) {
            $fieldName = $this->fieldName($fieldRow['Name']);

            $class .= $this->generateFieldConditionMethod(
                $fieldName,
                $fieldRow['FieldID'],
                $fieldRow['Type']
            );

            // Store field metadata
            $fieldIDs[] = '"' . $fieldName . '" => "' . $fieldID . '"';
        }

        $class .= "\n\t";
        $class .= "\n\t" . '/** @var string Not transliterated entity name */';
        $class .= "\n\t" . 'protected static $identifier = "'.$this->fullEntityName($navigationName).'";';
        $class .= "\n\t" . '/** @var array Collection of navigation identifiers */';
        $class .= "\n\t" . 'protected static $navigationIDs = array(' . $navigationID . ');';
        $class .= "\n\t" . '/** @var array Collection of additional fields identifiers */';
        $class .= "\n\t" . 'protected static $fieldIDs = array(' . "\n\t\t". implode(','."\n\t\t", $fieldIDs) . "\n\t".');';
        $class .= "\n" . '}';

        // Replace tabs with spaces
        return $class;
    }

    /** @return string Entity state hash */
    public function entityHash()
    {
        // Получим информацию о всех таблицах из БД
        return md5(serialize($this->database->fetch(
            'SELECT `TABLES`.`TABLE_NAME` as `TABLE_NAME`
              FROM `information_schema`.`TABLES` as `TABLES`
              WHERE `TABLES`.`TABLE_SCHEMA`="' . $this->database->database() . '";'
        )));
    }

    /** @return array Get collection of navigation objects */
    protected function entityNavigations($type = 0)
    {
        return $this->database->fetch('
        SELECT * FROM `structure`
        WHERE `Active` = "1" AND `Type` = "'.$type.'"'
        );
    }

    /** @return array Collection of navigation additional fields */
    protected function navigationFields($navigationID)
    {
        $return = array();
        // TODO: Optimize queries make one single query with only needed data
        foreach ($this->database->fetch('SELECT * FROM `structurefield` WHERE `StructureID` = "' . $navigationID . '" AND `Active` = "1"') as $fieldStructureRow) {
            foreach ($this->database->fetch('SELECT * FROM `field` WHERE `FieldID` = "' . $fieldStructureRow['FieldID'] . '"') as $fieldRow) {
                $return[$fieldRow['FieldID']] = $fieldRow;
            }
        }

        return $return;
    }

    /**
     * Generate entity classes.
     *
     * @param string $namespace Base namespace for generated classes
     * @return string Generated PHP code for entity classes
     */
    public function createEntityClasses($namespace = __NAMESPACE__)
    {
        $classes = "\n" . 'namespace ' . $namespace . ';';
        $classes .= "\n";
        $classes .= "\n" . 'use '.$namespace.'\Field;';
        $classes .= "\n" . 'use '.$namespace.'\query\Generic;';

        // Iterate all structures
        foreach ($this-> entityNavigations() as $structureRow) {
            $navigationFields = $this->navigationFields($structureRow['StructureID']);
            $entityName = $this->entityName($structureRow['Name']);

            $classes .= $this->createEntityClass(
                $structureRow['Name'],
                $entityName,
                $navigationFields
            );

            $classes .= $this->createQueryClass(
                $structureRow['StructureID'],
                $structureRow['Name'],
                $entityName.'Query',
                $navigationFields
            );
        }

        // Make correct code formatting
        return str_replace("\t", '    ', $classes);
    }

    /**
     * Generator constructor.
     * @param DatabaseInterface $database Database instance
     */
    public function __construct(DatabaseInterface $database)
    {
        $this->database = $database;
    }
}


1			<?php
2			/**
3			* Created by PhpStorm.
4			* User: VITALYIEGOROV
5			* Date: 09.12.15
6			* Time: 14:34
7			*/
8			namespace samsoncms\api;
9
10			use samsonframework\orm\DatabaseInterface;
11
12			/**
13			* Entity classes generator.
14			* @package samsoncms\api
15			*/
16			class Generator
17			{
18			/** @var DatabaseInterface */
19			protected $database;
20
21			/**
22			* Transliterate string to english.
23			*
24			* @param string $string Source string
25			* @return string Transliterated string
26			*/
27			protected function transliterated($string)
28			{
29			return str_replace(
30			' ',
31			'',
32			ucwords(iconv("UTF-8", "UTF-8//IGNORE", strtr($string, array(
33			"'" => "",
34			"`" => "",
35			"-" => " ",
36			"_" => " ",
37			"а" => "a", "А" => "a",
38			"б" => "b", "Б" => "b",
39			"в" => "v", "В" => "v",
40			"г" => "g", "Г" => "g",
41			"д" => "d", "Д" => "d",
42			"е" => "e", "Е" => "e",
43			"ж" => "zh", "Ж" => "zh",
44			"з" => "z", "З" => "z",
45			"и" => "i", "И" => "i",
46			"й" => "y", "Й" => "y",
47			"к" => "k", "К" => "k",
48			"л" => "l", "Л" => "l",
49			"м" => "m", "М" => "m",
50			"н" => "n", "Н" => "n",
51			"о" => "o", "О" => "o",
52			"п" => "p", "П" => "p",
53			"р" => "r", "Р" => "r",
54			"с" => "s", "С" => "s",
55			"т" => "t", "Т" => "t",
56			"у" => "u", "У" => "u",
57			"ф" => "f", "Ф" => "f",
58			"х" => "h", "Х" => "h",
59			"ц" => "c", "Ц" => "c",
60			"ч" => "ch", "Ч" => "ch",
61			"ш" => "sh", "Ш" => "sh",
62			"щ" => "sch", "Щ" => "sch",
63			"ъ" => "", "Ъ" => "",
64			"ы" => "y", "Ы" => "y",
65			"ь" => "", "Ь" => "",
66			"э" => "e", "Э" => "e",
67			"ю" => "yu", "Ю" => "yu",
68			"я" => "ya", "Я" => "ya",
69			"і" => "i", "І" => "i",
70			"ї" => "yi", "Ї" => "yi",
71			"є" => "e", "Є" => "e"
72			)
73			)
74			)
75			)
76			);
77			}
78
79			/**
80			* Get class constant name by its value.
81			*
82			* @param string $value Constant value
83			* @param string $className Class name
84			* @return string Full constant name
85			*/
86			protected function constantNameByValue($value, $className = Field::ENTITY)
87			{
88			// Get array where class constants are values and their values are keys
89			$nameByValue = array_flip((new \ReflectionClass($className))->getConstants());
90
91			// Try to find constant by its value
92			if (isset($nameByValue[$value])) {
93			// Return constant name
94			return $nameByValue[$value];
95			}
96			}
97
98			/**
99			* Get correct entity name.
100			*
101			* @param string $navigationName Original navigation entity name
102			* @return string Correct PHP-supported entity name
103			*/
104			protected function entityName($navigationName)
105			{
106			return ucfirst($this->transliterated($navigationName));
107			}
108
109			/**
110			* Get correct full entity name with name space.
111			*
112			* @param string $navigationName Original navigation entity name
113			* @param string $namespace Namespace
114			* @return string Correct PHP-supported entity name
115			*/
116			protected function fullEntityName($navigationName, $namespace = __NAMESPACE__)
117			{
118			return $namespace.$this->entityName($navigationName);
119			}
120
121			/**
122			* Get correct field name.
123			*
124			* @param string $fieldName Original field name
125			* @return string Correct PHP-supported field name
126			*/
127			protected function fieldName($fieldName)
128			{
129			return $fieldName = lcfirst($this->transliterated($fieldName));
			0 ignored issues – show Unused Code introduced 2015-12-11 09:56 UTC by Report Bug Copy Issue Report `$fieldName` is not used, you could remove the assignment. This check looks for variable assignements that are either overwritten by other assignments or where the variable is not used subsequently. $myVar = 'Value'; $higher = false; if (rand(1, 6) > 3) { $higher = true; } else { $higher = false; } Both the `$myVar` assignment in line 1 and the `$higher` assignment in line 2 are dead. The first because `$myVar` is never used and the second because `$higher` is always overwritten for every possible time line. Loading history...
130			}
131
132			/**
133			* Get additional field type in form of Field constant name
134			* by database additional field type identifier.
135			*
136			* @param integer $fieldType Additional field type identifier
137			* @return string Additional field type constant
138			*/
139			protected function additionalFieldType($fieldType)
140			{
141			return 'Field::'.$this->constantNameByValue($fieldType);
142			}
143
144			/**
145			* Create entity PHP class code.
146			*
147			* @param string $navigationName Original entity name
148			* @param string $entityName PHP entity name
149			* @param array $navigationFields Collection of entity additional fields
150			* @return string Generated entity query PHP class code
151			*/
152			protected function createEntityClass($navigationName, $entityName, $navigationFields)
153			{
154			$class = "\n\n" . '/** Class for getting "'.$navigationName.'" instances from database */';
155			$class .= "\n" . 'class ' . $entityName . ' extends Generic';
156			$class .= "\n" . '{';
157
158			// Iterate additional fields
159			foreach ($navigationFields as $fieldID => $fieldRow) {
160			$fieldName = $this->fieldName($fieldRow['Name']);
161
162			$class .= "\n\t" . '/** @var ' . Field::phpType($fieldRow['Type']) . ' Field #' . $fieldID . '*/';
163			$class .= "\n\t" . 'protected $' . $fieldName . ';';
164			}
165
166			$class .= "\n\t";
167			$class .= "\n\t" . '/** @var string Not transliterated entity name */';
168			$class .= "\n\t" . 'protected static $viewName = "' . $navigationName . '";';
169			$class .= "\n" . '}';
170
171			return $class;
172			}
173
174			/**
175			* Generate Query::where() analog for specific field.
176			*
177			* @param string $fieldName Field name
178			* @param string $fieldId Field primary identifier
179			* @param string $fieldType Field PHP type
180			* @return string Generated PHP method code
181			*/
182			protected function generateFieldConditionMethod($fieldName, $fieldId, $fieldType)
183			{
184			$code = "\n\t" . '/**';
185			$code .= "\n\t" . ' * Add '.$fieldName.'(#' . $fieldId . ') field query condition.';
186			$code .= "\n\t" . ' * @param '.Field::phpType($fieldType).' $value Field value';
187			$code .= "\n\t" . ' * @return self Chaining';
188			$code .= "\n\t" . ' * @see Generic::where()';
189			$code .= "\n\t" . ' */';
190			$code .= "\n\t" . 'public function ' . $fieldName . '($value)';
191			$code .= "\n\t" . "{";
192			$code .= "\n\t\t" . 'return $this->where("'.$fieldName.'", $value);';
193
194			return $code . "\n\t" . "}"."\n";
195			}
196
197			/**
198			* Create entity query PHP class code.
199			*
200			* @param integer $navigationID Entity navigation identifier
201			* @param string $navigationName Original entity name
202			* @param string $entityName PHP entity name
203			* @param array $navigationFields Collection of entity additional fields
204			* @return string Generated entity query PHP class code
205			*/
206			protected function createQueryClass($navigationID, $navigationName, $entityName, $navigationFields)
207			{
208			$class = "\n\n" . '/** Class for getting "'.$navigationName.'" instances from database */';
209			$class .= "\n" . 'class ' . $entityName . ' extends Generic';
210			$class .= "\n" . '{';
211
212			// Iterate additional fields
213			$fieldIDs = array();
214			foreach ($navigationFields as $fieldID => $fieldRow) {
215			$fieldName = $this->fieldName($fieldRow['Name']);
216
217			$class .= $this->generateFieldConditionMethod(
218			$fieldName,
219			$fieldRow['FieldID'],
220			$fieldRow['Type']
221			);
222
223			// Store field metadata
224			$fieldIDs[] = '"' . $fieldName . '" => "' . $fieldID . '"';
225			}
226
227			$class .= "\n\t";
228			$class .= "\n\t" . '/** @var string Not transliterated entity name */';
229			$class .= "\n\t" . 'protected static $identifier = "'.$this->fullEntityName($navigationName).'";';
230			$class .= "\n\t" . '/** @var array Collection of navigation identifiers */';
231			$class .= "\n\t" . 'protected static $navigationIDs = array(' . $navigationID . ');';
232			$class .= "\n\t" . '/** @var array Collection of additional fields identifiers */';
233			$class .= "\n\t" . 'protected static $fieldIDs = array(' . "\n\t\t". implode(','."\n\t\t", $fieldIDs) . "\n\t".');';
234			$class .= "\n" . '}';
235
236			// Replace tabs with spaces
237			return $class;
238			}
239
240			/** @return string Entity state hash */
241			public function entityHash()
242			{
243			// Получим информацию о всех таблицах из БД
244			return md5(serialize($this->database->fetch(
245			'SELECT `TABLES`.`TABLE_NAME` as `TABLE_NAME`
246			FROM `information_schema`.`TABLES` as `TABLES`
247			WHERE `TABLES`.`TABLE_SCHEMA`="' . $this->database->database() . '";'
248			)));
249			}
250
251			/** @return array Get collection of navigation objects */
252			protected function entityNavigations($type = 0)
253			{
254			return $this->database->fetch('
255			SELECT * FROM `structure`
256			WHERE `Active` = "1" AND `Type` = "'.$type.'"'
257			);
258			}
259
260			/** @return array Collection of navigation additional fields */
261			protected function navigationFields($navigationID)
262			{
263			$return = array();
264			// TODO: Optimize queries make one single query with only needed data
265			foreach ($this->database->fetch('SELECT * FROM `structurefield` WHERE `StructureID` = "' . $navigationID . '" AND `Active` = "1"') as $fieldStructureRow) {
266			foreach ($this->database->fetch('SELECT * FROM `field` WHERE `FieldID` = "' . $fieldStructureRow['FieldID'] . '"') as $fieldRow) {
267			$return[$fieldRow['FieldID']] = $fieldRow;
268			}
269			}
270
271			return $return;
272			}
273
274			/**
275			* Generate entity classes.
276			*
277			* @param string $namespace Base namespace for generated classes
278			* @return string Generated PHP code for entity classes
279			*/
280			public function createEntityClasses($namespace = __NAMESPACE__)
281			{
282			$classes = "\n" . 'namespace ' . $namespace . ';';
283			$classes .= "\n";
284			$classes .= "\n" . 'use '.$namespace.'\Field;';
285			$classes .= "\n" . 'use '.$namespace.'\query\Generic;';
286
287			// Iterate all structures
288			foreach ($this-> entityNavigations() as $structureRow) {
289			$navigationFields = $this->navigationFields($structureRow['StructureID']);
290			$entityName = $this->entityName($structureRow['Name']);
291
292			$classes .= $this->createEntityClass(
293			$structureRow['Name'],
294			$entityName,
295			$navigationFields
296			);
297
298			$classes .= $this->createQueryClass(
299			$structureRow['StructureID'],
300			$structureRow['Name'],
301			$entityName.'Query',
302			$navigationFields
303			);
304			}
305
306			// Make correct code formatting
307			return str_replace("\t", ' ', $classes);
308			}
309
310			/**
311			* Generator constructor.
312			* @param DatabaseInterface $database Database instance
313			*/
314			public function __construct(DatabaseInterface $database)
315			{
316			$this->database = $database;
317			}
318			}
319

samsoncms / api

Push — master ( c27b7b...22286c )

Generator::fieldName() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like