Shortcut::getParameterDeclaration() - Code Metrics - Inspection of "refactoring" - manuwhat/shortcut - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( bba7e0...4f7625 )

by Akpé Aurelle Emmanuel Moïse

created 2019-04-18 11:27 UTC

Shortcut::getParameterDeclaration() B

↳ Parent: Project

Complexity

Conditions	7
Paths	12

Size

Total Lines	18
Code Lines	14

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	7
eloc	14
nc	12
nop	4
dl	0
loc	18
rs	8.8333
c	0
b	0
f	0

<?php
namespace EZAMA

/**
*
* @Name : Shortcut
* @Version : 1.0.0
* @Programmer : Akpé Aurelle Emmanuel Moïse Zinsou
* @Date : 2019-04-01
* @Released under : https://github.com/manuwhat/Shortcut/blob/master/LICENSE
* @Repository : https://github.com/manuwhat/Shortcut
*
**/
{

    class Shortcut
    {
        const VALID_PHP_FUNCTION_NAME_PATTERN='#^[a-zA-Z_\x7f-\xff][a-zA-Z0-9_\x7f-\xff]*$#';
        const CAN_NEVER_EVER_CHOOSE_THIS_AS_FUNCTION_NAME="new";
        const PLACEHOLDER_FOR_INTERNALS_CLASSES_OPTIONALS_PARAMETERS="acce91966cd8eee995ee1ac30c98c3d89d8f9235";
        private static $DIR=null;
        private static $SHORTCUT_FOR_ALL=false;
        
        public static function SetShortcutForAll($bool)
        {
            self::$SHORTCUT_FOR_ALL=(bool)$bool;
        }
        public static function create($classname, $name=self::CAN_NEVER_EVER_CHOOSE_THIS_AS_FUNCTION_NAME)
        {
            if (is_string($classname)&&class_exists($classname, true)) {
                $reflectionClass=new \reflectionClass($classname);
                $classname=$reflectionClass->getName();
                $fullQualifiedClassname=str_replace('\\', '_', $classname);
                self::getTheRightDir($file, $Dir, $fullQualifiedClassname);
                $fileExists=file_exists($file);
                if (!function_exists($classname)&&!function_exists($name)) {
                    if (!$fileExists) {
                        $private_scope=false;
                        $name=trim($name);
                        self::createDir($Dir);
                        $reflectionMethod=$reflectionClass->getConstructor();
                        $notInstantiable=false;
                        if (is_null($reflectionMethod)||$notInstantiable=!$reflectionClass->isInstantiable()) {
                            self::HandleNotInstantiableAndHasNoConstructor($Shortcut, $fullQualifiedClassname, $name, $notInstantiable, $classname);
                            if ($Shortcut) {
                                return self::pushAndShow($file, $Shortcut);
                            }
                            $private_scope=true;
                        }
                        
                        self::getSignature($reflectionMethod, $signature, $parameters, $paramsNum, $count);
                        
                        $hasInternal='';
                        if ($count) {
                            self::BuildTheSwitch($hasInternal, $count, $paramsNum, $parameters, $classname);
                        }
                        self::useTheRightNameAndScope($Shortcut, $name, $fullQualifiedClassname, $signature, $private_scope, $classname);
                        
                        self::handleInternals($Shortcut, $hasInternal, $parameters, $signature, $classname);
                            
                        return self::pushAndShow($file, $Shortcut);
                    } else {
                        return include_once($file);
                    }
                } else {
                    self::GetTheRightExceptionMessage($fileExists, $name, $fullQualifiedClassname);
                }
            }
        }

        private static function getSignature(\ReflectionMethod $method, &$signature, &$parameters, &$paramsNum, &$count)
        {
            $params=$method->getParameters();
            $paramsNum=count($params);
            $signature='';
            $parameters=array();
            $count=0;
            foreach ($params as $k=>$param) {
                self::getParameterDeclaration($param, $tmp, $count, $method);
                $signature.=$tmp;
                $parameters[]='$'.$param->getName();
                $tmp='';
                if ($k<$paramsNum-1) {
                    $signature.=',';
                }
            }
        }
        
        private static function getParameterDeclaration(\reflectionParameter $param, &$tmp, &$count,$method)
        {
            if ($param->isPassedByReference()) {
                $tmp='&$'.$param->getName();
            } else {
                $tmp='$'.$param->getName();
            }

            if ($param->isOptional()) {
                $count++;
                if ($method->isInternal()) {
                    $tmp.='="acce91966cd8eee995ee1ac30c98c3d89d8f9235"';
                } elseif ($param->isDefaultValueConstant()) {
                    $tmp.='='.$param->getDefaultValueConstantName();
                } elseif ($param->isDefaultValueAvailable()) {
                    $tmp.='='.var_export($param->getDefaultValue(), true);
                } elseif ($param->allowsNull()) {
                    $tmp.='=null';
                }
            }
        }
        
        private static function BuildTheSwitch(&$hasInternal, $count, $paramsNum, $parameters, $classname)
        {
            $hasInternal.='switch($count){';
            while ($count>0) {
                $hasInternal.="case $count:return new $classname(".join(',', array_slice($parameters, 0, $paramsNum-$count))."); break;";
                $count--;
            }
            $hasInternal.='default:return new '.$classname.'('.join(',', $parameters).');break;}';
        }
        
        private static function useTheRightNameAndScope(&$Shortcut, $name, $fullQualifiedClassname, $signature, $scope, $classname)
        {
            if (strtolower($name)!=='new'&&preg_match(self::VALID_PHP_FUNCTION_NAME_PATTERN, $name)) {
                $Shortcut="<?php
							function $name($signature){";
                if ($scope) {
                    $Shortcut.="if(".'@get_class()'."!==$classname){
									throw new scopeException(\"Shortcut function $name can only be called in class $classname scope\");
								}";
                }
            } else {
                $Shortcut="<?php
							function $fullQualifiedClassname($signature){";
                if ($scope) {
                    $Shortcut.="if(@get_class()!==\"$classname\"){
							throw new scopeException(\"Shortcut function $fullQualifiedClassname can only be called in class $classname scope\");
						}";
                }
            }
        }
        
        private static function handleInternals(&$Shortcut, $hasInternal, $parameters, $signature, $classname)
        {
            if (!strpos($signature, "acce91966cd8eee995ee1ac30c98c3d89d8f9235")) {
                $Shortcut.="return new $classname(".join(',', $parameters).");
							}";
            } else {
                $Shortcut.='
							$count=count(array_keys(get_defined_vars(),"'.self::PLACEHOLDER_FOR_INTERNALS_CLASSES_OPTIONALS_PARAMETERS.'"));
							'.$hasInternal.'
							}';
            }
        }
        
        private static function pushAndShow($file, $Shortcut)
        {
            file_put_contents($file, str_replace("\t", '    ', $Shortcut));
            file_put_contents($file, php_strip_whitespace($file)); //just for cleanliness of the generated code
            return include_once($file);
        }
        
        private static function GetTheRightExceptionMessage($fileExists, $name, $fullQualifiedClassname)
        {
            if (!$fileExists) {
                if (strtolower($name)!=='new'&&preg_match(self::VALID_PHP_FUNCTION_NAME_PATTERN, $name)) {
                    throw new \InvalidArgumentException('function '.$name.' passed as second Argument already exists.
					Can\'t create a shortcut with the same name');
                } else {
                    throw new \InvalidArgumentException('function '.$fullQualifiedClassname.' already exists and An alias has not been provided as Argument 2.
					Can\'t create a shortcut function with this name');
                }
            }
        }
        
        private static function HandleNotInstantiableAndHasNoConstructor(&$Shortcut, $fullQualifiedClassname, $name, $notInstantiable, $classname)
        {
            if ($notInstantiable) {
                if (!self::$SHORTCUT_FOR_ALL) {
                    throw new \InvalidArgumentException('Not Instantiable class '.$fullQualifiedClassname.' passed as Argument');
                }
            } else {
                self::useTheRightNameAndScope($Shortcut, $name, $fullQualifiedClassname, '', false, $classname);
                $Shortcut.="return new $classname();
						}";
            }
        }
        
        private static function getTheRightDir(&$file, &$Dir, $fullQualifiedClassname)
        {
            if ($Dir=self::$DIR) {
                $file=self::$DIR.DIRECTORY_SEPARATOR.$fullQualifiedClassname.".Shortcut.php";
            } else {
                $Dir=dirname(__DIR__).DIRECTORY_SEPARATOR.'ClassShortcuts';
                $file=$Dir.DIRECTORY_SEPARATOR.$fullQualifiedClassname.".Shortcut.php";
            }
        }
        
        private static function createDir($Dir)
        {
            if (!file_exists($Dir)) {
                mkdir($Dir);
            }
        }
        
        
        
        public static function setDir($dirname)
        {
            if (is_dir($dirname)&&is_writable($dirname)&&!self::$DIR) {
                self::$DIR=$dirname;
            }
        }
        
        
        private function __construct()
        {
        }
    }
    
    
}

