View::renderErrors() - Code Metrics - Inspection of "Update View.php" - OmarElGabry/miniPHP - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#20)

unknown

created 2016-07-11 22:16 UTC

View::renderErrors() A

↳ Parent: View

Complexity

Conditions	2
Paths	2

Size

Total Lines	11
Code Lines	7

Duplication

Lines	11
Ratio	100 %

Importance

Changes	3
Bugs	0	Features	0

Metric	Value
c	3
b	0
f	0
dl	11
loc	11
rs	9.4285
cc	2
eloc	7
nc	2
nop	1

<?php

/**
 * The view class.
 *
 * Responsible for rendering files as HTML, encode JSON, with some helper methods
 *
 * @license    http://opensource.org/licenses/MIT The MIT License (MIT)
 * @author     Omar El Gabry <[email protected]>
 */

class View {
namespace YourVendor;

class YourClass { }

    /**
     * controller object that instantiated view object
     *
     * @var object
     */
    public $controller;

    /**
     * Constructor
     *
     * @param Controller $controller
     */
    public function __construct(Controller $controller){

        $this->controller = $controller;
     }

    /**
     * Magic __get method
     *
     * @param $proporty
     */
	public function __get($property)
	{
		if(property_exists(get_class($this->controller), $property))
		{
			return (array_key_exists($property, get_object_vars($this->controller)) ? $this->controller->{$property} : $this->controller::$$property);
		}
	}
    /**
     * Renders and returns output for the given file with its array of data.
     *
     * @param  string  $filePath
     * @param  array   $data
     * @return string  Rendered output
     *
     */
    public function render($filePath, $data = null){

        if(!empty($data)) {
            extract($data);
        }

        // Using include Vs require is better,
        // because we may want to include a file more than once.
        ob_start();
        include $filePath . "" ;
        $renderedFile = ob_get_clean();

        $this->controller->response->setContent($renderedFile);
        return $renderedFile;
    }

    /**
     * Renders and returns output with header and footer for the given file with its array of data.
     *
     * @param  string  $layoutDir
     * @param  string  $filePath
     * @param  array   $data
     * @return string  Rendered output
     */
    public function renderWithLayouts($layoutDir, $filePath, $data = null){

        if(!empty($data)) {
            extract($data);
        }

        // you can use require_once() immediately without ob_start() & ob_get_clean()

        // or use ob_start() & ob_get_clean() then return $renderedFile then echo,

        // but, using ob_start() & ob_get_clean() is a handy way, especially for ajax response.
        ob_start();
        require_once $layoutDir . "header.php";
        require_once $filePath  . "" ;
        require_once $layoutDir . "footer.php";
        $renderedFile = ob_get_clean();

        $this->controller->response->setContent($renderedFile);
        return $renderedFile;
    }

    /**
     * Render a JSON view.
     *
     * @param  array   $data
     * @return string  Rendered output
     *
     */
    public function renderJson($data){

        $jsonData = $this->jsonEncode($data);

        $this->controller->response->type('application/json')->setContent($jsonData);
        return $jsonData;
    }

    /**
     * Renders errors
     * A json respond will be sent in case of ajax call
     *
     * @param  array  $errors
     * @return mixed  Rendered output
     */
    public function renderErrors($errors){


         $html = $this->render(Config::get('VIEWS_PATH') . 'alerts/errors.php', ["errors" => $errors]);

         if($this->controller->request->isAjax()){
             return $this->renderJson(array("error" => $html));
         }else{
             $this->controller->response->setContent($html);
             return $html;
         }
     }

    /**
     * Renders success message
     * A json respond will be sent in case of ajax call
     *
     * @param  string  $message
     * @return mixed  Rendered output
     */
    public function renderSuccess($message){


         $html = $this->render(Config::get('VIEWS_PATH') . 'alerts/success.php', array("success" => $message));

         if($this->controller->request->isAjax()){
             return $this->renderJson(array("success" => $html));
         }else{
             $this->controller->response->setContent($html);
             return $html;
         }
     }

    /** *********************************************** **/
    /** **************     JSON View     ************** **/
    /** *********************************************** **/

     /**
      * Serialize array to JSON and used for the response
      *
      * @param  array   $data
      * @return string  Rendered output
      *
      */
    public function jsonEncode($data){
        return json_encode($data);
    }

    /** *********************************************** **/
    /** **************     Text Helper   ************** **/
    /** *********************************************** **/

    /**
     * Cuts a string to the length of $length and replaces the last characters
     * with the ellipsis => '...' if the text is longer than length.
     *
     * @param  string $str
     * @param  string $len
     * @return string the truncated string
     */
    public function truncate($str, $len){

        if(empty($str)) {
            return "";
        }else if(mb_strlen($str, 'UTF-8') > $len){
            return mb_substr($str, 0, $len, "UTF-8") . " ...";
        }else{
            return mb_substr($str, 0, $len, "UTF-8");
        }
    }

