ServiceProvider::escape() - Code Metrics - Inspection of "Merge pull request #15 from php-school/composer-in..." - php-school/learn-you-php - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 93f6e0...a7ea34 )

by Aydin

created 2015-12-30 14:22 UTC

ServiceProvider::escape() A

↳ Parent: ServiceProvider

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes	2
Bugs	0	Features	1

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

<?php
/**
 * Klein (klein.php) - A fast & flexible router for PHP
 *
 * @author      Chris O'Hara <[email protected]>
 * @author      Trevor Suarez (Rican7) (contributor and v2 refactorer)
 * @copyright   (c) Chris O'Hara
 * @link        https://github.com/chriso/klein.php
 * @license     MIT
 */

namespace Klein;

use Klein\DataCollection\DataCollection;

/**
 * ServiceProvider 
 *
 * Service provider class for handling logic extending between
 * a request's data and a response's behavior
 */
class ServiceProvider
{

    /**
     * Class properties
     */

    /**
     * The Request instance containing HTTP request data and behaviors
     *
     * @type Request
     */
    protected $request;

    /**
     * The Response instance containing HTTP response data and behaviors
     *
     * @type AbstractResponse
     */
    protected $response;

    /**
     * The id of the current PHP session
     *
     * @type string|boolean
     */
    protected $session_id;

    /**
     * The view layout
     *
     * @type string
     */
    protected $layout;

    /**
     * The view to render
     *
     * @type string
     */
    protected $view;

    /**
     * Shared data collection
     *
     * @type DataCollection
     */
    protected $shared_data;


    /**
     * Methods
     */

    /**
     * Constructor
     *
     * @param Request $request              Object containing all HTTP request data and behaviors
     * @param AbstractResponse $response    Object containing all HTTP response data and behaviors
     */
    public function __construct(Request $request = null, AbstractResponse $response = null)
    {
        // Bind our objects
        $this->bind($request, $response);

        // Instantiate our shared data collection
        $this->shared_data = new DataCollection();
    }

    /**
     * Bind object instances to this service
     *
     * @param Request $request              Object containing all HTTP request data and behaviors
     * @param AbstractResponse $response    Object containing all HTTP response data and behaviors
     * @return ServiceProvider
     */
    public function bind(Request $request = null, AbstractResponse $response = null)
    {
        // Keep references
        $this->request  = $request  ?: $this->request;
        $this->response = $response ?: $this->response;

        return $this;
    }

    /**
     * Returns the shared data collection object
     *
     * @return \Klein\DataCollection\DataCollection
     */
    public function sharedData()
    {
        return $this->shared_data;
    }

    /**
     * Get the current session's ID
     *
     * This will start a session if the current session id is null
     *
     * @return string|false
     */
    public function startSession()
    {
        if (session_id() === '') {
            // Attempt to start a session
            session_start();

            $this->session_id = session_id() ?: false;
        }

        return $this->session_id;
    }

    /**
     * Stores a flash message of $type
     *
     * @param string $msg       The message to flash
     * @param string $type      The flash message type
     * @param array $params     Optional params to be parsed by markdown
     * @return void
     */
    public function flash($msg, $type = 'info', $params = null)
// Bad
class Router
{
    public function generate($path)
    {
        return $_SERVER['HOST'].$path;
    }
}

// Better
class Router
{
    private $host;

    public function __construct($host)
    {
        $this->host = $host;
    }

    public function generate($path)
    {
        return $this->host.$path;
    }
}

class Controller
{
    public function myAction(Request $request)
    {
        // Instead of
        $page = isset($_GET['page']) ? intval($_GET['page']) : 1;

        // Better (assuming you use the Symfony2 request)
        $page = $request->query->get('page', 1);
    }
}
    {
        $this->startSession();
        if (is_array($type)) {
            $params = $type;
            $type = 'info';
        }
        if (!isset($_SESSION['__flashes'])) {
            $_SESSION['__flashes'] = array($type => array());
        } elseif (!isset($_SESSION['__flashes'][$type])) {
            $_SESSION['__flashes'][$type] = array();
        }
        $_SESSION['__flashes'][$type][] = $this->markdown($msg, $params);
    }

