392 lines
No EOL
12 KiB
HTML
392 lines
No EOL
12 KiB
HTML
<?xml version="1.0" encoding="iso-8859-1"?>
|
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
<html xmlns="http://www.w3.org/1999/xhtml">
|
|
<head>
|
|
<!-- template designed by Marco Von Ballmoos -->
|
|
<title>Docs for page pickles.php</title>
|
|
<link rel="stylesheet" href="../media/stylesheet.css" />
|
|
<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
|
|
</head>
|
|
<body>
|
|
<div class="page-body">
|
|
<h2 class="file-name">/pickles.php</h2>
|
|
|
|
<a name="sec-description"></a>
|
|
<div class="info-box">
|
|
<div class="info-box-title">Description</div>
|
|
<div class="nav-bar">
|
|
<span class="disabled">Description</span> |
|
|
<a href="#sec-constants">Constants</a>
|
|
| <a href="#sec-functions">Functions</a>
|
|
</div>
|
|
<div class="info-box-body">
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">Core PICKLES Include File</p>
|
|
<p class="description"><p>This is the file that you include on the page you're instantiating the controller from (typically index.php). The path to the PICKLES code base is established as well as the path that Smarty will use to store the compiled pages.</p><p>PHP version 5</p><p>Licensed under The MIT License Redistribution of these files must retain the above copyright notice.</p></p>
|
|
<ul class="tags">
|
|
<li><span class="field">author:</span> Josh Sherman <<a href="mailto:josh@gravityblvd.com">josh@gravityblvd.com</a>></li>
|
|
<li><span class="field">copyright:</span> Copyright 2007-2010, Gravity Boulevard, LLC</li>
|
|
<li><span class="field">link:</span> <a href="http://p.ickl.es">http://p.ickl.es</a></li>
|
|
<li><span class="field">usage:</span> <div class="src-code"><ol><li><div class="src-line"><span class="src-inc">require_once </span><span class="src-str">'pickles.php'</span><span class="src-sym">;</span></div></li>
|
|
</ol></div></li>
|
|
<li><span class="field">license:</span> <a href="http://www.opensource.org/licenses/mit-license.html">http://www.opensource.org/licenses/mit-license.html</a></li>
|
|
</ul>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
<a name="sec-constants"></a>
|
|
<div class="info-box">
|
|
<div class="info-box-title">Constants</div>
|
|
<div class="nav-bar">
|
|
<a href="#sec-description">Description</a> |
|
|
<span class="disabled">Constants</span>
|
|
| <a href="#sec-functions">Functions</a>
|
|
</div>
|
|
<div class="info-box-body">
|
|
<a name="defineDISPLAY_JSON"><!-- --></a>
|
|
<div class="evenrow">
|
|
|
|
<div>
|
|
<span class="const-title">
|
|
<span class="const-name">DISPLAY_JSON</span> = 'JSON'
|
|
(line <span class="line-number">46</span>)
|
|
</span>
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
|
|
|
|
</div>
|
|
<a name="defineDISPLAY_PHP"><!-- --></a>
|
|
<div class="oddrow">
|
|
|
|
<div>
|
|
<span class="const-title">
|
|
<span class="const-name">DISPLAY_PHP</span> = 'PHP'
|
|
(line <span class="line-number">47</span>)
|
|
</span>
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
|
|
|
|
</div>
|
|
<a name="defineDISPLAY_RSS"><!-- --></a>
|
|
<div class="evenrow">
|
|
|
|
<div>
|
|
<span class="const-title">
|
|
<span class="const-name">DISPLAY_RSS</span> = 'RSS'
|
|
(line <span class="line-number">48</span>)
|
|
</span>
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
|
|
|
|
</div>
|
|
<a name="defineDISPLAY_XML"><!-- --></a>
|
|
<div class="oddrow">
|
|
|
|
<div>
|
|
<span class="const-title">
|
|
<span class="const-name">DISPLAY_XML</span> = 'XML'
|
|
(line <span class="line-number">49</span>)
|
|
</span>
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
|
|
|
|
</div>
|
|
<a name="defineJSON_AVAILABLE"><!-- --></a>
|
|
<div class="evenrow">
|
|
|
|
<div>
|
|
<span class="const-title">
|
|
<span class="const-name">JSON_AVAILABLE</span> = function_exists('json_encode')
|
|
(line <span class="line-number">52</span>)
|
|
</span>
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
|
|
|
|
</div>
|
|
<a name="defineLOG_PATH"><!-- --></a>
|
|
<div class="oddrow">
|
|
|
|
<div>
|
|
<span class="const-title">
|
|
<span class="const-name">LOG_PATH</span> = PRIVATE_PATH.'logs/'
|
|
(line <span class="line-number">42</span>)
|
|
</span>
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
|
|
|
|
</div>
|
|
<a name="definePICKLES_CLASS_PATH"><!-- --></a>
|
|
<div class="evenrow">
|
|
|
|
<div>
|
|
<span class="const-title">
|
|
<span class="const-name">PICKLES_CLASS_PATH</span> = PICKLES_PATH.'classes/'
|
|
(line <span class="line-number">31</span>)
|
|
</span>
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
|
|
|
|
</div>
|
|
<a name="definePICKLES_PATH"><!-- --></a>
|
|
<div class="oddrow">
|
|
|
|
<div>
|
|
<span class="const-title">
|
|
<span class="const-name">PICKLES_PATH</span> = dirname(__FILE__).'/'
|
|
(line <span class="line-number">30</span>)
|
|
</span>
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
|
|
|
|
</div>
|
|
<a name="definePICKLES_START_TIME"><!-- --></a>
|
|
<div class="evenrow">
|
|
|
|
<div>
|
|
<span class="const-title">
|
|
<span class="const-name">PICKLES_START_TIME</span> = microtime(true)
|
|
(line <span class="line-number">27</span>)
|
|
</span>
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
|
|
|
|
</div>
|
|
<a name="definePRIVATE_PATH"><!-- --></a>
|
|
<div class="oddrow">
|
|
|
|
<div>
|
|
<span class="const-title">
|
|
<span class="const-name">PRIVATE_PATH</span> = SITE_PATH.'private/'
|
|
(line <span class="line-number">41</span>)
|
|
</span>
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
|
|
|
|
</div>
|
|
<a name="defineSITE_CLASS_PATH"><!-- --></a>
|
|
<div class="evenrow">
|
|
|
|
<div>
|
|
<span class="const-title">
|
|
<span class="const-name">SITE_CLASS_PATH</span> = SITE_PATH.'classes/'
|
|
(line <span class="line-number">36</span>)
|
|
</span>
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
|
|
|
|
</div>
|
|
<a name="defineSITE_MODEL_PATH"><!-- --></a>
|
|
<div class="oddrow">
|
|
|
|
<div>
|
|
<span class="const-title">
|
|
<span class="const-name">SITE_MODEL_PATH</span> = SITE_PATH.'models/'
|
|
(line <span class="line-number">37</span>)
|
|
</span>
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
|
|
|
|
</div>
|
|
<a name="defineSITE_MODULE_PATH"><!-- --></a>
|
|
<div class="evenrow">
|
|
|
|
<div>
|
|
<span class="const-title">
|
|
<span class="const-name">SITE_MODULE_PATH</span> = SITE_PATH.'modules/'
|
|
(line <span class="line-number">38</span>)
|
|
</span>
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
|
|
|
|
</div>
|
|
<a name="defineSITE_PATH"><!-- --></a>
|
|
<div class="oddrow">
|
|
|
|
<div>
|
|
<span class="const-title">
|
|
<span class="const-name">SITE_PATH</span> = getcwd().'/../'
|
|
(line <span class="line-number">34</span>)
|
|
</span>
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
|
|
|
|
</div>
|
|
<a name="defineSITE_TEMPLATE_PATH"><!-- --></a>
|
|
<div class="evenrow">
|
|
|
|
<div>
|
|
<span class="const-title">
|
|
<span class="const-name">SITE_TEMPLATE_PATH</span> = SITE_PATH.'templates/'
|
|
(line <span class="line-number">39</span>)
|
|
</span>
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
|
|
|
|
</div>
|
|
<a name="defineSMARTY_PATH"><!-- --></a>
|
|
<div class="oddrow">
|
|
|
|
<div>
|
|
<span class="const-title">
|
|
<span class="const-name">SMARTY_PATH</span> = PRIVATE_PATH.'smarty/'
|
|
(line <span class="line-number">43</span>)
|
|
</span>
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<a name="sec-functions"></a>
|
|
<div class="info-box">
|
|
<div class="info-box-title">Functions</div>
|
|
<div class="nav-bar">
|
|
<a href="#sec-description">Description</a> |
|
|
<a href="#sec-constants">Constants</a>
|
|
| <span class="disabled">Functions</span>
|
|
</div>
|
|
<div class="info-box-body">
|
|
<a name="function__autoload" id="function__autoload"><!-- --></a>
|
|
<div class="evenrow">
|
|
|
|
<div>
|
|
<span class="method-title">__autoload</span> (line <span class="line-number">121</span>)
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">Magic function to automatically load classes</p>
|
|
<p class="description"><p>Attempts to load a core PICKLES class or a site level data model or module class. If Smarty is being requested, will load the proper class from the vendors directory</p></p>
|
|
<ul class="tags">
|
|
<li><span class="field">return:</span> Return value of require_once() or false (default)</li>
|
|
</ul>
|
|
|
|
<div class="method-signature">
|
|
<span class="method-result">boolean</span>
|
|
<span class="method-name">
|
|
__autoload
|
|
</span>
|
|
(<span class="var-type">string</span> <span class="var-name">$class</span>)
|
|
</div>
|
|
|
|
<ul class="parameters">
|
|
<li>
|
|
<span class="var-type">string</span>
|
|
<span class="var-name">$class</span><span class="var-description">: Name of the class to be loaded</span> </li>
|
|
</ul>
|
|
|
|
|
|
</div>
|
|
<a name="function__handleError" id="function__handleError"><!-- --></a>
|
|
<div class="oddrow">
|
|
|
|
<div>
|
|
<span class="method-title">__handleError</span> (line <span class="line-number">158</span>)
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">Error handling function that thinks it's magical</p>
|
|
<p class="description"><p>Catches errors (warnings and the like) and throws it back out as an ErrorException. This really helps trapping complex errors that need a ton of sanity checks, just try / catch and you're good. Also, this isn't a magic function, but I opted to use the __ prefix to help avoid a naming collision since namespace support is 5.3+ and PICKLES strives to be 5.0+ compatible.</p><p>Keep in mind that fetal errors cannot and will not be handled.</p></p>
|
|
<ul class="tags">
|
|
<li><span class="field">return:</span> not really returned, but worth documenting</li>
|
|
</ul>
|
|
|
|
<div class="method-signature">
|
|
<span class="method-result">ErrorException</span>
|
|
<span class="method-name">
|
|
__handleError
|
|
</span>
|
|
(<span class="var-type">integer</span> <span class="var-name">$number</span>, <span class="var-type">string</span> <span class="var-name">$string</span>, <span class="var-type">string</span> <span class="var-name">$file</span>, <span class="var-type">integer</span> <span class="var-name">$line</span>, <span class="var-type"></span> <span class="var-name">$context</span>)
|
|
</div>
|
|
|
|
<ul class="parameters">
|
|
<li>
|
|
<span class="var-type">integer</span>
|
|
<span class="var-name">$number</span><span class="var-description">: error number</span> </li>
|
|
<li>
|
|
<span class="var-type">string</span>
|
|
<span class="var-name">$string</span><span class="var-description">: error string (message)</span> </li>
|
|
<li>
|
|
<span class="var-type">string</span>
|
|
<span class="var-name">$file</span><span class="var-description">: name of the file with the error</span> </li>
|
|
<li>
|
|
<span class="var-type">integer</span>
|
|
<span class="var-name">$line</span><span class="var-description">: line number the error occurred on</span> </li>
|
|
<li>
|
|
<span class="var-type">array</span>
|
|
<span class="var-name">$context</span><span class="var-description">: variables that were in play</span> </li>
|
|
</ul>
|
|
|
|
|
|
</div>
|
|
<a name="function__handleException" id="function__handleException"><!-- --></a>
|
|
<div class="evenrow">
|
|
|
|
<div>
|
|
<span class="method-title">__handleException</span> (line <span class="line-number">176</span>)
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">Exception handling function</p>
|
|
<p class="description"><p>Catches thrown exceptions and displays them.</p></p>
|
|
|
|
<div class="method-signature">
|
|
<span class="method-result">void</span>
|
|
<span class="method-name">
|
|
__handleException
|
|
</span>
|
|
(<span class="var-type">object</span> <span class="var-name">$exception</span>)
|
|
</div>
|
|
|
|
<ul class="parameters">
|
|
<li>
|
|
<span class="var-type">object</span>
|
|
<span class="var-name">$exception</span><span class="var-description">: the exception</span> </li>
|
|
</ul>
|
|
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
<p class="notes" id="credit">
|
|
Documentation generated on Sun, 17 Oct 2010 23:17:23 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
|
|
</p>
|
|
</div></body>
|
|
</html> |