    /**
     * formats timestamp string coming from the database to "Month Day, Year"
     *
     * @param  string  $timestamp MySQL TIMESTAMP
     * @return string  Date after formatting.
     */
    public function timestamp($timestamp){

        $unixTime = strtotime($timestamp);
        $date = date("F j, Y", $unixTime);

        // What if date() failed to format? It will return false.
        return (empty($date))? "": $date;
    }

    /**
     * formats Unix timestamp string to "Month Day, Year"
     *
     * @param  integer	$unixtime Unix timestamp
     * @return string	Date after formatting.
     */
    public function unixtime($unixtime){

        $date = date("F j, Y", intval($unixtime));
        return (empty($date))? "": $date;
    }

    /**
     * formats Unix timestamp to be used in Date Picker in form of: "day/month/year"
     *
     * @param  integer	$unixtime Unix timestamp
     * @return string	Date after formatting.
     */
    public function datePicker($unixtime){

        $date = date("d/m/Y", (int)$unixtime);
        return (empty($date))? "": $date;
    }

    /**
     * Surround the links in a context with anchor tags.
     *
     * @param  string $str
     * @return string
     * @see http://stackoverflow.com/questions/5341168/best-way-to-make-links-clickable-in-block-of-text
     */
    public function autoLinks($str){
        return preg_replace('!(((f|ht)tp(s)?://)[-a-zA-Zа-яА-Я()0-9@:%_+.~#?&;//=]+)!i', '<a href="$1" target="_blank">$1</a>', $str);
    }

    /**
     * Converts characters to HTML entities
     * This is important to avoid XSS attacks, and attempts to inject malicious code in your page.
     *
     * @param  string $str The string.
     * @return string
     */
    public function encodeHTML($str){
        return htmlentities($str, ENT_QUOTES, 'UTF-8');
    }

    /**
     * It's same as encodeHTML(), But, also use nl2br() function in PHP
     *
     * @param  string	The string.
     * @return string	The string after converting characters and inserting br tags.
     */
    public function encodeHTMLWithBR($str){
        return nl2br(htmlentities($str, ENT_QUOTES, 'UTF-8'));
    }

} 


