PrettyPageHandler::addDataTable() - Code Metrics - Inspection of "Fix issues with frameworks like Laravel on PHP7" - filp/whoops - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — v1 (#422)

unknown

created 2016-06-30 13:49 UTC

PrettyPageHandler::addDataTable() A

↳ Parent: PrettyPageHandler

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	3
CRAP Score	1

Importance

Changes

Metric	Value
dl	0
loc	4
c	0
b	0
f	0
ccs	3
cts	3
cp	1
rs	10
cc	1
eloc	2
nc	1
nop	2
crap	1

<?php
/**
 * Whoops - php errors for cool kids
 * @author Filipe Dobreira <http://github.com/filp>
 */

namespace Whoops\Handler;

use InvalidArgumentException;
use RuntimeException;
use UnexpectedValueException;
use Whoops\Exception\Formatter;
use Whoops\Util\Misc;
use Whoops\Util\TemplateHelper;

class PrettyPageHandler extends Handler
{
    /**
     * Search paths to be scanned for resources, in the reverse
     * order they're declared.
     *
     * @var array
     */
    private $searchPaths = array();

    /**
     * Fast lookup cache for known resource locations.
     *
     * @var array
     */
    private $resourceCache = array();

    /**
     * The name of the custom css file.
     *
     * @var string
     */
    private $customCss = null;

    /**
     * @var array[]
     */
    private $extraTables = array();

    /**
     * @var bool
     */
    private $handleUnconditionally = false;

    /**
     * @var string
     */
    private $pageTitle = "Whoops! There was an error.";

    /**
     * A string identifier for a known IDE/text editor, or a closure
     * that resolves a string that can be used to open a given file
     * in an editor. If the string contains the special substrings
     * %file or %line, they will be replaced with the correct data.
     *
     * @example
     *  "txmt://open?url=%file&line=%line"
     * @var mixed $editor
     */
    protected $editor;

    /**
     * A list of known editor strings
     * @var array
     */
    protected $editors = array(
        "sublime"  => "subl://open?url=file://%file&line=%line",
        "textmate" => "txmt://open?url=file://%file&line=%line",
        "emacs"    => "emacs://open?url=file://%file&line=%line",
        "macvim"   => "mvim://open/?url=file://%file&line=%line",
        "phpstorm" => "phpstorm://open?file=%file&line=%line",
    );

    /**
     * Constructor.
     */
    public function __construct()
    {
        if (ini_get('xdebug.file_link_format') || extension_loaded('xdebug')) {
            // Register editor using xdebug's file_link_format option.
            $this->editors['xdebug'] = function ($file, $line) {
                return str_replace(array('%f', '%l'), array($file, $line), ini_get('xdebug.file_link_format'));
            };
        }

        // Add the default, local resource search path:
        $this->searchPaths[] = __DIR__ . "/../Resources";
    }

    /**
     * @return int|null
     */
    public function handle()
    {
        if (!$this->handleUnconditionally()) {
$a = canBeFalseAndNull();

// Instead of
if ( ! $a) { }

// Better use one of the explicit versions:
if ($a !== null) { }
if ($a !== false) { }
if ($a !== null && $a !== false) { }
            // Check conditions for outputting HTML:
            // @todo: Make this more robust
            if (php_sapi_name() === 'cli') {
                // Help users who have been relying on an internal test value
                // fix their code to the proper method
                if (isset($_ENV['whoops-test'])) {
                    throw new \Exception(
                        'Use handleUnconditionally instead of whoops-test'
                        .' environment variable'
                    );
                }

                return Handler::DONE;
            }
        }

        // @todo: Make this more dynamic
        $helper = new TemplateHelper();

        $templateFile = $this->getResource("views/layout.html.php");
        $cssFile      = $this->getResource("css/whoops.base.css");
        $zeptoFile    = $this->getResource("js/zepto.min.js");
        $jsFile       = $this->getResource("js/whoops.base.js");

        if ($this->customCss) {
            $customCssFile = $this->getResource($this->customCss);
        }

        $inspector = $this->getInspector();
        $frames    = $inspector->getFrames();

        $code = $inspector->getException()->getCode();

        if ($inspector->getException() instanceof \ErrorException) {
            // ErrorExceptions wrap the php-error types within the "severity" property
            $code = Misc::translateErrorCode($inspector->getException()->getSeverity());
        }

        // List of variables that will be passed to the layout template.
        $vars = array(
            "page_title" => $this->getPageTitle(),

            // @todo: Asset compiler
            "stylesheet" => file_get_contents($cssFile),
            "zepto"      => file_get_contents($zeptoFile),
            "javascript" => file_get_contents($jsFile),

            // Template paths:
            "header"      => $this->getResource("views/header.html.php"),
            "frame_list"  => $this->getResource("views/frame_list.html.php"),
            "frame_code"  => $this->getResource("views/frame_code.html.php"),
            "env_details" => $this->getResource("views/env_details.html.php"),

            "title"          => $this->getPageTitle(),
            "name"           => explode("\\", $inspector->getExceptionName()),
            "message"        => $inspector->getException()->getMessage(),
            "code"           => $code,
            "plain_exception" => Formatter::formatExceptionPlain($inspector),
            "frames"         => $frames,
            "has_frames"     => !!count($frames),
            "handler"        => $this,
            "handlers"       => $this->getRun()->getHandlers(),

            "tables"      => array(
                "GET Data"              => $_GET,
                "POST Data"             => $_POST,
                "Files"                 => $_FILES,
                "Cookies"               => $_COOKIE,
                "Session"               => isset($_SESSION) ? $_SESSION :  array(),
                "Server/Request Data"   => $_SERVER,
                "Environment Variables" => $_ENV,
            ),
        );

        if (isset($customCssFile)) {
            $vars["stylesheet"] .= file_get_contents($customCssFile);
        }

        // Add extra entries list of data tables:
        // @todo: Consolidate addDataTable and addDataTableCallback
        $extraTables = array_map(function ($table) {
            return $table instanceof \Closure ? $table() : $table;
        }, $this->getDataTables());
        $vars["tables"] = array_merge($extraTables, $vars["tables"]);

        $helper->setVariables($vars);
        $helper->render($templateFile);

        return Handler::QUIT;
    }

    /**
     * Adds an entry to the list of tables displayed in the template.
     * The expected data is a simple associative array. Any nested arrays
     * will be flattened with print_r
     * @param string $label
     * @param array  $data
     */
    public function addDataTable($label, array $data)
    {
        $this->extraTables[$label] = $data;
    }

    /**
     * Lazily adds an entry to the list of tables displayed in the table.
     * The supplied callback argument will be called when the error is rendered,
     * it should produce a simple associative array. Any nested arrays will
     * be flattened with print_r.
     *
     * @throws InvalidArgumentException If $callback is not callable
     * @param  string                   $label
     * @param  callable                 $callback Callable returning an associative array
     */
    public function addDataTableCallback($label, /* callable */ $callback)
    {
        if (!is_callable($callback)) {
            throw new InvalidArgumentException('Expecting callback argument to be callable');
        }

        $this->extraTables[$label] = function () use ($callback) {
            try {
                $result = call_user_func($callback);

                // Only return the result if it can be iterated over by foreach().
                return is_array($result) || $result instanceof \Traversable ? $result : array();
            } catch (\Exception $e) {
                // Don't allow failure to break the rendering of the original exception.
                return array();
            }
        };
    }

    /**
     * Returns all the extra data tables registered with this handler.
     * Optionally accepts a 'label' parameter, to only return the data
     * table under that label.
     * @param  string|null      $label
     * @return array[]|callable
     */
    public function getDataTables($label = null)
    {
        if ($label !== null) {
            return isset($this->extraTables[$label]) ?
                   $this->extraTables[$label] : array();
        }

        return $this->extraTables;
    }

    /**
     * Allows to disable all attempts to dynamically decide whether to
     * handle or return prematurely.
     * Set this to ensure that the handler will perform no matter what.
     * @param  bool|null $value
     * @return bool|null
     */
    public function handleUnconditionally($value = null)
    {
        if (func_num_args() == 0) {
            return $this->handleUnconditionally;
        }

        $this->handleUnconditionally = (bool) $value;
    }

    /**
     * Adds an editor resolver, identified by a string
     * name, and that may be a string path, or a callable
     * resolver. If the callable returns a string, it will
     * be set as the file reference's href attribute.
     *
     * @example
     *  $run->addEditor('macvim', "mvim://open?url=file://%file&line=%line")
     * @example
     *   $run->addEditor('remove-it', function($file, $line) {
     *       unlink($file);
     *       return "http://stackoverflow.com";
     *   });
     * @param string $identifier
     * @param string $resolver
     */
    public function addEditor($identifier, $resolver)
    {
        $this->editors[$identifier] = $resolver;
    }

    /**
     * Set the editor to use to open referenced files, by a string
     * identifier, or a callable that will be executed for every
     * file reference, with a $file and $line argument, and should
     * return a string.
     *
     * @example
     *   $run->setEditor(function($file, $line) { return "file:///{$file}"; });
     * @example
     *   $run->setEditor('sublime');
     *
     * @throws InvalidArgumentException If invalid argument identifier provided
     * @param  string|callable          $editor
     */
    public function setEditor($editor)
    {
        if (!is_callable($editor) && !isset($this->editors[$editor])) {
            throw new InvalidArgumentException(
                "Unknown editor identifier: $editor. Known editors:" .
                implode(",", array_keys($this->editors))
            );
        }

        $this->editor = $editor;
    }

    /**
     * Given a string file path, and an integer file line,
     * executes the editor resolver and returns, if available,
     * a string that may be used as the href property for that
     * file reference.
     *
     * @throws InvalidArgumentException If editor resolver does not return a string
     * @param  string                   $filePath
     * @param  int                      $line
     * @return string|bool
     */
    public function getEditorHref($filePath, $line)
    {
        $editor = $this->getEditor($filePath, $line);

        if (!$editor) {
            return false;
        }

        // Check that the editor is a string, and replace the
        // %line and %file placeholders:
        if (!isset($editor['url']) || !is_string($editor['url'])) {
            throw new UnexpectedValueException(
                __METHOD__ . " should always resolve to a string or a valid editor array; got something else instead."
            );
        }

        $editor['url'] = str_replace("%line", rawurlencode($line), $editor['url']);
        $editor['url'] = str_replace("%file", rawurlencode($filePath), $editor['url']);

        return $editor['url'];
    }

    /**
     * Given a boolean if the editor link should
     * act as an Ajax request. The editor must be a
     * valid callable function/closure
     *
     * @throws UnexpectedValueException  If editor resolver does not return a boolean
     * @param  string                   $filePath
     * @param  int                      $line
     * @return bool
     */
    public function getEditorAjax($filePath, $line)
    {
        $editor = $this->getEditor($filePath, $line);

        // Check that the ajax is a bool
        if (!isset($editor['ajax']) || !is_bool($editor['ajax'])) {
            throw new UnexpectedValueException(
                __METHOD__ . " should always resolve to a bool; got something else instead."
            );
        }
        return $editor['ajax'];
    }

    /**
     * Given a boolean if the editor link should
     * act as an Ajax request. The editor must be a
     * valid callable function/closure
     *
     * @throws UnexpectedValueException  If editor resolver does not return a boolean
     * @param  string                   $filePath
     * @param  int                      $line
     * @return mixed
     */
    protected function getEditor($filePath, $line)
    {
        if ($this->editor === null && !is_string($this->editor) && !is_callable($this->editor))
        {
            return false;
        }
        else if(is_string($this->editor) && isset($this->editors[$this->editor]) && !is_callable($this->editors[$this->editor]))
        {
           return array(
                'ajax' => false,
                'url' => $this->editors[$this->editor],
            );
        }
        else if(is_callable($this->editor) || (isset($this->editors[$this->editor]) && is_callable($this->editors[$this->editor])))
        {
            if(is_callable($this->editor))
            {
                $callback = call_user_func($this->editor, $filePath, $line);
            }
            else
            {
                $callback = call_user_func($this->editors[$this->editor], $filePath, $line);
            }

            return array(
                'ajax' => isset($callback['ajax']) ? $callback['ajax'] : false,
                'url' => (is_array($callback) ? $callback['url'] : $callback),
            );
        }

        return false;
    }

    /**
     * @param  string $title
     * @return void
     */
    public function setPageTitle($title)
    {
        $this->pageTitle = (string) $title;
    }

    /**
     * @return string
     */
    public function getPageTitle()
    {
        return $this->pageTitle;
    }

    /**
     * Adds a path to the list of paths to be searched for
     * resources.
     *
     * @throws InvalidArgumnetException If $path is not a valid directory
     *
     * @param  string $path
     * @return void
     */
    public function addResourcePath($path)
    {
        if (!is_dir($path)) {
            throw new InvalidArgumentException(
                "'$path' is not a valid directory"
            );
        }

        array_unshift($this->searchPaths, $path);
    }

    /**
     * Adds a custom css file to be loaded.
     *
     * @param  string $name
     * @return void
     */
    public function addCustomCss($name)
    {
        $this->customCss = $name;
    }

    /**
     * @return array
     */
    public function getResourcePaths()
    {
        return $this->searchPaths;
    }

    /**
     * Finds a resource, by its relative path, in all available search paths.
     * The search is performed starting at the last search path, and all the
     * way back to the first, enabling a cascading-type system of overrides
     * for all resources.
     *
     * @throws RuntimeException If resource cannot be found in any of the available paths
     *
     * @param  string $resource
     * @return string
     */
    protected function getResource($resource)
    {
        // If the resource was found before, we can speed things up
        // by caching its absolute, resolved path:
        if (isset($this->resourceCache[$resource])) {
            return $this->resourceCache[$resource];
        }

        // Search through available search paths, until we find the
        // resource we're after:
        foreach ($this->searchPaths as $path) {
            $fullPath = $path . "/$resource";

            if (is_file($fullPath)) {
                // Cache the result:
                $this->resourceCache[$resource] = $fullPath;
                return $fullPath;
            }
        }

        // If we got this far, nothing was found.
        throw new RuntimeException(
            "Could not find resource '$resource' in any resource paths."
            . "(searched: " . join(", ", $this->searchPaths). ")"
        );
    }

    /**
     * @deprecated
     *
     * @return string
     */
    public function getResourcesPath()
    {
        $allPaths = $this->getResourcePaths();

        // Compat: return only the first path added
        return end($allPaths) ?: null;
    }

    /**
     * @deprecated
     *
     * @param  string $resourcesPath
     * @return void
     */
    public function setResourcesPath($resourcesPath)
    {
        $this->addResourcePath($resourcesPath);
    }
}


1		<?php
2		/**
3		* Whoops - php errors for cool kids
4		* @author Filipe Dobreira <http://github.com/filp>
5		*/
6
7		namespace Whoops\Handler;
8
9		use InvalidArgumentException;
10		use RuntimeException;
11		use UnexpectedValueException;
12		use Whoops\Exception\Formatter;
13		use Whoops\Util\Misc;
14		use Whoops\Util\TemplateHelper;
15
16		class PrettyPageHandler extends Handler
17		{
18		/**
19		* Search paths to be scanned for resources, in the reverse
20		* order they're declared.
21		*
22		* @var array
23		*/
24		private $searchPaths = array();
25
26		/**
27		* Fast lookup cache for known resource locations.
28		*
29		* @var array
30		*/
31		private $resourceCache = array();
32
33		/**
34		* The name of the custom css file.
35		*
36		* @var string
37		*/
38		private $customCss = null;
39
40		/**
41		* @var array[]
42		*/
43		private $extraTables = array();
44
45		/**
46		* @var bool
47		*/
48		private $handleUnconditionally = false;
49
50		/**
51		* @var string
52		*/
53		private $pageTitle = "Whoops! There was an error.";
54
55		/**
56		* A string identifier for a known IDE/text editor, or a closure
57		* that resolves a string that can be used to open a given file
58		* in an editor. If the string contains the special substrings
59		* %file or %line, they will be replaced with the correct data.
60		*
61		* @example
62		* "txmt://open?url=%file&line=%line"
63		* @var mixed $editor
64		*/
65		protected $editor;
66
67		/**
68		* A list of known editor strings
69		* @var array
70		*/
71		protected $editors = array(
72		"sublime" => "subl://open?url=file://%file&line=%line",
73		"textmate" => "txmt://open?url=file://%file&line=%line",
74		"emacs" => "emacs://open?url=file://%file&line=%line",
75		"macvim" => "mvim://open/?url=file://%file&line=%line",
76		"phpstorm" => "phpstorm://open?file=%file&line=%line",
77		);
78
79		/**
80		* Constructor.
81		*/
82	1	public function __construct()
83		{
84	1	if (ini_get('xdebug.file_link_format') \|\| extension_loaded('xdebug')) {
85		// Register editor using xdebug's file_link_format option.
86		$this->editors['xdebug'] = function ($file, $line) {
87	1	return str_replace(array('%f', '%l'), array($file, $line), ini_get('xdebug.file_link_format'));
88		};
89	1	}
90
91		// Add the default, local resource search path:
92	1	$this->searchPaths[] = __DIR__ . "/../Resources";
93	1	}
94
95		/**
96		* @return int\|null
97		*/
98	1	public function handle()
99		{
100	1	if (!$this->handleUnconditionally()) {
		0 ignored issues – show Bug Best Practice introduced 2015-11-21 13:08 UTC by Report Bug Copy Issue Report The expression `$this->handleUnconditionally()` of type `boolean\|null` is loosely compared to `false`; this is ambiguous if the boolean can be false. You might want to explicitly use `!== null` instead. If an expression can have both `false`, and `null` as possible values. It is generally a good practice to always use strict comparison to clearly distinguish between those two values. $a = canBeFalseAndNull(); // Instead of if ( ! $a) { } // Better use one of the explicit versions: if ($a !== null) { } if ($a !== false) { } if ($a !== null && $a !== false) { } Loading history...
101		// Check conditions for outputting HTML:
102		// @todo: Make this more robust
103	1	if (php_sapi_name() === 'cli') {
104		// Help users who have been relying on an internal test value
105		// fix their code to the proper method
106	1	if (isset($_ENV['whoops-test'])) {
107		throw new \Exception(
108		'Use handleUnconditionally instead of whoops-test'
109		.' environment variable'
110		);
111		}
112
113	1	return Handler::DONE;
114		}
115		}
116
117		// @todo: Make this more dynamic
118		$helper = new TemplateHelper();
119
120		$templateFile = $this->getResource("views/layout.html.php");
121		$cssFile = $this->getResource("css/whoops.base.css");
122		$zeptoFile = $this->getResource("js/zepto.min.js");
123		$jsFile = $this->getResource("js/whoops.base.js");
124
125		if ($this->customCss) {
126		$customCssFile = $this->getResource($this->customCss);
127		}
128
129		$inspector = $this->getInspector();
130		$frames = $inspector->getFrames();
131
132		$code = $inspector->getException()->getCode();
133
134		if ($inspector->getException() instanceof \ErrorException) {
135		// ErrorExceptions wrap the php-error types within the "severity" property
136		$code = Misc::translateErrorCode($inspector->getException()->getSeverity());
137		}
138
139		// List of variables that will be passed to the layout template.
140		$vars = array(
141		"page_title" => $this->getPageTitle(),
142
143		// @todo: Asset compiler
144		"stylesheet" => file_get_contents($cssFile),
145		"zepto" => file_get_contents($zeptoFile),
146		"javascript" => file_get_contents($jsFile),
147
148		// Template paths:
149		"header" => $this->getResource("views/header.html.php"),
150		"frame_list" => $this->getResource("views/frame_list.html.php"),
151		"frame_code" => $this->getResource("views/frame_code.html.php"),
152		"env_details" => $this->getResource("views/env_details.html.php"),
153
154		"title" => $this->getPageTitle(),
155		"name" => explode("\\", $inspector->getExceptionName()),
156		"message" => $inspector->getException()->getMessage(),
157		"code" => $code,
158		"plain_exception" => Formatter::formatExceptionPlain($inspector),
159		"frames" => $frames,
160		"has_frames" => !!count($frames),
161		"handler" => $this,
162		"handlers" => $this->getRun()->getHandlers(),
163
164		"tables" => array(
165		"GET Data" => $_GET,
166		"POST Data" => $_POST,
167		"Files" => $_FILES,
168		"Cookies" => $_COOKIE,
169		"Session" => isset($_SESSION) ? $_SESSION : array(),
170		"Server/Request Data" => $_SERVER,
171		"Environment Variables" => $_ENV,
172		),
173		);
174
175		if (isset($customCssFile)) {
176		$vars["stylesheet"] .= file_get_contents($customCssFile);
177		}
178
179		// Add extra entries list of data tables:
180		// @todo: Consolidate addDataTable and addDataTableCallback
181		$extraTables = array_map(function ($table) {
182		return $table instanceof \Closure ? $table() : $table;
183		}, $this->getDataTables());
184		$vars["tables"] = array_merge($extraTables, $vars["tables"]);
185
186		$helper->setVariables($vars);
187		$helper->render($templateFile);
188
189		return Handler::QUIT;
190		}
191
192		/**
193		* Adds an entry to the list of tables displayed in the template.
194		* The expected data is a simple associative array. Any nested arrays
195		* will be flattened with print_r
196		* @param string $label
197		* @param array $data
198		*/
199	1	public function addDataTable($label, array $data)
200		{
201	1	$this->extraTables[$label] = $data;
202	1	}
203
204		/**
205		* Lazily adds an entry to the list of tables displayed in the table.
206		* The supplied callback argument will be called when the error is rendered,
207		* it should produce a simple associative array. Any nested arrays will
208		* be flattened with print_r.
209		*
210		* @throws InvalidArgumentException If $callback is not callable
211		* @param string $label
212		* @param callable $callback Callable returning an associative array
213		*/
214	1	public function addDataTableCallback($label, /* callable */ $callback)
215		{
216	1	if (!is_callable($callback)) {
217		throw new InvalidArgumentException('Expecting callback argument to be callable');
218		}
219
220	1	$this->extraTables[$label] = function () use ($callback) {
221		try {
222	1	$result = call_user_func($callback);
223
224		// Only return the result if it can be iterated over by foreach().
225	1	return is_array($result) \|\| $result instanceof \Traversable ? $result : array();
226		} catch (\Exception $e) {
227		// Don't allow failure to break the rendering of the original exception.
228		return array();
229		}
230		};
231	1	}
232
233		/**
234		* Returns all the extra data tables registered with this handler.
235		* Optionally accepts a 'label' parameter, to only return the data
236		* table under that label.
237		* @param string\|null $label
238		* @return array[]\|callable
239		*/
240	2	public function getDataTables($label = null)
241		{
242	2	if ($label !== null) {
243	2	return isset($this->extraTables[$label]) ?
244	2	$this->extraTables[$label] : array();
245		}
246
247	2	return $this->extraTables;
248		}
249
250		/**
251		* Allows to disable all attempts to dynamically decide whether to
252		* handle or return prematurely.
253		* Set this to ensure that the handler will perform no matter what.
254		* @param bool\|null $value
255		* @return bool\|null
256		*/
257	1	public function handleUnconditionally($value = null)
258		{
259	1	if (func_num_args() == 0) {
260	1	return $this->handleUnconditionally;
261		}
262
263		$this->handleUnconditionally = (bool) $value;
264		}
265
266		/**
267		* Adds an editor resolver, identified by a string
268		* name, and that may be a string path, or a callable
269		* resolver. If the callable returns a string, it will
270		* be set as the file reference's href attribute.
271		*
272		* @example
273		* $run->addEditor('macvim', "mvim://open?url=file://%file&line=%line")
274		* @example
275		* $run->addEditor('remove-it', function($file, $line) {
276		* unlink($file);
277		* return "http://stackoverflow.com";
278		* });
279		* @param string $identifier
280		* @param string $resolver
281		*/
282	1	public function addEditor($identifier, $resolver)
283		{
284	1	$this->editors[$identifier] = $resolver;
285	1	}
286
287		/**
288		* Set the editor to use to open referenced files, by a string
289		* identifier, or a callable that will be executed for every
290		* file reference, with a $file and $line argument, and should
291		* return a string.
292		*
293		* @example
294		* $run->setEditor(function($file, $line) { return "file:///{$file}"; });
295		* @example
296		* $run->setEditor('sublime');
297		*
298		* @throws InvalidArgumentException If invalid argument identifier provided
299		* @param string\|callable $editor
300		*/
301	4	public function setEditor($editor)
302		{
303	4	if (!is_callable($editor) && !isset($this->editors[$editor])) {
304		throw new InvalidArgumentException(
305		"Unknown editor identifier: $editor. Known editors:" .
306		implode(",", array_keys($this->editors))
307		);
308		}
309
310	4	$this->editor = $editor;
311	4	}
312
313		/**
314		* Given a string file path, and an integer file line,
315		* executes the editor resolver and returns, if available,
316		* a string that may be used as the href property for that
317		* file reference.
318		*
319		* @throws InvalidArgumentException If editor resolver does not return a string
320		* @param string $filePath
321		* @param int $line
322		* @return string\|bool
323		*/
324	4	public function getEditorHref($filePath, $line)
325		{
326	4	$editor = $this->getEditor($filePath, $line);
327
328	4	if (!$editor) {
329		return false;
330		}
331
332		// Check that the editor is a string, and replace the
333		// %line and %file placeholders:
334	4	if (!isset($editor['url']) \|\| !is_string($editor['url'])) {
335		throw new UnexpectedValueException(
336		__METHOD__ . " should always resolve to a string or a valid editor array; got something else instead."
337		);
338		}
339
340	4	$editor['url'] = str_replace("%line", rawurlencode($line), $editor['url']);
341	4	$editor['url'] = str_replace("%file", rawurlencode($filePath), $editor['url']);
342
343	4	return $editor['url'];
344		}
345
346		/**
347		* Given a boolean if the editor link should
348		* act as an Ajax request. The editor must be a
349		* valid callable function/closure
350		*
351		* @throws UnexpectedValueException If editor resolver does not return a boolean
352		* @param string $filePath
353		* @param int $line
354		* @return bool
355		*/
356	1	public function getEditorAjax($filePath, $line)
357		{
358	1	$editor = $this->getEditor($filePath, $line);
359
360		// Check that the ajax is a bool
361	1	if (!isset($editor['ajax']) \|\| !is_bool($editor['ajax'])) {
362		throw new UnexpectedValueException(
363		__METHOD__ . " should always resolve to a bool; got something else instead."
364		);
365		}
366	1	return $editor['ajax'];
367		}
368
369		/**
370		* Given a boolean if the editor link should
371		* act as an Ajax request. The editor must be a
372		* valid callable function/closure
373		*
374		* @throws UnexpectedValueException If editor resolver does not return a boolean
375		* @param string $filePath
376		* @param int $line
377		* @return mixed
378		*/
379	1	protected function getEditor($filePath, $line)
380		{
381	1	if ($this->editor === null && !is_string($this->editor) && !is_callable($this->editor))
382	1	{
383		return false;
384		}
385	1	else if(is_string($this->editor) && isset($this->editors[$this->editor]) && !is_callable($this->editors[$this->editor]))
386	1	{
387		return array(
388		'ajax' => false,
389		'url' => $this->editors[$this->editor],
390		);
391		}
392	1	else if(is_callable($this->editor) \|\| (isset($this->editors[$this->editor]) && is_callable($this->editors[$this->editor])))
393	1	{
394	1	if(is_callable($this->editor))
395	1	{
396		$callback = call_user_func($this->editor, $filePath, $line);
397		}
398		else
399		{
400	1	$callback = call_user_func($this->editors[$this->editor], $filePath, $line);
401		}
402
403		return array(
404	1	'ajax' => isset($callback['ajax']) ? $callback['ajax'] : false,
405	1	'url' => (is_array($callback) ? $callback['url'] : $callback),
406	1	);
407		}
408
409		return false;
410		}
411
412		/**
413		* @param string $title
414		* @return void
415		*/
416	1	public function setPageTitle($title)
417		{
418	1	$this->pageTitle = (string) $title;
419	1	}
420
421		/**
422		* @return string
423		*/
424	1	public function getPageTitle()
425		{
426	1	return $this->pageTitle;
427		}
428
429		/**
430		* Adds a path to the list of paths to be searched for
431		* resources.
432		*
433		* @throws InvalidArgumnetException If $path is not a valid directory
434		*
435		* @param string $path
436		* @return void
437		*/
438	2	public function addResourcePath($path)
439		{
440	2	if (!is_dir($path)) {
441	1	throw new InvalidArgumentException(
442	1	"'$path' is not a valid directory"
443	1	);
444		}
445
446	1	array_unshift($this->searchPaths, $path);
447	1	}
448
449		/**
450		* Adds a custom css file to be loaded.
451		*
452		* @param string $name
453		* @return void
454		*/
455		public function addCustomCss($name)
456		{
457		$this->customCss = $name;
458		}
459
460		/**
461		* @return array
462		*/
463	1	public function getResourcePaths()
464		{
465	1	return $this->searchPaths;
466		}
467
468		/**
469		* Finds a resource, by its relative path, in all available search paths.
470		* The search is performed starting at the last search path, and all the
471		* way back to the first, enabling a cascading-type system of overrides
472		* for all resources.
473		*
474		* @throws RuntimeException If resource cannot be found in any of the available paths
475		*
476		* @param string $resource
477		* @return string
478		*/
479		protected function getResource($resource)
480		{
481		// If the resource was found before, we can speed things up
482		// by caching its absolute, resolved path:
483		if (isset($this->resourceCache[$resource])) {
484		return $this->resourceCache[$resource];
485		}
486
487		// Search through available search paths, until we find the
488		// resource we're after:
489		foreach ($this->searchPaths as $path) {
490		$fullPath = $path . "/$resource";
491
492		if (is_file($fullPath)) {
493		// Cache the result:
494		$this->resourceCache[$resource] = $fullPath;
495		return $fullPath;
496		}
497		}
498
499		// If we got this far, nothing was found.
500		throw new RuntimeException(
501		"Could not find resource '$resource' in any resource paths."
502		. "(searched: " . join(", ", $this->searchPaths). ")"
503		);
504		}
505
506		/**
507		* @deprecated
508		*
509		* @return string
510		*/
511		public function getResourcesPath()
512		{
513		$allPaths = $this->getResourcePaths();
514
515		// Compat: return only the first path added
516		return end($allPaths) ?: null;
517		}
518
519		/**
520		* @deprecated
521		*
522		* @param string $resourcesPath
523		* @return void
524		*/
525		public function setResourcesPath($resourcesPath)
526		{
527		$this->addResourcePath($resourcesPath);
528		}
529		}
530

filp / whoops

Pull Request — v1 (#422)

PrettyPageHandler::addDataTable() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like