namespace{
    function create_Shortcut($classname, $name='new')
    {
        return EZAMA\Shortcut::create($classname, $name);
    }
    class scopeException extends \Exception
    {
    }
}


1			<?php
2			namespace EZAMA
3
4			/**
5			*
6			* @Name : Shortcut
7			* @Version : 1.0.0
8			* @Programmer : Akpé Aurelle Emmanuel Moïse Zinsou
9			* @Date : 2019-04-01
10			* @Released under : https://github.com/manuwhat/Shortcut/blob/master/LICENSE
11			* @Repository : https://github.com/manuwhat/Shortcut
12			*
13			**/
14			{
15
16			class Shortcut
17			{
18			const VALID_PHP_FUNCTION_NAME_PATTERN='#^[a-zA-Z_\x7f-\xff][a-zA-Z0-9_\x7f-\xff]*$#';
19			const CAN_NEVER_EVER_CHOOSE_THIS_AS_FUNCTION_NAME="new";
20			const PLACEHOLDER_FOR_INTERNALS_CLASSES_OPTIONALS_PARAMETERS="acce91966cd8eee995ee1ac30c98c3d89d8f9235";
21			private static $DIR=null;
22			private static $SHORTCUT_FOR_ALL=false;
23
24			public static function SetShortcutForAll($bool)
25			{
26			self::$SHORTCUT_FOR_ALL=(bool)$bool;
27			}
28			public static function create($classname, $name=self::CAN_NEVER_EVER_CHOOSE_THIS_AS_FUNCTION_NAME)
29			{
30			if (is_string($classname)&&class_exists($classname, true)) {
31			$reflectionClass=new \reflectionClass($classname);
32			$classname=$reflectionClass->getName();
33			$fullQualifiedClassname=str_replace('\\', '_', $classname);
34			self::getTheRightDir($file, $Dir, $fullQualifiedClassname);
35			$fileExists=file_exists($file);
36			if (!function_exists($classname)&&!function_exists($name)) {
37			if (!$fileExists) {
38			$private_scope=false;
39			$name=trim($name);
40			self::createDir($Dir);
41			$reflectionMethod=$reflectionClass->getConstructor();
42			$notInstantiable=false;
43			if (is_null($reflectionMethod)\|\|$notInstantiable=!$reflectionClass->isInstantiable()) {
44			self::HandleNotInstantiableAndHasNoConstructor($Shortcut, $fullQualifiedClassname, $name, $notInstantiable, $classname);
45			if ($Shortcut) {
46			return self::pushAndShow($file, $Shortcut);
47			}
48			$private_scope=true;
49			}
50
51			self::getSignature($reflectionMethod, $signature, $parameters, $paramsNum, $count);
52
53			$hasInternal='';
54			if ($count) {
55			self::BuildTheSwitch($hasInternal, $count, $paramsNum, $parameters, $classname);
56			}
57			self::useTheRightNameAndScope($Shortcut, $name, $fullQualifiedClassname, $signature, $private_scope, $classname);
58
59			self::handleInternals($Shortcut, $hasInternal, $parameters, $signature, $classname);
60
61			return self::pushAndShow($file, $Shortcut);
62			} else {
63			return include_once($file);
64			}
65			} else {
66			self::GetTheRightExceptionMessage($fileExists, $name, $fullQualifiedClassname);
67			}
68			}
69			}
70
71			private static function getSignature(\ReflectionMethod $method, &$signature, &$parameters, &$paramsNum, &$count)
72			{
73			$params=$method->getParameters();
74			$paramsNum=count($params);
75			$signature='';
76			$parameters=array();
77			$count=0;
78			foreach ($params as $k=>$param) {
79			self::getParameterDeclaration($param, $tmp, $count, $method);
80			$signature.=$tmp;
81			$parameters[]='$'.$param->getName();
82			$tmp='';
83			if ($k<$paramsNum-1) {
84			$signature.=',';
85			}
86			}
87			}
88
89			private static function getParameterDeclaration(\reflectionParameter $param, &$tmp, &$count,$method)
90			{
91			if ($param->isPassedByReference()) {
92			$tmp='&$'.$param->getName();
93			} else {
94			$tmp='$'.$param->getName();
95			}
96
97			if ($param->isOptional()) {
98			$count++;
99			if ($method->isInternal()) {
100			$tmp.='="acce91966cd8eee995ee1ac30c98c3d89d8f9235"';
101			} elseif ($param->isDefaultValueConstant()) {
102			$tmp.='='.$param->getDefaultValueConstantName();
103			} elseif ($param->isDefaultValueAvailable()) {
104			$tmp.='='.var_export($param->getDefaultValue(), true);
105			} elseif ($param->allowsNull()) {
106			$tmp.='=null';
107			}
108			}
109			}
110
111			private static function BuildTheSwitch(&$hasInternal, $count, $paramsNum, $parameters, $classname)
112			{
113			$hasInternal.='switch($count){';
114			while ($count>0) {
115			$hasInternal.="case $count:return new $classname(".join(',', array_slice($parameters, 0, $paramsNum-$count))."); break;";
116			$count--;
117			}
118			$hasInternal.='default:return new '.$classname.'('.join(',', $parameters).');break;}';
119			}
120
121			private static function useTheRightNameAndScope(&$Shortcut, $name, $fullQualifiedClassname, $signature, $scope, $classname)
122			{
123			if (strtolower($name)!=='new'&&preg_match(self::VALID_PHP_FUNCTION_NAME_PATTERN, $name)) {
124			$Shortcut="<?php
125			function $name($signature){";
126			if ($scope) {
127			$Shortcut.="if(".'@get_class()'."!==$classname){
128			throw new scopeException(\"Shortcut function $name can only be called in class $classname scope\");
129			}";
130			}
131			} else {
132			$Shortcut="<?php
133			function $fullQualifiedClassname($signature){";
134			if ($scope) {
135			$Shortcut.="if(@get_class()!==\"$classname\"){
136			throw new scopeException(\"Shortcut function $fullQualifiedClassname can only be called in class $classname scope\");
137			}";
138			}
139			}
140			}
141
142			private static function handleInternals(&$Shortcut, $hasInternal, $parameters, $signature, $classname)
143			{
144			if (!strpos($signature, "acce91966cd8eee995ee1ac30c98c3d89d8f9235")) {
145			$Shortcut.="return new $classname(".join(',', $parameters).");
146			}";
147			} else {
148			$Shortcut.='
149			$count=count(array_keys(get_defined_vars(),"'.self::PLACEHOLDER_FOR_INTERNALS_CLASSES_OPTIONALS_PARAMETERS.'"));
150			'.$hasInternal.'
151			}';
152			}
153			}
154
155			private static function pushAndShow($file, $Shortcut)
156			{
157			file_put_contents($file, str_replace("\t", ' ', $Shortcut));
158			file_put_contents($file, php_strip_whitespace($file)); //just for cleanliness of the generated code
159			return include_once($file);
160			}
161
162			private static function GetTheRightExceptionMessage($fileExists, $name, $fullQualifiedClassname)
163			{
164			if (!$fileExists) {
165			if (strtolower($name)!=='new'&&preg_match(self::VALID_PHP_FUNCTION_NAME_PATTERN, $name)) {
166			throw new \InvalidArgumentException('function '.$name.' passed as second Argument already exists.
167			Can\'t create a shortcut with the same name');
168			} else {
169			throw new \InvalidArgumentException('function '.$fullQualifiedClassname.' already exists and An alias has not been provided as Argument 2.
170			Can\'t create a shortcut function with this name');
171			}
172			}
173			}
174
175			private static function HandleNotInstantiableAndHasNoConstructor(&$Shortcut, $fullQualifiedClassname, $name, $notInstantiable, $classname)
176			{
177			if ($notInstantiable) {
178			if (!self::$SHORTCUT_FOR_ALL) {
179			throw new \InvalidArgumentException('Not Instantiable class '.$fullQualifiedClassname.' passed as Argument');
180			}
181			} else {
182			self::useTheRightNameAndScope($Shortcut, $name, $fullQualifiedClassname, '', false, $classname);
183			$Shortcut.="return new $classname();
184			}";
185			}
186			}
187
188			private static function getTheRightDir(&$file, &$Dir, $fullQualifiedClassname)
189			{
190			if ($Dir=self::$DIR) {
191			$file=self::$DIR.DIRECTORY_SEPARATOR.$fullQualifiedClassname.".Shortcut.php";
192			} else {
193			$Dir=dirname(__DIR__).DIRECTORY_SEPARATOR.'ClassShortcuts';
194			$file=$Dir.DIRECTORY_SEPARATOR.$fullQualifiedClassname.".Shortcut.php";
195			}
196			}
197
198			private static function createDir($Dir)
199			{
200			if (!file_exists($Dir)) {
201			mkdir($Dir);
202			}
203			}
204
205
206
207			public static function setDir($dirname)
208			{
209			if (is_dir($dirname)&&is_writable($dirname)&&!self::$DIR) {
210			self::$DIR=$dirname;
211			}
212			}
213
214
215			private function __construct()
216			{
217			}
218			}
219
220
221			}
222
223			namespace{
224			function create_Shortcut($classname, $name='new')
225			{
226			return EZAMA\Shortcut::create($classname, $name);
227			}
228			class scopeException extends \Exception
229			{
230			}
231			}
232

manuwhat / shortcut

Push — master ( bba7e0...4f7625 )

Shortcut::getParameterDeclaration() B

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like