GUIDTrait::getReadableGuidAttribute() - Code Metrics - rhosocial/yii2-base-models - Measure and Improve Code Quality continuously with Scrutinizer

GUIDTrait::getReadableGuidAttribute() A
last analyzed 2017-05-15 05:37 UTC

↳ Parent: GUIDTrait

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	2
CRAP Score	1

Importance

Changes

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

<?php

/**
 *   _   __ __ _____ _____ ___  ____  _____
 *  | | / // // ___//_  _//   ||  __||_   _|
 *  | |/ // /(__  )  / / / /| || |     | |
 *  |___//_//____/  /_/ /_/ |_||_|     |_|
 * @link https://vistart.me/
 * @copyright Copyright (c) 2016 - 2017 vistart
 * @license https://vistart.me/license/
 */

namespace rhosocial\base\models\traits;

use rhosocial\base\helpers\Number;
use yii\base\ModelEvent;

/**
 * Entity features concerning GUID.
 * @property string $GUID GUID value in 128-bit(16 bytes) binary format.
 * @property-read string $readableGUID Readable GUID value seperated with four hyphens.
 * @property-read array $guidRules
 * @version 1.0
 * @author vistart <[email protected]>
 */
trait GUIDTrait
{
    
    /**
     * @var string REQUIRED. The attribute that will receive the GUID value.
     */
    public $guidAttribute = 'guid';
    
    /**
     * DO NOT MODIFY OR OVERRIDE THIS METHOD UNLESS YOU KNOW THE CONSEQUENCES.
     * @return string
     */
    public function getReadableGuidAttribute()
    {
        return 'readableGuid';
    }
    
    /**
     * Attach `onInitGUIDAttribute` event.
     * @param string $eventName
     */
    protected function attachInitGUIDEvent($eventName)
    {
        $this->on($eventName, [$this, 'onInitGUIDAttribute']);
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
    }
    
    /**
     * Initialize the GUID attribute with new generated GUID.
     * This method is ONLY used for being triggered by event. DO NOT call,
     * ovveride or modify it directly, unless you know the conquences.
     * @param ModelEvent $event
     */
    public function onInitGUIDAttribute($event)
    {
        $sender = $event->sender;
        /* @var $sender static */
        $sender->setGUID(static::generateGuid());
    }

    /**
     * Generate GUID in binary.
     * @return string GUID.
     */
    public static function generateGuid()
    {
        return Number::guid_bin();
    }

    /**
     * Check if the $guid existed in current database table.
     * @param string $guid the GUID to be checked.
     * @return boolean Whether the $guid exists or not.
     */
    public static function checkGuidExists($guid)
    {
        return static::findOne($guid) !== null;
    }
    
    /**
     * Get the rules associated with GUID attribute.
     * @return array GUID rules.
     */
    public function getGUIDRules()
    {
        $rules = [];
        if (is_string($this->guidAttribute) && !empty($this->guidAttribute)) {
            $rules = [
                [[$this->guidAttribute], 'required',],
                [[$this->guidAttribute], 'unique',],
                [[$this->guidAttribute], 'string', 'max' => 16],
            ];
        }
        return $rules;
    }
    
    /**
     * Get GUID, in spite of guid attribute name.
     * @return string
     */
    public function getGUID()
    {
        $guidAttribute = $this->guidAttribute;
        return (is_string($guidAttribute) && !empty($guidAttribute)) ? $this->$guidAttribute : null;
    }
    
    /**
     * Get Readable GUID.
     * @return string
     */
    public function getReadableGUID()
    {
        $guid = $this->getGUID();
        if (preg_match(Number::GUID_REGEX, $guid)) {
            return $guid;
        }
        return Number::guid(false, false, $guid);
    }

    /**
     * Set guid, in spite of guid attribute name.
     * @param string $guid
     * @return string
     */
    public function setGUID($guid)
    {
        $guidAttribute = $this->guidAttribute;
        if (preg_match(Number::GUID_REGEX, $guid)) {
            $guid = hex2bin(str_replace(['{', '}', '-'], '', $guid));
        }
        return (is_string($guidAttribute) && !empty($guidAttribute)) ? $this->$guidAttribute = $guid : null;
    }
    