    /**
     * Returns and clears all flashes of optional $type
     *
     * @param string $type  The name of the flash message type
     * @return array
     */
    public function flashes($type = null)
// Bad
class Router
{
    public function generate($path)
    {
        return $_SERVER['HOST'].$path;
    }
}

// Better
class Router
{
    private $host;

    public function __construct($host)
    {
        $this->host = $host;
    }

    public function generate($path)
    {
        return $this->host.$path;
    }
}

class Controller
{
    public function myAction(Request $request)
    {
        // Instead of
        $page = isset($_GET['page']) ? intval($_GET['page']) : 1;

        // Better (assuming you use the Symfony2 request)
        $page = $request->query->get('page', 1);
    }
}
    {
        $this->startSession();

        if (!isset($_SESSION['__flashes'])) {
            return array();
        }

        if (null === $type) {
            $flashes = $_SESSION['__flashes'];
            unset($_SESSION['__flashes']);
        } else {
            $flashes = array();
            if (isset($_SESSION['__flashes'][$type])) {
                $flashes = $_SESSION['__flashes'][$type];
                unset($_SESSION['__flashes'][$type]);
            }
        }

        return $flashes;
    }

    /**
     * Render a text string as markdown
     *
     * Supports basic markdown syntax
     *
     * Also, this method takes in EITHER an array of optional arguments (as the second parameter)
     * ... OR this method will simply take a variable number of arguments (after the initial str arg)
     *
     * @param string $str   The text string to parse
     * @param array $args   Optional arguments to be parsed by markdown
     * @return string
     */
    public static function markdown($str, $args = null)

    {
        // Create our markdown parse/conversion regex's
        $md = array(
            '/\[([^\]]++)\]\(([^\)]++)\)/' => '<a href="$2">$1</a>',
            '/\*\*([^\*]++)\*\*/'          => '<strong>$1</strong>',
            '/\*([^\*]++)\*/'              => '<em>$1</em>'
        );

        // Let's make our arguments more "magical"
        $args = func_get_args(); // Grab all of our passed args
        $str = array_shift($args); // Remove the initial arg from the array (and set the $str to it)
        if (isset($args[0]) && is_array($args[0])) {
            /**
             * If our "second" argument (now the first array item is an array)
             * just use the array as the arguments and forget the rest
             */
            $args = $args[0];
        }

        // Encode our args so we can insert them into an HTML string
        foreach ($args as &$arg) {
            $arg = htmlentities($arg, ENT_QUOTES, 'UTF-8');
        }

        // Actually do our markdown conversion
        return vsprintf(preg_replace(array_keys($md), $md, $str), $args);
    }

    /**
     * Escapes a string for UTF-8 HTML displaying
     *
     * This is a quick macro for escaping strings designed
     * to be shown in a UTF-8 HTML environment. Its options
     * are otherwise limited by design
     *
     * @param string $str   The string to escape
     * @param int $flags    A bitmask of `htmlentities()` compatible flags
     * @return string
     */
    public static function escape($str, $flags = ENT_QUOTES)
    {
        return htmlentities($str, $flags, 'UTF-8');
    }

    /**
     * Redirects the request to the current URL
     *
     * @return ServiceProvider
     */
    public function refresh()
    {
        $this->response->redirect(
            $this->request->uri()
        );

        return $this;
    }

    /**
     * Redirects the request back to the referrer
     *
     * @return ServiceProvider
     */
    public function back()
    {
        $referer = $this->request->server()->get('HTTP_REFERER');

        if (null !== $referer) {
            $this->response->redirect($referer);
        } else {
            $this->refresh();
        }

        return $this;
    }

    /**
     * Get (or set) the view's layout
     *
     * Simply calling this method without any arguments returns the current layout.
     * Calling with an argument, however, sets the layout to what was provided by the argument.
     *
     * @param string $layout    The layout of the view
     * @return string|ServiceProvider
     */
    public function layout($layout = null)
    {
        if (null !== $layout) {
            $this->layout = $layout;

            return $this;
        }

        return $this->layout;
    }

