UniqueId::isValidCenterId() - Code Metrics - Inspection of "Merge branch 'refs/heads/v1'" - majiameng/tools - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 23e15f...93b7a9 )

by ma

created 2024-11-11 02:21 UTC

UniqueId::isValidCenterId() A

↳ Parent: UniqueId

Complexity

Conditions	3
Paths	3

Size

Total Lines	3
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

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

<?php
namespace tinymeng\tools;
/**
 *
 * STRUCTURE
 * ================================================================================
 *
 * 0 xxxxxxxx xxxxxxxx xxxxxxxx xxxxxxxx xxxxxxxx x xxxxx xxxxx xxxx xxxxxxxx
 * - ---------------------------------------------- ----- ----- -----------
 * Escaped Time (in millisecond)                  Center Node Random
 * 1 41 bits                                        5     5     12 bits
 * 0~69 (years)                                   0~32  0~32  0~4095
 *
 *
 * Center
 * 0 00000000 00000000 00000000 00000000 00000000 0 11111 00000 0000 00000000
 * 00000000 00000000 00000000 00000000 00000000 00111110 00000000 00000000
 * 00       00       00       00       00       3E       00       00
 *
 * Node
 * 0 00000000 00000000 00000000 00000000 00000000 0 00000 11111 0000 00000000
 * 00000000 00000000 00000000 00000000 00000000 00000001 11110000 00000000
 * 00       00       00       00       00       01       F0       00
 *
 * Escaped Time
 * 0 11111111 11111111 11111111 11111111 11111111 1 00000 00000 0000 00000000
 * 01111111 11111111 11111111 11111111 11111111 11000000 00000000 00000000
 * 7F       FF       FF       FF       FF       C0       00       00
 *
 * Random
 * 0 00000000 00000000 00000000 00000000 00000000 0 00000 00000 1111 11111111
 * 00000000 00000000 00000000 00000000 00000000 00000000 00001111 11111111
 * 00       00       00       00       00       00       0F       FF
 *
 * php -r 'echo dechex( 0b00111111 );'
 */
class UniqueId{


    protected static $g_cInstanceDId;

    /**
     *	Offset from Unix Epoch
     *
     *	Unix Epoch :	January 1, 1970 00:00:00 GMT
     *	Epoch Offset :	November 7, 2016 00:00:00 GMT
     */
    CONST EPOCH_OFFSET = 1478476800000;

    /**
     * __construct
     */
    public function __construct(){}

    /**
     * __destruct
     */
    public function __destruct(){}

    /**
     * getInstance
     * @return self
     */
    static function getInstance()

    {
        if ( is_null( self::$g_cInstanceDId ) || ! isset( self::$g_cInstanceDId ) )
        {
            self::$g_cInstanceDId = new self();
        }
        return self::$g_cInstanceDId;
    }


    /**
     *	Generate an unique id
     *
     *	@param $nCenter int	data center id ( 0 ~ 31 )
     *	@param $nNode int	data node id ( 0 ~ 31 )
     *	@param $sSource string	source string for calculating crc32 hash value
     *	@param $arrData &array	details about the id

     *	@return int(64)	id
     */
    public function createId( $nCenter, $nNode, $sSource = null, & $arrData = null )
    {
        if ( ! $this->isValidCenterId( $nCenter ) )
        {
            return null;
        }
        if ( ! $this->isValidNodeId( $nNode ) )
        {
            return null;
        }

        //	...
        $nRet	= 0;

        $nTime	= $this->getEscapedTime();

        if ( is_string( $sSource ) && strlen( $sSource ) > 0 )
        {
            //	use crc32 hash value instead of rand
            $nRand	= crc32( $sSource );
        }
        else
        {
            //	0 ~ 4095
            $nRand	= rand( 0, 0xFFF );
        }

        //	...
        $nCenterV	= ( ( $nCenter << 17 ) & 0x00000000003E0000 );
        $nNodeV		= ( ( $nNode   << 12 ) & 0x000000000001F000 );
        $nTimeV		= ( ( $nTime   << 22 ) & 0x7FFFFFFFFFC00000 );
        $nRandV		= ( ( $nRand   << 0  ) & 0x0000000000000FFF );

        $nRet		= ( $nCenterV + $nNodeV + $nTimeV + $nRandV );

        //	...
        if ( ! is_null( $arrData ) )
        {
            $arrData =
                [
                    'center'	=> $nCenter,
                    'node'		=> $nNode,
                    'time'		=> $nTime,
                    'rand'		=> $nRandV,
                ];
        }

        return intval( $nRet );
    }