    /**
     * Composite GUIDs from models.
     * @param array|string $models
     * @return array
     */
    public static function compositeGUIDs($models)
    {
        if (empty($models)) {
            return null;
        }
        if (!is_array($models) && $models instanceof static) {
            return $models->getGUID();
        }
        if (is_string($models) && strlen($models) == 16) {
            return $models;
        }
        $guids = [];
        foreach ($models as $model) {
$collection = json_decode($data, true);
if ( ! is_array($collection)) {
    throw new \RuntimeException('$collection must be an array.');
}

foreach ($collection as $item) { /** ... */ }
            if ($model instanceof static) {
                $guids[] = $model->getGUID();
            } elseif (is_string($model)) {
                if (strlen($model) == 16) {
                    $guids[] = $model;
                } elseif (preg_match(Number::GUID_REGEX, $model)) {
                    $guids[] = Number::guid_bin($model);
                }
            }
        }
        return $guids;
    }
}

1		<?php
2
3		/**
4		* _ __ __ _____ _____ ___ ____ _____
5		* \| \| / // // ___//_ _// \|\| __\|\|_ _\|
6		* \| \|/ // /(__ ) / / / /\| \|\| \| \| \|
7		* \|___//_//____/ /_/ /_/ \|_\|\|_\| \|_\|
8		* @link https://vistart.me/
9		* @copyright Copyright (c) 2016 - 2017 vistart
10		* @license https://vistart.me/license/
11		*/
12
13		namespace rhosocial\base\models\traits;
14
15		use rhosocial\base\helpers\Number;
16		use yii\base\ModelEvent;
17
18		/**
19		* Entity features concerning GUID.
20		* @property string $GUID GUID value in 128-bit(16 bytes) binary format.
21		* @property-read string $readableGUID Readable GUID value seperated with four hyphens.
22		* @property-read array $guidRules
23		* @version 1.0
24		* @author vistart <[email protected]>
25		*/
26		trait GUIDTrait
27		{
28
29		/**
30		* @var string REQUIRED. The attribute that will receive the GUID value.
31		*/
32		public $guidAttribute = 'guid';
33
34		/**
35		* DO NOT MODIFY OR OVERRIDE THIS METHOD UNLESS YOU KNOW THE CONSEQUENCES.
36		* @return string
37		*/
38	3	public function getReadableGuidAttribute()
39		{
40	3	return 'readableGuid';
41		}
42
43		/**
44		* Attach `onInitGUIDAttribute` event.
45		* @param string $eventName
46		*/
47	392	protected function attachInitGUIDEvent($eventName)
48		{
49	392	$this->on($eventName, [$this, 'onInitGUIDAttribute']);
		0 ignored issues – show Bug introduced 2017-01-12 08:52 UTC by Report Bug Copy Issue Report It seems like `on()` must be provided by classes using this trait. How about adding it as abstract method to this trait? This check looks for methods that are used by a trait but not required by it. To illustrate, let’s look at the following code example trait Idable { public function equalIds(Idable $other) { return $this->getId() === $other->getId(); } } The trait `Idable` provides a method `equalsId` that in turn relies on the method `getId()`. If this method does not exist on a class mixing in this trait, the method will fail. Adding the `getId()` as an abstract method to the trait will make sure it is available. Loading history...
50	392	}
51
52		/**
53		* Initialize the GUID attribute with new generated GUID.
54		* This method is ONLY used for being triggered by event. DO NOT call,
55		* ovveride or modify it directly, unless you know the conquences.
56		* @param ModelEvent $event
57		*/
58	392	public function onInitGUIDAttribute($event)
59		{
60	392	$sender = $event->sender;
61		/* @var $sender static */
62	392	$sender->setGUID(static::generateGuid());
63	392	}
64
65		/**
66		* Generate GUID in binary.
67		* @return string GUID.
68		*/
69	392	public static function generateGuid()
70		{
71	392	return Number::guid_bin();
72		}
73
74		/**
75		* Check if the $guid existed in current database table.
76		* @param string $guid the GUID to be checked.
77		* @return boolean Whether the $guid exists or not.
78		*/
79	3	public static function checkGuidExists($guid)
80		{
81	3	return static::findOne($guid) !== null;
82		}
83
84		/**
85		* Get the rules associated with GUID attribute.
86		* @return array GUID rules.
87		*/
88	346	public function getGUIDRules()
89		{
90	346	$rules = [];
91	346	if (is_string($this->guidAttribute) && !empty($this->guidAttribute)) {
92		$rules = [
93	325	[[$this->guidAttribute], 'required',],
94	325	[[$this->guidAttribute], 'unique',],
95	325	[[$this->guidAttribute], 'string', 'max' => 16],
96		];
97		}
98	346	return $rules;
99		}
100
101		/**
102		* Get GUID, in spite of guid attribute name.
103		* @return string
104		*/
105	247	public function getGUID()
106		{
107	247	$guidAttribute = $this->guidAttribute;
108	247	return (is_string($guidAttribute) && !empty($guidAttribute)) ? $this->$guidAttribute : null;
109		}
110
111		/**
112		* Get Readable GUID.
113		* @return string
114		*/
115	15	public function getReadableGUID()
116		{
117	15	$guid = $this->getGUID();
118	15	if (preg_match(Number::GUID_REGEX, $guid)) {
119	3	return $guid;
120		}
121	12	return Number::guid(false, false, $guid);
122		}
123
124		/**
125		* Set guid, in spite of guid attribute name.
126		* @param string $guid
127		* @return string
128		*/
129	377	public function setGUID($guid)
130		{
131	377	$guidAttribute = $this->guidAttribute;
132	377	if (preg_match(Number::GUID_REGEX, $guid)) {
133	3	$guid = hex2bin(str_replace(['{', '}', '-'], '', $guid));
134		}
135	377	return (is_string($guidAttribute) && !empty($guidAttribute)) ? $this->$guidAttribute = $guid : null;
136		}
137
138		/**
139		* Composite GUIDs from models.
140		* @param array\|string $models
141		* @return array
142		*/
143	51	public static function compositeGUIDs($models)
144		{
145	51	if (empty($models)) {
146	14	return null;
147		}
148	51	if (!is_array($models) && $models instanceof static) {
149	49	return $models->getGUID();
150		}
151	4	if (is_string($models) && strlen($models) == 16) {
152	2	return $models;
153		}
154	2	$guids = [];
155	2	foreach ($models as $model) {
		0 ignored issues – show Bug introduced 2017-01-21 13:45 UTC by Report Bug Copy Issue Report The expression `$models` of type `array\|string` is not guaranteed to be traversable. How about adding an additional type check? There are different options of fixing this problem. If you want to be on the safe side, you can add an additional type-check: $collection = json_decode($data, true); if ( ! is_array($collection)) { throw new \RuntimeException('$collection must be an array.'); } foreach ($collection as $item) { /** ... / } If you are sure that the expression is traversable, you might want to add a doc comment cast* to improve IDE auto-completion and static analysis: /** @var array $collection / $collection = json_decode($data, true); foreach ($collection as $item) { /* .. / } Mark the issue as a false-positive*: Just hover the remove button, in the top-right corner of this issue for more options. Loading history...
156	2	if ($model instanceof static) {
157	2	$guids[] = $model->getGUID();
158		} elseif (is_string($model)) {
159		if (strlen($model) == 16) {
160		$guids[] = $model;
161		} elseif (preg_match(Number::GUID_REGEX, $model)) {
162		$guids[] = Number::guid_bin($model);
163		}
164		}
165		}
166	2	return $guids;
167		}
168		}

rhosocial / yii2-base-models

GUIDTrait::getReadableGuidAttribute() A last analyzed 2017-05-15 05:37 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like

GUIDTrait::getReadableGuidAttribute() A
last analyzed 2017-05-15 05:37 UTC