    /**
     * Renders the current view
     *
     * @return void
     */
    public function yieldView()
    {
        require $this->view;
    }

    /**
     * Renders a view + optional layout
     *
     * @param string $view  The view to render
     * @param array $data   The data to render in the view
     * @return void
     */
    public function render($view, array $data = array())
    {
        $original_view = $this->view;

        if (!empty($data)) {
            $this->shared_data->merge($data);
        }

        $this->view = $view;

        if (null === $this->layout) {
            $this->yieldView();
        } else {
            require $this->layout;
        }

        if (false !== $this->response->chunked) {
            $this->response->chunk();
        }

        // restore state for parent render()
        $this->view = $original_view;
    }

    /**
     * Renders a view without a layout
     *
     * @param string $view  The view to render
     * @param array $data   The data to render in the view
     * @return void
     */
    public function partial($view, array $data = array())
    {
        $layout = $this->layout;
        $this->layout = null;
        $this->render($view, $data);
        $this->layout = $layout;
    }

    /**
     * Add a custom validator for our validation method
     *
     * @param string $method        The name of the validator method
     * @param callable $callback    The callback to perform on validation
     * @return void
     */
    public function addValidator($method, $callback)
    {
        Validator::addValidator($method, $callback);
    }

    /**
     * Start a validator chain for the specified string
     *
     * @param string $string    The string to validate
     * @param string $err       The custom exception message to throw
     * @return Validator
     */
    public function validate($string, $err = null)
    {
        return new Validator($string, $err);
    }

    /**
     * Start a validator chain for the specified parameter
     *
     * @param string $param     The name of the parameter to validate
     * @param string $err       The custom exception message to throw
     * @return Validator
     */
    public function validateParam($param, $err = null)
    {
        return $this->validate($this->request->param($param), $err);
    }


    /**
     * Magic "__isset" method
     *
     * Allows the ability to arbitrarily check the existence of shared data
     * from this instance while treating it as an instance property
     *
     * @param string $key     The name of the shared data
     * @return boolean
     */
    public function __isset($key)
    {
        return $this->shared_data->exists($key);
    }

    /**
     * Magic "__get" method
     *
     * Allows the ability to arbitrarily request shared data from this instance
     * while treating it as an instance property
     *
     * @param string $key     The name of the shared data
     * @return string
     */
    public function __get($key)
    {
        return $this->shared_data->get($key);
    }

    /**
     * Magic "__set" method
     *
     * Allows the ability to arbitrarily set shared data from this instance
     * while treating it as an instance property
     *
     * @param string $key     The name of the shared data
     * @param mixed $value      The value of the shared data
     * @return void
     */
    public function __set($key, $value)
    {
        $this->shared_data->set($key, $value);
    }

    /**
     * Magic "__unset" method
     *
     * Allows the ability to arbitrarily remove shared data from this instance
     * while treating it as an instance property
     *
     * @param string $key     The name of the shared data
     * @return void
     */
    public function __unset($key)
    {
        $this->shared_data->remove($key);
    }
}