    /**
     *	Parse an unique id
     *
     *	@param $nId int		64 bits unique id
     *	@return array		details about the id
     */
    public function parseId( $nId )
    {
        if ( ! is_numeric( $nId ) || $nId <= 0 )
        {
            return null;
        }

        //	...
        $nCenter	= ( ( $nId & 0x00000000003E0000 ) >> 17 );
        $nNode		= ( ( $nId & 0x000000000001F000 ) >> 12 );
        $nTime		= ( ( $nId & 0x7FFFFFFFFFC00000 ) >> 22 );
        $nRand		= ( ( $nId & 0x0000000000000FFF ) >> 0  );

        return
            [
                'center'	=> $nCenter,
                'node'		=> $nNode,
                'time'		=> $nTime,
                'rand'		=> $nRand,
            ];
    }

    /**
     *	Verify whether the id is valid
     *
     *	@param $nVal int	64 bits unique id
     *	@return boolean		true or false
     */
    public function isValidId( $nVal )
    {
        $bRet	= false;
        $arrD	= $this->parseId( $nVal );
        if ( is_array( $arrD ) &&
            array_key_exists( 'center', $arrD ) &&
            array_key_exists( 'node', $arrD ) &&
            array_key_exists( 'time', $arrD ) &&
            array_key_exists( 'rand', $arrD ) )
        {
            if ( $this->isValidCenterId( $arrD[ 'center' ] ) &&
                $this->isValidNodeId( $arrD[ 'node' ] ) &&
                $this->isValidTime( $arrD[ 'time' ] ) &&
                $this->isValidRand( $arrD[ 'rand' ] ) )
            {
                $bRet = true;
            }
        }

        return $bRet;
    }


    /**
     * @param $nVal
     * @return bool
     */
    public function isValidCenterId( $nVal )
    {
        return is_numeric( $nVal ) && ( $nVal >= 0 ) && ( $nVal <= 31 );
    }

    /**
     * @param $nVal
     * @return bool
     */
    public function isValidNodeId( $nVal )
    {
        return is_numeric( $nVal ) && ( $nVal >= 0 ) && ( $nVal <= 31 );
    }

    /**
     * @param $nVal
     * @return bool
     */
    public function isValidTime( $nVal )
    {
        return is_numeric( $nVal ) && ( $nVal >= 0 );
    }

    /**
     * @param $nVal
     * @return bool
     */
    public function isValidRand( $nVal )
    {
        return is_numeric( $nVal ) && ( $nVal >= 0 ) && ( $nVal <= 0xFFF );
    }


    /**
     *	Get UNIX timestamp in millisecond
     *
     *	@return false|float    Timestamp in millisecond, for example: 1501780592275
     */
    public function getUnixTimestamp()
    {
        return floor( microtime( true ) * 1000 );
    }

    /**
     *	Get escaped time in millisecond
     *
     *	@return int	time in millisecond
     */
    public function getEscapedTime()
    {
        return intval( $this->getUnixTimestamp() - self::EPOCH_OFFSET );
    }
}


