App::prepare() - Code Metrics - Inspection of "updated config, services to lazyload -- changed se..." - zewadesign/framework - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#66)

unknown

created 2016-08-13 05:17 UTC

App::prepare() A

↳ Parent: App

Complexity

Conditions	1
Paths	1

Size

Total Lines	20
Code Lines	14

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes	8
Bugs	0	Features	0

Metric	Value
c	8
b	0
f	0
dl	0
loc	20
ccs	0
cts	15
cp	0
rs	9.4285
cc	1
eloc	14
nc	1
nop	0
crap	2

<?php

namespace Zewa;

use Zewa\Exception\LookupException;

/**
 * This class is the starting point for application
 *
 * <code>
 *
 * $out = new core\App();
 * print $out;
 *
 * </code>
 *
 * @author Zechariah Walden<zech @ zewadesign.com>
 */
class App
{
    /**
     * Reference to instantiated controller object.
     *
     * @var object
     */
    protected static $instance = false;

    /**
     * Available configuration files
     *
     * @var object
     */
    private $files;

    /**
     * System configuration
     *
     * @var object
     */
    public $configuration;

    /**
     * System service management
     *
     * @var object
     */
    private $services;

    /**
     * Events
     */
    private static $events;

    /**
     * Return value from application
     *
     * @var string
     */
    private $output = false;

    /**
     * Namespaced controller path
     *
     * @var string
     */
    private $class;

    /**
     * Instantiated class object
     *
     * @var string
     */
    private $instantiatedClass;

    /**
     * Module being accessed
     *
     * @var string
     */
    private $module;

    /**
     * Controller being accessed
     *
     * @var string
     */
    private $controller;

    /**
     * Method being accessed
     *
     * @var string
     */
    private $method;

    /**
     * Params being passed
     *
     * @var array
     */
    private $params;

    /**
     * Instantiated router class
     *
     * @var object
     */
    private $router;

    /**
     * Instantiated request class
     *
     * @var object
     */
    private $request;

    /**
     * Application bootstrap process
     *
     * The application registers the configuration in the app/config/core.php
     * and then processes, and makes available the configured resources
     */
    public function __construct()
    {
        self::$instance = $this;
        //@TODO: unset unnececessary vars/profile/unit testing..? how?
        //@TODO: better try/catch usage
        //@TODO: setup custom routing based on regex
        // (can't we get away without using regex tho?)!!!!!!! routesssssss!!!!!!!!
        $files = (object)glob(APP_PATH . DIRECTORY_SEPARATOR . 'Config' . DIRECTORY_SEPARATOR . '*.php');
        $oFiles = [];

        foreach ($files as $index => $filename) {
            $pieces = explode('/', $filename);
            $file = $pieces[count($pieces) - 1];
            $fileProperties = explode('.', $file);
            $currentFile = $fileProperties[0];
            $oFiles[$currentFile] = $filename;
        }

        $this->files = $oFiles;

        $this->configuration = new \stdClass();
    }

    /**
     * Calls the proper shell for app execution
     *
     * @access private
     */
    public function initialize()
    {
        $appConfig = $this->getConfiguration('app');

        if ($appConfig->environment == 'development') {
            ini_set('display_errors', 1);
            ini_set('display_startup_errors', 1);
            error_reporting(E_ALL);
        }

        $this->prepare();
        $this->start();

        return $this;
    }

    /**
     * App preparation cycle
     */
    private function prepare()
    {
        App::callEvent('preApplication');

        $this->registerSession();

        $this->router = new Router();
        $this->request = new Request();
        $this->database = new Database();
class MyClass { }

$x = new MyClass();
$x->foo = true;

        $this->setService('router', $this->router);
        $this->setService('request', $this->request);
        $this->setService('database', $this->database);

        $this->module = ucfirst($this->configuration->router->module);
        $this->controller = ucfirst($this->configuration->router->controller);
        $this->method = $this->configuration->router->method;
        $this->params = $this->configuration->router->params;
        $this->class = '\\App\\Modules\\' . $this->module . '\\Controllers\\' . ucfirst($this->controller);
    }

    private function prepareServices()
    {
        if (isset($this->files['services'])) {
            $services = include $this->files['services'];
            if ($services === false) {
                $this->services = [];

            } else {
                $this->services = (object)$services;
            }
        } else {
            throw new LookupException('No service configuration found.');
        }
    }