1			<?php
2			/**
3			* Klein (klein.php) - A fast & flexible router for PHP
4			*
5			* @author Chris O'Hara <[email protected]>
6			* @author Trevor Suarez (Rican7) (contributor and v2 refactorer)
7			* @copyright (c) Chris O'Hara
8			* @link https://github.com/chriso/klein.php
9			* @license MIT
10			*/
11
12			namespace Klein;
13
14			use Klein\DataCollection\DataCollection;
15
16			/**
17			* ServiceProvider
18			*
19			* Service provider class for handling logic extending between
20			* a request's data and a response's behavior
21			*/
22			class ServiceProvider
23			{
24
25			/**
26			* Class properties
27			*/
28
29			/**
30			* The Request instance containing HTTP request data and behaviors
31			*
32			* @type Request
33			*/
34			protected $request;
35
36			/**
37			* The Response instance containing HTTP response data and behaviors
38			*
39			* @type AbstractResponse
40			*/
41			protected $response;
42
43			/**
44			* The id of the current PHP session
45			*
46			* @type string\|boolean
47			*/
48			protected $session_id;
49
50			/**
51			* The view layout
52			*
53			* @type string
54			*/
55			protected $layout;
56
57			/**
58			* The view to render
59			*
60			* @type string
61			*/
62			protected $view;
63
64			/**
65			* Shared data collection
66			*
67			* @type DataCollection
68			*/
69			protected $shared_data;
70
71
72			/**
73			* Methods
74			*/
75
76			/**
77			* Constructor
78			*
79			* @param Request $request Object containing all HTTP request data and behaviors
80			* @param AbstractResponse $response Object containing all HTTP response data and behaviors
81			*/
82			public function __construct(Request $request = null, AbstractResponse $response = null)
83			{
84			// Bind our objects
85			$this->bind($request, $response);
86
87			// Instantiate our shared data collection
88			$this->shared_data = new DataCollection();
89			}
90
91			/**
92			* Bind object instances to this service
93			*
94			* @param Request $request Object containing all HTTP request data and behaviors
95			* @param AbstractResponse $response Object containing all HTTP response data and behaviors
96			* @return ServiceProvider
97			*/
98			public function bind(Request $request = null, AbstractResponse $response = null)
99			{
100			// Keep references
101			$this->request = $request ?: $this->request;
102			$this->response = $response ?: $this->response;
103
104			return $this;
105			}
106
107			/**
108			* Returns the shared data collection object
109			*
110			* @return \Klein\DataCollection\DataCollection
111			*/
112			public function sharedData()
113			{
114			return $this->shared_data;
115			}
116
117			/**
118			* Get the current session's ID
119			*
120			* This will start a session if the current session id is null
121			*
122			* @return string\|false
123			*/
124			public function startSession()
125			{
126			if (session_id() === '') {
127			// Attempt to start a session
128			session_start();
129
130			$this->session_id = session_id() ?: false;
131			}
132
133			return $this->session_id;
134			}
135
136			/**
137			* Stores a flash message of $type
138			*
139			* @param string $msg The message to flash
140			* @param string $type The flash message type
141			* @param array $params Optional params to be parsed by markdown
142			* @return void
143			*/
144			public function flash($msg, $type = 'info', $params = null)
			0 ignored issues – show Coding Style introduced 2015-12-30 14:34 UTC by Report Bug Copy Issue Report `flash` uses the super-global variable `$_SESSION` which is generally not recommended. Instead of super-globals, we recommend to explicitly inject the dependencies of your class. This makes your code less dependent on global state and it becomes generally more testable: // Bad class Router { public function generate($path) { return $_SERVER['HOST'].$path; } } // Better class Router { private $host; public function __construct($host) { $this->host = $host; } public function generate($path) { return $this->host.$path; } } class Controller { public function myAction(Request $request) { // Instead of $page = isset($_GET['page']) ? intval($_GET['page']) : 1; // Better (assuming you use the Symfony2 request) $page = $request->query->get('page', 1); } } Loading history...
145			{
146			$this->startSession();
147			if (is_array($type)) {
148			$params = $type;
149			$type = 'info';
150			}
151			if (!isset($_SESSION['__flashes'])) {
152			$_SESSION['__flashes'] = array($type => array());
153			} elseif (!isset($_SESSION['__flashes'][$type])) {
154			$_SESSION['__flashes'][$type] = array();
155			}
156			$_SESSION['__flashes'][$type][] = $this->markdown($msg, $params);
157			}
158
159			/**
160			* Returns and clears all flashes of optional $type
161			*
162			* @param string $type The name of the flash message type
163			* @return array
164			*/
165			public function flashes($type = null)
			0 ignored issues – show Coding Style introduced 2015-12-30 14:34 UTC by Report Bug Copy Issue Report `flashes` uses the super-global variable `$_SESSION` which is generally not recommended. Instead of super-globals, we recommend to explicitly inject the dependencies of your class. This makes your code less dependent on global state and it becomes generally more testable: // Bad class Router { public function generate($path) { return $_SERVER['HOST'].$path; } } // Better class Router { private $host; public function __construct($host) { $this->host = $host; } public function generate($path) { return $this->host.$path; } } class Controller { public function myAction(Request $request) { // Instead of $page = isset($_GET['page']) ? intval($_GET['page']) : 1; // Better (assuming you use the Symfony2 request) $page = $request->query->get('page', 1); } } Loading history...
166			{
167			$this->startSession();
168
169			if (!isset($_SESSION['__flashes'])) {
170			return array();
171			}
172
173			if (null === $type) {
174			$flashes = $_SESSION['__flashes'];
175			unset($_SESSION['__flashes']);
176			} else {
177			$flashes = array();
178			if (isset($_SESSION['__flashes'][$type])) {
179			$flashes = $_SESSION['__flashes'][$type];
180			unset($_SESSION['__flashes'][$type]);
181			}
182			}
183
184			return $flashes;
185			}
186
187			/**
188			* Render a text string as markdown
189			*
190			* Supports basic markdown syntax
191			*
192			* Also, this method takes in EITHER an array of optional arguments (as the second parameter)
193			* ... OR this method will simply take a variable number of arguments (after the initial str arg)
194			*
195			* @param string $str The text string to parse
196			* @param array $args Optional arguments to be parsed by markdown
197			* @return string
198			*/
199			public static function markdown($str, $args = null)
			0 ignored issues – show Unused Code introduced 2015-12-30 14:34 UTC by Report Bug Copy Issue Report The parameter `$str` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history... Unused Code introduced 2015-12-30 14:34 UTC by Report Bug Copy Issue Report The parameter `$args` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history...
200			{
201			// Create our markdown parse/conversion regex's
202			$md = array(
203			'/\[([^\]]++)\]\(([^\)]++)\)/' => '<a href="$2">$1</a>',
204			'/\\([^\]++)\\*/' => '<strong>$1</strong>',
205			'/\([^\]++)\*/' => '<em>$1</em>'
206			);
207
208			// Let's make our arguments more "magical"
209			$args = func_get_args(); // Grab all of our passed args
210			$str = array_shift($args); // Remove the initial arg from the array (and set the $str to it)
211			if (isset($args[0]) && is_array($args[0])) {
212			/**
213			* If our "second" argument (now the first array item is an array)
214			* just use the array as the arguments and forget the rest
215			*/
216			$args = $args[0];
217			}
218
219			// Encode our args so we can insert them into an HTML string
220			foreach ($args as &$arg) {
221			$arg = htmlentities($arg, ENT_QUOTES, 'UTF-8');
222			}
223
224			// Actually do our markdown conversion
225			return vsprintf(preg_replace(array_keys($md), $md, $str), $args);
226			}
227
228			/**
229			* Escapes a string for UTF-8 HTML displaying
230			*
231			* This is a quick macro for escaping strings designed
232			* to be shown in a UTF-8 HTML environment. Its options
233			* are otherwise limited by design
234			*
235			* @param string $str The string to escape
236			* @param int $flags A bitmask of `htmlentities()` compatible flags
237			* @return string
238			*/
239			public static function escape($str, $flags = ENT_QUOTES)
240			{
241			return htmlentities($str, $flags, 'UTF-8');
242			}
243
244			/**
245			* Redirects the request to the current URL
246			*
247			* @return ServiceProvider
248			*/
249			public function refresh()
250			{
251			$this->response->redirect(
252			$this->request->uri()
253			);
254
255			return $this;
256			}
257
258			/**
259			* Redirects the request back to the referrer
260			*
261			* @return ServiceProvider
262			*/
263			public function back()
264			{
265			$referer = $this->request->server()->get('HTTP_REFERER');
266
267			if (null !== $referer) {
268			$this->response->redirect($referer);
269			} else {
270			$this->refresh();
271			}
272
273			return $this;
274			}
275
276			/**
277			* Get (or set) the view's layout
278			*
279			* Simply calling this method without any arguments returns the current layout.
280			* Calling with an argument, however, sets the layout to what was provided by the argument.
281			*
282			* @param string $layout The layout of the view
283			* @return string\|ServiceProvider
284			*/
285			public function layout($layout = null)
286			{
287			if (null !== $layout) {
288			$this->layout = $layout;
289
290			return $this;
291			}
292
293			return $this->layout;
294			}
295
296			/**
297			* Renders the current view
298			*
299			* @return void
300			*/
301			public function yieldView()
302			{
303			require $this->view;
304			}
305
306			/**
307			* Renders a view + optional layout
308			*
309			* @param string $view The view to render
310			* @param array $data The data to render in the view
311			* @return void
312			*/
313			public function render($view, array $data = array())
314			{
315			$original_view = $this->view;
316
317			if (!empty($data)) {
318			$this->shared_data->merge($data);
319			}
320
321			$this->view = $view;
322
323			if (null === $this->layout) {
324			$this->yieldView();
325			} else {
326			require $this->layout;
327			}
328
329			if (false !== $this->response->chunked) {
330			$this->response->chunk();
331			}
332
333			// restore state for parent render()
334			$this->view = $original_view;
335			}
336
337			/**
338			* Renders a view without a layout
339			*
340			* @param string $view The view to render
341			* @param array $data The data to render in the view
342			* @return void
343			*/
344			public function partial($view, array $data = array())
345			{
346			$layout = $this->layout;
347			$this->layout = null;
348			$this->render($view, $data);
349			$this->layout = $layout;
350			}
351
352			/**
353			* Add a custom validator for our validation method
354			*
355			* @param string $method The name of the validator method
356			* @param callable $callback The callback to perform on validation
357			* @return void
358			*/
359			public function addValidator($method, $callback)
360			{
361			Validator::addValidator($method, $callback);
362			}
363
364			/**
365			* Start a validator chain for the specified string
366			*
367			* @param string $string The string to validate
368			* @param string $err The custom exception message to throw
369			* @return Validator
370			*/
371			public function validate($string, $err = null)
372			{
373			return new Validator($string, $err);
374			}
375
376			/**
377			* Start a validator chain for the specified parameter
378			*
379			* @param string $param The name of the parameter to validate
380			* @param string $err The custom exception message to throw
381			* @return Validator
382			*/
383			public function validateParam($param, $err = null)
384			{
385			return $this->validate($this->request->param($param), $err);
386			}
387
388
389			/**
390			* Magic "__isset" method
391			*
392			* Allows the ability to arbitrarily check the existence of shared data
393			* from this instance while treating it as an instance property
394			*
395			* @param string $key The name of the shared data
396			* @return boolean
397			*/
398			public function __isset($key)
399			{
400			return $this->shared_data->exists($key);
401			}
402
403			/**
404			* Magic "__get" method
405			*
406			* Allows the ability to arbitrarily request shared data from this instance
407			* while treating it as an instance property
408			*
409			* @param string $key The name of the shared data
410			* @return string
411			*/
412			public function __get($key)
413			{
414			return $this->shared_data->get($key);
415			}
416
417			/**
418			* Magic "__set" method
419			*
420			* Allows the ability to arbitrarily set shared data from this instance
421			* while treating it as an instance property
422			*
423			* @param string $key The name of the shared data
424			* @param mixed $value The value of the shared data
425			* @return void
426			*/
427			public function __set($key, $value)
428			{
429			$this->shared_data->set($key, $value);
430			}
431
432			/**
433			* Magic "__unset" method
434			*
435			* Allows the ability to arbitrarily remove shared data from this instance
436			* while treating it as an instance property
437			*
438			* @param string $key The name of the shared data
439			* @return void
440			*/
441			public function __unset($key)
442			{
443			$this->shared_data->remove($key);
444			}
445			}
446

php-school / learn-you-php

Push — master ( 93f6e0...a7ea34 )

ServiceProvider::escape() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like