1			<?php
2			namespace tinymeng\tools;
3			/**
4			*
5			* STRUCTURE
6			* ================================================================================
7			*
8			* 0 xxxxxxxx xxxxxxxx xxxxxxxx xxxxxxxx xxxxxxxx x xxxxx xxxxx xxxx xxxxxxxx
9			* - ---------------------------------------------- ----- ----- -----------
10			* Escaped Time (in millisecond) Center Node Random
11			* 1 41 bits 5 5 12 bits
12			* 0~69 (years) 0~32 0~32 0~4095
13			*
14			*
15			* Center
16			* 0 00000000 00000000 00000000 00000000 00000000 0 11111 00000 0000 00000000
17			* 00000000 00000000 00000000 00000000 00000000 00111110 00000000 00000000
18			* 00 00 00 00 00 3E 00 00
19			*
20			* Node
21			* 0 00000000 00000000 00000000 00000000 00000000 0 00000 11111 0000 00000000
22			* 00000000 00000000 00000000 00000000 00000000 00000001 11110000 00000000
23			* 00 00 00 00 00 01 F0 00
24			*
25			* Escaped Time
26			* 0 11111111 11111111 11111111 11111111 11111111 1 00000 00000 0000 00000000
27			* 01111111 11111111 11111111 11111111 11111111 11000000 00000000 00000000
28			* 7F FF FF FF FF C0 00 00
29			*
30			* Random
31			* 0 00000000 00000000 00000000 00000000 00000000 0 00000 00000 1111 11111111
32			* 00000000 00000000 00000000 00000000 00000000 00000000 00001111 11111111
33			* 00 00 00 00 00 00 0F FF
34			*
35			* php -r 'echo dechex( 0b00111111 );'
36			*/
37			class UniqueId{
38
39
40			protected static $g_cInstanceDId;
41
42			/**
43			* Offset from Unix Epoch
44			*
45			* Unix Epoch : January 1, 1970 00:00:00 GMT
46			* Epoch Offset : November 7, 2016 00:00:00 GMT
47			*/
48			CONST EPOCH_OFFSET = 1478476800000;
49
50			/**
51			* __construct
52			*/
53			public function __construct(){}
54
55			/**
56			* __destruct
57			*/
58			public function __destruct(){}
59
60			/**
61			* getInstance
62			* @return self
63			*/
64			static function getInstance()
			0 ignored issues – show Best Practice introduced 2024-11-11 02:23 UTC by Report Bug Copy Issue Report It is generally recommended to explicitly declare the visibility for methods. Adding explicit visibility (`private`, `protected`, or `public`) is generally recommend to communicate to other developers how, and from where this method is intended to be used. Loading history...
65			{
66			if ( is_null( self::$g_cInstanceDId ) \|\| ! isset( self::$g_cInstanceDId ) )
67			{
68			self::$g_cInstanceDId = new self();
69			}
70			return self::$g_cInstanceDId;
71			}
72
73
74			/**
75			* Generate an unique id
76			*
77			* @param $nCenter int data center id ( 0 ~ 31 )
78			* @param $nNode int data node id ( 0 ~ 31 )
79			* @param $sSource string source string for calculating crc32 hash value
80			* @param $arrData &array details about the id
			0 ignored issues – show Documentation Bug introduced 2024-11-11 02:23 UTC by Report Bug Copy Issue Report The doc comment `&array` at position `0` could not be parsed: Unknown type name '&' at position 0 in &array. Loading history...
81			* @return int(64) id
82			*/
83			public function createId( $nCenter, $nNode, $sSource = null, & $arrData = null )
84			{
85			if ( ! $this->isValidCenterId( $nCenter ) )
86			{
87			return null;
88			}
89			if ( ! $this->isValidNodeId( $nNode ) )
90			{
91			return null;
92			}
93
94			// ...
95			$nRet = 0;
			0 ignored issues – show Unused Code introduced 2024-11-11 02:23 UTC by Report Bug Copy Issue Report The assignment to `$nRet` is dead and can be removed. Loading history...
96			$nTime = $this->getEscapedTime();
97
98			if ( is_string( $sSource ) && strlen( $sSource ) > 0 )
99			{
100			// use crc32 hash value instead of rand
101			$nRand = crc32( $sSource );
102			}
103			else
104			{
105			// 0 ~ 4095
106			$nRand = rand( 0, 0xFFF );
107			}
108
109			// ...
110			$nCenterV = ( ( $nCenter << 17 ) & 0x00000000003E0000 );
111			$nNodeV = ( ( $nNode << 12 ) & 0x000000000001F000 );
112			$nTimeV = ( ( $nTime << 22 ) & 0x7FFFFFFFFFC00000 );
113			$nRandV = ( ( $nRand << 0 ) & 0x0000000000000FFF );
114
115			$nRet = ( $nCenterV + $nNodeV + $nTimeV + $nRandV );
116
117			// ...
118			if ( ! is_null( $arrData ) )
119			{
120			$arrData =
121			[
122			'center' => $nCenter,
123			'node' => $nNode,
124			'time' => $nTime,
125			'rand' => $nRandV,
126			];
127			}
128
129			return intval( $nRet );
130			}
131
132			/**
133			* Parse an unique id
134			*
135			* @param $nId int 64 bits unique id
136			* @return array details about the id
137			*/
138			public function parseId( $nId )
139			{
140			if ( ! is_numeric( $nId ) \|\| $nId <= 0 )
141			{
142			return null;
143			}
144
145			// ...
146			$nCenter = ( ( $nId & 0x00000000003E0000 ) >> 17 );
147			$nNode = ( ( $nId & 0x000000000001F000 ) >> 12 );
148			$nTime = ( ( $nId & 0x7FFFFFFFFFC00000 ) >> 22 );
149			$nRand = ( ( $nId & 0x0000000000000FFF ) >> 0 );
150
151			return
152			[
153			'center' => $nCenter,
154			'node' => $nNode,
155			'time' => $nTime,
156			'rand' => $nRand,
157			];
158			}
159
160			/**
161			* Verify whether the id is valid
162			*
163			* @param $nVal int 64 bits unique id
164			* @return boolean true or false
165			*/
166			public function isValidId( $nVal )
167			{
168			$bRet = false;
169			$arrD = $this->parseId( $nVal );
170			if ( is_array( $arrD ) &&
171			array_key_exists( 'center', $arrD ) &&
172			array_key_exists( 'node', $arrD ) &&
173			array_key_exists( 'time', $arrD ) &&
174			array_key_exists( 'rand', $arrD ) )
175			{
176			if ( $this->isValidCenterId( $arrD[ 'center' ] ) &&
177			$this->isValidNodeId( $arrD[ 'node' ] ) &&
178			$this->isValidTime( $arrD[ 'time' ] ) &&
179			$this->isValidRand( $arrD[ 'rand' ] ) )
180			{
181			$bRet = true;
182			}
183			}
184
185			return $bRet;
186			}
187
188
189			/**
190			* @param $nVal
191			* @return bool
192			*/
193			public function isValidCenterId( $nVal )
194			{
195			return is_numeric( $nVal ) && ( $nVal >= 0 ) && ( $nVal <= 31 );
196			}
197
198			/**
199			* @param $nVal
200			* @return bool
201			*/
202			public function isValidNodeId( $nVal )
203			{
204			return is_numeric( $nVal ) && ( $nVal >= 0 ) && ( $nVal <= 31 );
205			}
206
207			/**
208			* @param $nVal
209			* @return bool
210			*/
211			public function isValidTime( $nVal )
212			{
213			return is_numeric( $nVal ) && ( $nVal >= 0 );
214			}
215
216			/**
217			* @param $nVal
218			* @return bool
219			*/
220			public function isValidRand( $nVal )
221			{
222			return is_numeric( $nVal ) && ( $nVal >= 0 ) && ( $nVal <= 0xFFF );
223			}
224
225
226			/**
227			* Get UNIX timestamp in millisecond
228			*
229			* @return false\|float Timestamp in millisecond, for example: 1501780592275
230			*/
231			public function getUnixTimestamp()
232			{
233			return floor( microtime( true ) * 1000 );
234			}
235
236			/**
237			* Get escaped time in millisecond
238			*
239			* @return int time in millisecond
240			*/
241			public function getEscapedTime()
242			{
243			return intval( $this->getUnixTimestamp() - self::EPOCH_OFFSET );
244			}
245			}
246

majiameng / tools

Push — master ( 23e15f...93b7a9 )

UniqueId::isValidCenterId() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like