    public function getService($service, $new = false, $options = [])
    {
        if ($this->services === null) {
            $this->prepareServices();
        }

        if ($new === false) {
            return $this->services->$service;
        } elseif ($new === true || empty($this->services->$service)) {
            $this->services->$service = call_user_func_array($this->services->$service, $options);
            return $this->services->$service;
        }
    }

    public function setService($service, $class)
    {
        if ($this->services === null) {
            $this->prepareServices();
        }

        $this->services->$service = $class;
    }

    /**
     * @param mixed string with reference to config
     * @return mixed bool or config values
     */
    public function getConfiguration($config = null)
    {
        if ($config !== null) {
            if (! empty($this->configuration->$config)) {
                return $this->configuration->$config;
            } elseif (! empty($this->files{$config})) {
                $vars = include $this->files{$config};

                if ($vars === false) {
                    $this->configuration->{$config} = false;
                } else {
                    //turn array into object the dirty way?
                    $this->configuration->{$config} = json_decode(json_encode($vars));
                }

                return $this->configuration->$config;
            }

            return false;
        }

        return $this->configuration;
    }

    /**
     * @param $config mixed null|string
     * @param null|object|array optional array of configuration data
     *
     * @return bool
     * @throws Exception\StateException
     */
    public function setConfiguration($config = null, $configObject = null)
    {
        if ($config !== null && $configObject !== null && !empty($configObject)) {
            $this->configuration->$config = $configObject;
            return true;
        }

        throw new Exception\StateException('You must provide the configuration key, and its value.');
    }

    /**
     * Registers the session object
     *
     * @access private
     */
    private function registerSession()
    {
        $session = $this->getConfiguration('session');

        if ($session !== false) {
            App::callEvent('preSession');
            new SessionHandler(
                $session->interface,
                $session->securityCode,
                $session->expiration,
                $session->domain,
                $session->lockToUserAgent,
                $session->lockToIP,
                $session->gcProbability,
                $session->gcDivisor,
                $session->tableName
            );
            App::callEvent('postSession');
        }

        return;
    }

    /**
     * Verifies the provided application request is a valid request
     *
     * @access private
     */
    private function processRequest()
    {
        $moduleExist = file_exists(APP_PATH . '/Modules/' . $this->module);
        $classExist = class_exists($this->class);
        $methodExist = method_exists($this->class, $this->method);

        if (!$moduleExist || !$classExist || !$methodExist) {
            $view = new View();
            $this->output = $view->render404(['Invalid method requests']); //Router::show404(
            return false;
        }

        return true;
    }

    /**
     * Processes the application request
     *
     * @access private
     */
    private function start()
    {
        if (!$this->processRequest()) {
            return false;
        }

        App::callEvent('preController');
        $this->instantiatedClass = new $this->class();

        App::callEvent('postController');

        $this->output = call_user_func_array(
            array(&$this->instantiatedClass, $this->method),
            $this->params
        );
    }
    /**
     * Attach (or remove) multiple callbacks to an event and trigger those callbacks when that event is called.
     *
     * @param string $event    name
     * @param mixed  $value    the optional value to pass to each callback
     * @param mixed  $callback the method or function to call - FALSE to remove all callbacks for event
/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}
     */

    public static function addEvent($event, $callback = false)
    {
        // Adding or removing a callback?
        if ($callback !== false) {
            self::$events[$event][] = $callback;
        } else {
            unset(self::$events[$event]);
        }
    }

    public function callEvent($event, $method = false, $arguments = [])
    {
        if (isset(self::$events[$event])) {
            foreach (self::$events[$event] as $e) {
                if ($method !== false) { // class w/ method specified
                    $object = new $e();
                    $value = call_user_func_array(
                        [&$object, $method],
                        $arguments
                    );
                } else {
                    if (class_exists($e)) {
                        $value = new $e($arguments); // class w/o method specified
                    } else {
                        $value = call_user_func($e, $arguments); // function yuk
                    }
                }
            }

            return $value;
function myFunction($a) {
    switch ($a) {
        case 'foo':
            $x = 1;
            break;

        case 'bar':
            $x = 2;
            break;
    }

    // $x is potentially undefined here.
    echo $x;
}
        }
    }