1		<?php
2
3		/**
4		* The view class.
5		*
6		* Responsible for rendering files as HTML, encode JSON, with some helper methods
7		*
8		* @license http://opensource.org/licenses/MIT The MIT License (MIT)
9		* @author Omar El Gabry <[email protected]>
10		*/
11
12		class View {
		0 ignored issues – show Coding Style Compatibility introduced 2015-11-27 07:13 UTC by Report Bug Copy Issue Report PSR1 recommends that each class must be in a namespace of at least one level to avoid collisions. You can fix this by adding a namespace to your class: namespace YourVendor; class YourClass { } When choosing a vendor namespace, try to pick something that is not too generic to avoid conflicts with other libraries. Loading history...
13
14		/**
15		* controller object that instantiated view object
16		*
17		* @var object
18		*/
19		public $controller;
20
21		/**
22		* Constructor
23		*
24		* @param Controller $controller
25		*/
26		public function __construct(Controller $controller){
27
28		$this->controller = $controller;
29		}
30
31		/**
32		* Magic __get method
33		*
34		* @param $proporty
35		*/
36		public function __get($property)
37		{
38		if(property_exists(get_class($this->controller), $property))
39		{
40		return (array_key_exists($property, get_object_vars($this->controller)) ? $this->controller->{$property} : $this->controller::$$property);
41		}
42		}
43		/**
44		* Renders and returns output for the given file with its array of data.
45		*
46		* @param string $filePath
47		* @param array $data
48		* @return string Rendered output
49		*
50		*/
51		public function render($filePath, $data = null){
52
53		if(!empty($data)) {
54		extract($data);
55		}
56
57		// Using include Vs require is better,
58		// because we may want to include a file more than once.
59		ob_start();
60		include $filePath . "" ;
61		$renderedFile = ob_get_clean();
62
63		$this->controller->response->setContent($renderedFile);
64		return $renderedFile;
65		}
66
67		/**
68		* Renders and returns output with header and footer for the given file with its array of data.
69		*
70		* @param string $layoutDir
71		* @param string $filePath
72		* @param array $data
73		* @return string Rendered output
74		*/
75		public function renderWithLayouts($layoutDir, $filePath, $data = null){
76
77		if(!empty($data)) {
78		extract($data);
79		}
80
81		// you can use require_once() immediately without ob_start() & ob_get_clean()
		0 ignored issues – show Unused Code Comprehensibility introduced 2016-03-19 21:07 UTC by Report Bug Copy Issue Report `38%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
82		// or use ob_start() & ob_get_clean() then return $renderedFile then echo,
		0 ignored issues – show Unused Code Comprehensibility introduced 2016-03-19 21:07 UTC by Report Bug Copy Issue Report `44%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
83		// but, using ob_start() & ob_get_clean() is a handy way, especially for ajax response.
84		ob_start();
85		require_once $layoutDir . "header.php";
86		require_once $filePath . "" ;
87		require_once $layoutDir . "footer.php";
88		$renderedFile = ob_get_clean();
89
90		$this->controller->response->setContent($renderedFile);
91		return $renderedFile;
92		}
93
94		/**
95		* Render a JSON view.
96		*
97		* @param array $data
98		* @return string Rendered output
99		*
100		*/
101		public function renderJson($data){
102
103		$jsonData = $this->jsonEncode($data);
104
105		$this->controller->response->type('application/json')->setContent($jsonData);
106		return $jsonData;
107		}
108
109		/**
110		* Renders errors
111		* A json respond will be sent in case of ajax call
112		*
113		* @param array $errors
114		* @return mixed Rendered output
115		*/
116	View Code Duplication	public function renderErrors($errors){
		0 ignored issues – show Duplication introduced 2015-11-27 07:13 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
117
118		$html = $this->render(Config::get('VIEWS_PATH') . 'alerts/errors.php', ["errors" => $errors]);
119
120		if($this->controller->request->isAjax()){
121		return $this->renderJson(array("error" => $html));
122		}else{
123		$this->controller->response->setContent($html);
124		return $html;
125		}
126		}
127
128		/**
129		* Renders success message
130		* A json respond will be sent in case of ajax call
131		*
132		* @param string $message
133		* @return mixed Rendered output
134		*/
135	View Code Duplication	public function renderSuccess($message){
		0 ignored issues – show Duplication introduced 2015-11-27 07:13 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
136
137		$html = $this->render(Config::get('VIEWS_PATH') . 'alerts/success.php', array("success" => $message));
138
139		if($this->controller->request->isAjax()){
140		return $this->renderJson(array("success" => $html));
141		}else{
142		$this->controller->response->setContent($html);
143		return $html;
144		}
145		}
146
147		/ ******************************************* /
148		/ ********** JSON View ********** /
149		/ ******************************************* /
150
151		/**
152		* Serialize array to JSON and used for the response
153		*
154		* @param array $data
155		* @return string Rendered output
156		*
157		*/
158		public function jsonEncode($data){
159		return json_encode($data);
160		}
161
162		/ ******************************************* /
163		/ ********** Text Helper ********** /
164		/ ******************************************* /
165
166		/**
167		* Cuts a string to the length of $length and replaces the last characters
168		* with the ellipsis => '...' if the text is longer than length.
169		*
170		* @param string $str
171		* @param string $len
172		* @return string the truncated string
173		*/
174		public function truncate($str, $len){
175
176		if(empty($str)) {
177		return "";
178		}else if(mb_strlen($str, 'UTF-8') > $len){
179		return mb_substr($str, 0, $len, "UTF-8") . " ...";
180		}else{
181		return mb_substr($str, 0, $len, "UTF-8");
182		}
183		}
184
185		/**
186		* formats timestamp string coming from the database to "Month Day, Year"
187		*
188		* @param string $timestamp MySQL TIMESTAMP
189		* @return string Date after formatting.
190		*/
191		public function timestamp($timestamp){
192
193		$unixTime = strtotime($timestamp);
194		$date = date("F j, Y", $unixTime);
195
196		// What if date() failed to format? It will return false.
197		return (empty($date))? "": $date;
198		}
199
200		/**
201		* formats Unix timestamp string to "Month Day, Year"
202		*
203		* @param integer $unixtime Unix timestamp
204		* @return string Date after formatting.
205		*/
206		public function unixtime($unixtime){
207
208		$date = date("F j, Y", intval($unixtime));
209		return (empty($date))? "": $date;
210		}
211
212		/**
213		* formats Unix timestamp to be used in Date Picker in form of: "day/month/year"
214		*
215		* @param integer $unixtime Unix timestamp
216		* @return string Date after formatting.
217		*/
218		public function datePicker($unixtime){
219
220		$date = date("d/m/Y", (int)$unixtime);
221		return (empty($date))? "": $date;
222		}
223
224		/**
225		* Surround the links in a context with anchor tags.
226		*
227		* @param string $str
228		* @return string
229		* @see http://stackoverflow.com/questions/5341168/best-way-to-make-links-clickable-in-block-of-text
230		*/
231		public function autoLinks($str){
232		return preg_replace('!(((f\|ht)tp(s)?://)[-a-zA-Zа-яА-Я()0-9@:%_+.~#?&;//=]+)!i', '<a href="$1" target="_blank">$1</a>', $str);
233		}
234
235		/**
236		* Converts characters to HTML entities
237		* This is important to avoid XSS attacks, and attempts to inject malicious code in your page.
238		*
239		* @param string $str The string.
240		* @return string
241		*/
242		public function encodeHTML($str){
243		return htmlentities($str, ENT_QUOTES, 'UTF-8');
244		}
245
246		/**
247		* It's same as encodeHTML(), But, also use nl2br() function in PHP
248		*
249		* @param string The string.
250		* @return string The string after converting characters and inserting br tags.
251		*/
252		public function encodeHTMLWithBR($str){
253		return nl2br(htmlentities($str, ENT_QUOTES, 'UTF-8'));
254		}
255
256		}
257

OmarElGabry / miniPHP

GitHub Access Token became invalid

Pull Request — master (#20)

View::renderErrors() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like