Passed
Pull Request — master (#3)
by Akpé Aurelle Emmanuel Moïse
01:38
created

Shortcut::GetTheRightExceptionMessage()   A

Complexity

Conditions 4
Paths 3

Size

Total Lines 8
Code Lines 5

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
cc 4
eloc 5
nc 3
nop 3
dl 0
loc 8
rs 10
c 0
b 0
f 0
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 ="This is internal and thus sucks we must do something ClassShortcutDesigner";
21
        private static $DIR=null;
22
        
23
        public static function create($classname, $name=self::CAN_NEVER_EVER_CHOOSE_THIS_AS_FUNCTION_NAME)
24
        {
25
            if (is_string($classname)&&class_exists($classname, true)) {
26
                $reflectionClass=new \reflectionClass($classname);
27
                $classname=$reflectionClass->getName();
28
                $fullQualifiedClassname=str_replace('\\', '_', $classname);
29
                if ($Dir=self::$DIR) {
30
                    $file=self::$DIR.DIRECTORY_SEPARATOR.$fullQualifiedClassname.".Shortcut.php";
31
                } else {
32
                    $Dir=dirname(__DIR__).DIRECTORY_SEPARATOR.'ClassShortcuts';
33
                    $file=$Dir.DIRECTORY_SEPARATOR.$fullQualifiedClassname.".Shortcut.php";
34
                }
35
                $fileExists=file_exists($file);
36
                if (!function_exists($classname)&&!function_exists($name)) {
37
                    if (!$fileExists) {
38
                        $name=trim($name);
39
                        if (!file_exists($Dir)) {
40
                            mkdir($Dir);
41
                        }
42
                        $reflectionMethod=$reflectionClass->getConstructor();
43
                        $notInstantiable=false;
44
                        if (is_null($reflectionMethod)||$notInstantiable=!$reflectionClass->isInstantiable()) {
45
                            if ($notInstantiable) {
46
                                throw new \InvalidArgumentException('Not Instantiable class '.$fullQualifiedClassname.' passed as Argument');
47
                            } else {
48
                                self::useTheRightName($Shortcut, $name, $fullQualifiedClassname, '');
49
                                
50
                                $Shortcut.="return new $classname();
51
                                        }";
52
                                return self::pushAndShow($file, $Shortcut);
53
                            }
54
                        }
55
                        self::getSignature($reflectionMethod, $signature, $parameters, $paramsNum, $count);
56
                        
57
                        $hasInternal='';
58
                        if ($count) {
59
                            self::BuildTheSwitch($hasInternal, $count, $paramsNum, $parameters, $classname);
60
                        }
61
                        self::useTheRightName($Shortcut, $name, $fullQualifiedClassname, $signature);
62
                        
63
                        self::handleInternals($Shortcut, $hasInternal, $parameters, $signature, $classname);
64
                            
65
                        return self::pushAndShow($file, $Shortcut);
66
                    } else {
67
                        return include_once($file);
68
                    }
69
                } else {
70
                    self::GetTheRightExceptionMessage($fileExists, $name, $fullQualifiedClassname);
71
                }
72
            }
73
        }
74
75
        private static function getSignature(\ReflectionMethod $method, &$signature, &$parameters, &$paramsNum, &$count)
76
        {
77
            $params=$method->getParameters();
78
            $paramsNum=count($params);
79
            $signature='';
80
            $parameters=array();
81
            $count=0;
82
            foreach ($params as $k=>$param) {
83
                if ($param->isPassedByReference()) {
84
                    $tmp='&$'.$param->getName();
85
                } else {
86
                    $tmp='$'.$param->getName();
87
                }
88
89
                if ($param->isOptional()) {
90
                    $count++;
91
                    if ($method->isInternal()) {
92
                        $tmp.='="This is internal and thus sucks we must do something ClassShortcutDesigner"';
93
                    } elseif ($param->isDefaultValueConstant()) {
94
                        $tmp.='='.$param->getDefaultValueConstantName();
95
                    } elseif ($param->isDefaultValueAvailable()) {
96
                        $tmp.='='.var_export($param->getDefaultValue(), true);
97
                    } elseif ($param->allowsNull()) {
98
                        $tmp.='=null';
99
                    }
100
                }
101
                
102
                $signature.=$tmp;
103
                $parameters[]='$'.$param->getName();
104
                $tmp='';
105
                if ($k<$paramsNum-1) {
106
                    $signature.=',';
107
                }
108
            }
109
        }
110
        private static function BuildTheSwitch(&$hasInternal, $count, $paramsNum, $parameters, $classname)
111
        {
112
            $hasInternal.='switch($count){';
113
            while ($count>0) {
114
                $hasInternal.="case $count:return new $classname(".join(',', array_slice($parameters, 0, $paramsNum-$count))."); break;";
115
                $count--;
116
            }
117
            $hasInternal.='default:return new '. $classname.'('.join(',', $parameters).');break;}';
118
        }
119
        
120
        private static function useTheRightName(&$Shortcut, $name, $fullQualifiedClassname, $signature)
121
        {
122
            if (strtolower($name)!=='new'&&preg_match(self::VALID_PHP_FUNCTION_NAME_PATTERN, $name)) {
123
                $Shortcut="<?php
124
							function $name($signature){";
125
            } else {
126
                $Shortcut="<?php
127
							function $fullQualifiedClassname($signature){";
128
            }
129
        }
130
        
131
        private static function handleInternals(&$Shortcut, $hasInternal, $parameters, $signature, $classname)
132
        {
133
            if (!strpos($signature, "This is internal and thus sucks we must do something ClassShortcutDesigner")) {
134
                $Shortcut.="return new $classname(".join(',', $parameters).");
135
							}";
136
            } else {
137
                $Shortcut.='
138
							$count=count(array_keys(get_defined_vars(),"'.self::PLACEHOLDER_FOR_INTERNALS_CLASSES_OPTIONALS_PARAMETERS.'"));
139
							'.$hasInternal.'
140
							}';
141
            }
142
        }
143
        
144
        private static function pushAndShow($file, $Shortcut)
145
        {
146
            file_put_contents($file, str_replace("\t", '    ', $Shortcut));
147
            file_put_contents($file, php_strip_whitespace($file));//just for cleanliness of the generated code
148
            return include_once($file);
149
        }
150
        
151
        private static function GetTheRightExceptionMessage($fileExists, $name, $fullQualifiedClassname)
152
        {
153
            if (!$fileExists) {
154
                if (strtolower($name)!=='new'&&preg_match(self::VALID_PHP_FUNCTION_NAME_PATTERN, $name)) {
155
                    throw new \InvalidArgumentException('function '.$name.' passed as second Argument already exists.
156
					Can\'t create a shortcut with the same name');
157
                } else {
158
                    throw new \InvalidArgumentException('function '.$fullQualifiedClassname.' already exists and An alias has not been provided as Argument 2.
159
					Can\'t create a shortcut function with this name');
160
                }
161
            }
162
        }
163
        
164
        public static function setDir($dirname)
165
        {
166
            if (is_dir($dirname)&&is_writable($dirname)&&!self::$DIR) {
167
                self::$DIR=$dirname;
168
            }
169
        }
170
        
171
        
172
        private function __construct()
173
        {
174
        }
175
    }
176
}
177
178
namespace{
179
    function create_Shortcut($classname, $name='new')
180
    {
181
        return EZAMA\Shortcut::create($classname, $name);
182
    }
183
}
184