    /**
     * Prepare application return value into a string
     *
     * @access public
     * @return string
     */
    public function __toString()
    {
        if (!$this->output) {
            $this->output = '';
        }

        App::callEvent('postApplication');

        return $this->output;
    }


    /**
     * Returns a reference of object once instantiated
     *
     * @access public
     * @return object
     */
    public static function getInstance()
    {
        if (self::$instance === null) {
            return false;
        }

        return self::$instance;
    }
}


1		<?php
2
3		namespace Zewa;
4
5		use Zewa\Exception\LookupException;
6
7		/**
8		* This class is the starting point for application
9		*
10		* <code>
11		*
12		* $out = new core\App();
13		* print $out;
14		*
15		* </code>
16		*
17		* @author Zechariah Walden<zech @ zewadesign.com>
18		*/
19		class App
20		{
21		/**
22		* Reference to instantiated controller object.
23		*
24		* @var object
25		*/
26		protected static $instance = false;
27
28		/**
29		* Available configuration files
30		*
31		* @var object
32		*/
33		private $files;
34
35		/**
36		* System configuration
37		*
38		* @var object
39		*/
40		public $configuration;
41
42		/**
43		* System service management
44		*
45		* @var object
46		*/
47		private $services;
48
49		/**
50		* Events
51		*/
52		private static $events;
53
54		/**
55		* Return value from application
56		*
57		* @var string
58		*/
59		private $output = false;
60
61		/**
62		* Namespaced controller path
63		*
64		* @var string
65		*/
66		private $class;
67
68		/**
69		* Instantiated class object
70		*
71		* @var string
72		*/
73		private $instantiatedClass;
74
75		/**
76		* Module being accessed
77		*
78		* @var string
79		*/
80		private $module;
81
82		/**
83		* Controller being accessed
84		*
85		* @var string
86		*/
87		private $controller;
88
89		/**
90		* Method being accessed
91		*
92		* @var string
93		*/
94		private $method;
95
96		/**
97		* Params being passed
98		*
99		* @var array
100		*/
101		private $params;
102
103		/**
104		* Instantiated router class
105		*
106		* @var object
107		*/
108		private $router;
109
110		/**
111		* Instantiated request class
112		*
113		* @var object
114		*/
115		private $request;
116
117		/**
118		* Application bootstrap process
119		*
120		* The application registers the configuration in the app/config/core.php
121		* and then processes, and makes available the configured resources
122		*/
123		public function __construct()
124		{
125		self::$instance = $this;
126		//@TODO: unset unnececessary vars/profile/unit testing..? how?
127		//@TODO: better try/catch usage
128		//@TODO: setup custom routing based on regex
129		// (can't we get away without using regex tho?)!!!!!!! routesssssss!!!!!!!!
130		$files = (object)glob(APP_PATH . DIRECTORY_SEPARATOR . 'Config' . DIRECTORY_SEPARATOR . '*.php');
131		$oFiles = [];
132
133		foreach ($files as $index => $filename) {
134		$pieces = explode('/', $filename);
135		$file = $pieces[count($pieces) - 1];
136		$fileProperties = explode('.', $file);
137		$currentFile = $fileProperties[0];
138		$oFiles[$currentFile] = $filename;
139		}
140
141		$this->files = $oFiles;
		0 ignored issues – show Documentation Bug introduced 2016-08-13 04:57 UTC by Report Bug Copy Issue Report It seems like `$oFiles` of type `array` is incompatible with the declared type `object` of property `$files`. Our type inference engine has found an assignment to a property that is incompatible with the declared type of that property. Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property.. Loading history...
142		$this->configuration = new \stdClass();
143		}
144
145		/**
146		* Calls the proper shell for app execution
147		*
148		* @access private
149		*/
150		public function initialize()
151		{
152		$appConfig = $this->getConfiguration('app');
153
154		if ($appConfig->environment == 'development') {
155		ini_set('display_errors', 1);
156		ini_set('display_startup_errors', 1);
157		error_reporting(E_ALL);
158		}
159
160		$this->prepare();
161		$this->start();
162
163		return $this;
164		}
165
166		/**
167		* App preparation cycle
168		*/
169		private function prepare()
170		{
171		App::callEvent('preApplication');
172
173		$this->registerSession();
174
175		$this->router = new Router();
176		$this->request = new Request();
177		$this->database = new Database();
		0 ignored issues – show Bug introduced 2016-08-13 01:11 UTC by Report Bug Copy Issue Report The property `database` does not exist. Did you maybe forget to declare it? In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code: class MyClass { } $x = new MyClass(); $x->foo = true; Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion: class MyClass { public $foo; } $x = new MyClass(); $x->foo = true; Loading history...
178
179		$this->setService('router', $this->router);
180		$this->setService('request', $this->request);
181		$this->setService('database', $this->database);
182
183		$this->module = ucfirst($this->configuration->router->module);
184		$this->controller = ucfirst($this->configuration->router->controller);
185		$this->method = $this->configuration->router->method;
186		$this->params = $this->configuration->router->params;
187		$this->class = '\\App\\Modules\\' . $this->module . '\\Controllers\\' . ucfirst($this->controller);
188		}
189
190		private function prepareServices()
191		{
192		if (isset($this->files['services'])) {
193		$services = include $this->files['services'];
194		if ($services === false) {
195		$this->services = [];
		0 ignored issues – show Documentation Bug introduced 2016-08-13 04:57 UTC by Report Bug Copy Issue Report It seems like `array()` of type `array` is incompatible with the declared type `object` of property `$services`. Our type inference engine has found an assignment to a property that is incompatible with the declared type of that property. Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property.. Loading history...
196		} else {
197		$this->services = (object)$services;
198		}
199		} else {
200		throw new LookupException('No service configuration found.');
201		}
202		}
203
204		public function getService($service, $new = false, $options = [])
205		{
206		if ($this->services === null) {
207		$this->prepareServices();
208		}
209
210		if ($new === false) {
211		return $this->services->$service;
212		} elseif ($new === true \|\| empty($this->services->$service)) {
213		$this->services->$service = call_user_func_array($this->services->$service, $options);
214		return $this->services->$service;
215		}
216		}
217
218		public function setService($service, $class)
219		{
220		if ($this->services === null) {
221		$this->prepareServices();
222		}
223
224		$this->services->$service = $class;
225		}
226
227		/**
228		* @param mixed string with reference to config
229		* @return mixed bool or config values
230		*/
231	28	public function getConfiguration($config = null)
232		{
233	28	if ($config !== null) {
234	28	if (! empty($this->configuration->$config)) {
235	28	return $this->configuration->$config;
236	1	} elseif (! empty($this->files{$config})) {
237	1	$vars = include $this->files{$config};
238
239	1	if ($vars === false) {
240		$this->configuration->{$config} = false;
241		} else {
242		//turn array into object the dirty way?
243	1	$this->configuration->{$config} = json_decode(json_encode($vars));
244		}
245
246	1	return $this->configuration->$config;
247		}
248
249		return false;
250		}
251
252		return $this->configuration;
253		}
254
255		/**
256		* @param $config mixed null\|string
257		* @param null\|object\|array optional array of configuration data
258		*
259		* @return bool
260		* @throws Exception\StateException
261		*/
262	18	public function setConfiguration($config = null, $configObject = null)
263		{
264	18	if ($config !== null && $configObject !== null && !empty($configObject)) {
265	18	$this->configuration->$config = $configObject;
266	18	return true;
267		}
268
269		throw new Exception\StateException('You must provide the configuration key, and its value.');
270		}
271
272		/**
273		* Registers the session object
274		*
275		* @access private
276		*/
277		private function registerSession()
278		{
279		$session = $this->getConfiguration('session');
280
281		if ($session !== false) {
282		App::callEvent('preSession');
283		new SessionHandler(
284		$session->interface,
285		$session->securityCode,
286		$session->expiration,
287		$session->domain,
288		$session->lockToUserAgent,
289		$session->lockToIP,
290		$session->gcProbability,
291		$session->gcDivisor,
292		$session->tableName
293		);
294		App::callEvent('postSession');
295		}
296
297		return;
298		}
299
300		/**
301		* Verifies the provided application request is a valid request
302		*
303		* @access private
304		*/
305		private function processRequest()
306		{
307		$moduleExist = file_exists(APP_PATH . '/Modules/' . $this->module);
308		$classExist = class_exists($this->class);
309		$methodExist = method_exists($this->class, $this->method);
310
311		if (!$moduleExist \|\| !$classExist \|\| !$methodExist) {
312		$view = new View();
313		$this->output = $view->render404(['Invalid method requests']); //Router::show404(
314		return false;
315		}
316
317		return true;
318		}
319
320		/**
321		* Processes the application request
322		*
323		* @access private
324		*/
325		private function start()
326		{
327		if (!$this->processRequest()) {
328		return false;
329		}
330
331		App::callEvent('preController');
332		$this->instantiatedClass = new $this->class();
		0 ignored issues – show Documentation Bug introduced 2016-08-13 01:11 UTC by Report Bug Copy Issue Report It seems like `new $this->class()` of type `object` is incompatible with the declared type `string` of property `$instantiatedClass`. Our type inference engine has found an assignment to a property that is incompatible with the declared type of that property. Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property.. Loading history...
333		App::callEvent('postController');
334
335		$this->output = call_user_func_array(
336		array(&$this->instantiatedClass, $this->method),
337		$this->params
338		);
339		}
340		/**
341		* Attach (or remove) multiple callbacks to an event and trigger those callbacks when that event is called.
342		*
343		* @param string $event name
344		* @param mixed $value the optional value to pass to each callback
345		* @param mixed $callback the method or function to call - FALSE to remove all callbacks for event
		0 ignored issues – show Bug introduced 2016-08-13 01:11 UTC by Report Bug Copy Issue Report There is no parameter named `$value`. Was it maybe removed? This check looks for PHPDoc comments describing methods or function parameters that do not exist on the corresponding method or function. Consider the following example. The parameter `$italy` is not defined by the method `finale(...)`. /** * @param array $germany * @param array $island * @param array $italy */ function finale($germany, $island) { return "2:1"; } The most likely cause is that the parameter was removed, but the annotation was not. Loading history...
346		*/
347
348		public static function addEvent($event, $callback = false)
349		{
350		// Adding or removing a callback?
351		if ($callback !== false) {
352		self::$events[$event][] = $callback;
353		} else {
354		unset(self::$events[$event]);
355		}
356		}
357
358		public function callEvent($event, $method = false, $arguments = [])
359		{
360		if (isset(self::$events[$event])) {
361		foreach (self::$events[$event] as $e) {
362		if ($method !== false) { // class w/ method specified
363		$object = new $e();
364		$value = call_user_func_array(
365		[&$object, $method],
366		$arguments
367		);
368		} else {
369		if (class_exists($e)) {
370		$value = new $e($arguments); // class w/o method specified
371		} else {
372		$value = call_user_func($e, $arguments); // function yuk
373		}
374		}
375		}
376
377		return $value;
		0 ignored issues – show Bug introduced 2016-08-13 01:11 UTC by Report Bug Copy Issue Report The variable `$value` does not seem to be defined for all execution paths leading up to this point. If you define a variable conditionally, it can happen that it is not defined for all execution paths. Let’s take a look at an example: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } // $x is potentially undefined here. echo $x; } In the above example, the variable `$x` is defined if you pass “foo” or “bar” as argument for `$a`. However, since the `switch` statement has no default case statement, if you pass any other value, the variable `$x` would be undefined. Available Fixes Check for existence of the variable explicitly: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } if (isset($x)) { // Make sure it's always set. echo $x; } } Define a default value for the variable: function myFunction($a) { $x = ''; // Set a default which gets overridden for certain paths. switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } echo $x; } Add a value for the missing path: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; // We add support for the missing case. default: $x = ''; break; } echo $x; } Loading history...
378		}
379		}
380
381
382		/**
383		* Prepare application return value into a string
384		*
385		* @access public
386		* @return string
387		*/
388		public function __toString()
389		{
390		if (!$this->output) {
391		$this->output = '';
392		}
393
394		App::callEvent('postApplication');
395
396		return $this->output;
397		}
398
399
400		/**
401		* Returns a reference of object once instantiated
402		*
403		* @access public
404		* @return object
405		*/
406	28	public static function getInstance()
407		{
408	28	if (self::$instance === null) {
409		return false;
410		}
411
412	28	return self::$instance;
413		}
414		}
415

zewadesign / framework

Pull Request — master (#66)

App::prepare() A

Complexity

Size

Duplication

Code Coverage

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like