314 lines
No EOL
12 KiB
HTML
314 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 Class Config</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="class-name">Class Config</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-vars">Vars</a>
|
|
| <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
|
|
|
|
</div>
|
|
<div class="info-box-body">
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">Config Class</p>
|
|
<p class="description"><p>Handles loading the site's configuration file (if available). At the moment this class is a very skewed Singleton. The plan is to eventually extend this out to support multiple configuration files, and the ability to load in custom config files on the fly as well. The core of PICKLES uses the class as a Singleton so we're not loading the configuration multiple times per page load.</p></p>
|
|
<ul class="tags">
|
|
<li><span class="field">usage:</span> <div class="src-code"><ol><li><div class="src-line"><span class="src-var">$config </span>= <span class="src-key">new </span><span class="src-id"><a href="../PICKLES/Config.html">Config</a></span><span class="src-sym">(</span><span class="src-var">$filename</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
|
|
</ol></div></li>
|
|
</ul>
|
|
<p class="notes">
|
|
Located in <a class="field" href="_classes---Config.php.html">/classes/Config.php</a> (line <span class="field">30</span>)
|
|
</p>
|
|
|
|
|
|
<pre><a href="../PICKLES/Object.html">Object</a>
|
|
|
|
|
--Config</pre>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<a name="sec-method-summary"></a>
|
|
<div class="info-box">
|
|
<div class="info-box-title">Method Summary</span></div>
|
|
<div class="nav-bar">
|
|
<a href="#sec-description">Description</a> |
|
|
<a href="#sec-vars">Vars</a>
|
|
|
|
|
|
|
<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
|
|
</div>
|
|
<div class="info-box-body">
|
|
<div class="method-summary">
|
|
<div class="method-definition">
|
|
static <span class="method-result">object self::$instance</span>
|
|
<a href="#getInstance" title="details" class="method-name">getInstance</a>
|
|
([<span class="var-type">string</span> <span class="var-name">$class</span> = <span class="var-default">'Config'</span>])
|
|
</div>
|
|
|
|
<div class="method-definition">
|
|
<span class="method-result">Config</span>
|
|
<a href="#__construct" title="details" class="method-name">__construct</a>
|
|
([<span class="var-type">string</span> <span class="var-name">$filename</span> = <span class="var-default">'../config.php'</span>])
|
|
</div>
|
|
<div class="method-definition">
|
|
<span class="method-result">boolean</span>
|
|
<a href="#load" title="details" class="method-name">load</a>
|
|
(<span class="var-type">string</span> <span class="var-name">$filename</span>)
|
|
</div>
|
|
<div class="method-definition">
|
|
<span class="method-result">mixed</span>
|
|
<a href="#__get" title="details" class="method-name">__get</a>
|
|
(<span class="var-type">string</span> <span class="var-name">$name</span>)
|
|
</div>
|
|
<div class="method-definition">
|
|
<span class="method-result">void</span>
|
|
<a href="#__set" title="details" class="method-name">__set</a>
|
|
(<span class="var-type">string</span> <span class="var-name">$name</span>, <span class="var-type">mixed</span> <span class="var-name">$value</span>)
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
<a name="sec-vars"></a>
|
|
<div class="info-box">
|
|
<div class="info-box-title">Variables</div>
|
|
<div class="nav-bar">
|
|
<a href="#sec-description">Description</a> |
|
|
<a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)
|
|
|
|
|
|
|
|
|
<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
|
|
|
|
</div>
|
|
<div class="info-box-body">
|
|
<h4>Inherited Variables</h4>
|
|
<A NAME='inherited_vars'><!-- --></A>
|
|
<p>Inherited from <span class="classname"><a href="../PICKLES/Object.html">Object</a></span></p>
|
|
<blockquote>
|
|
<span class="var-title">
|
|
<span class="var-name"><a href="../PICKLES/Object.html#var$config">Object::$config</a></span><br>
|
|
</span>
|
|
<span class="var-title">
|
|
<span class="var-name"><a href="../PICKLES/Object.html#var$instances">Object::$instances</a></span><br>
|
|
</span>
|
|
</blockquote>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<a name="sec-methods"></a>
|
|
<div class="info-box">
|
|
<div class="info-box-title">Methods</div>
|
|
<div class="nav-bar">
|
|
<a href="#sec-description">Description</a> |
|
|
<a href="#sec-vars">Vars</a>
|
|
<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
|
|
|
|
</div>
|
|
<div class="info-box-body">
|
|
<A NAME='method_detail'></A>
|
|
<a name="methodgetInstance" id="getInstance"><!-- --></a>
|
|
<div class="evenrow">
|
|
|
|
<div class="method-header">
|
|
<span class="method-title">static method getInstance</span> (line <span class="line-number">149</span>)
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">Get instance of the object</p>
|
|
<p class="description"><p>Let's the parent class do all the work</p></p>
|
|
<ul class="tags">
|
|
<li><span class="field">return:</span> instance of the Config class</li>
|
|
<li><span class="field">access:</span> public</li>
|
|
</ul>
|
|
|
|
<div class="method-signature">
|
|
static
|
|
<span class="method-result">object self::$instance</span>
|
|
<span class="method-name">
|
|
getInstance
|
|
</span>
|
|
([<span class="var-type">string</span> <span class="var-name">$class</span> = <span class="var-default">'Config'</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 instantiate</span> </li>
|
|
</ul>
|
|
|
|
<hr class="separator" />
|
|
<div class="notes">Redefinition of:</div>
|
|
<dl>
|
|
<dt><a href="../PICKLES/Object.html#methodgetInstance">Object::getInstance()</a></dt>
|
|
<dd>Get Instance</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
|
|
<a name="method__construct" id="__construct"><!-- --></a>
|
|
<div class="oddrow">
|
|
|
|
<div class="method-header">
|
|
<span class="method-title">Constructor __construct</span> (line <span class="line-number">47</span>)
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">Constructor</p>
|
|
<p class="description"><p>Calls the parent constructor and loads the passed file.</p></p>
|
|
<ul class="tags">
|
|
<li><span class="field">access:</span> public</li>
|
|
</ul>
|
|
|
|
<div class="method-signature">
|
|
<span class="method-result">Config</span>
|
|
<span class="method-name">
|
|
__construct
|
|
</span>
|
|
([<span class="var-type">string</span> <span class="var-name">$filename</span> = <span class="var-default">'../config.php'</span>])
|
|
</div>
|
|
|
|
<ul class="parameters">
|
|
<li>
|
|
<span class="var-type">string</span>
|
|
<span class="var-name">$filename</span><span class="var-description">: optional Filename of the config</span> </li>
|
|
</ul>
|
|
|
|
<hr class="separator" />
|
|
<div class="notes">Redefinition of:</div>
|
|
<dl>
|
|
<dt><a href="../PICKLES/Object.html#method__construct">Object::__construct()</a></dt>
|
|
<dd>Constructor</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
<a name="methodload" id="load"><!-- --></a>
|
|
<div class="evenrow">
|
|
|
|
<div class="method-header">
|
|
<span class="method-title">load</span> (line <span class="line-number">60</span>)
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">Loads a configuration file</p>
|
|
<ul class="tags">
|
|
<li><span class="field">return:</span> success of the load process</li>
|
|
<li><span class="field">access:</span> public</li>
|
|
</ul>
|
|
|
|
<div class="method-signature">
|
|
<span class="method-result">boolean</span>
|
|
<span class="method-name">
|
|
load
|
|
</span>
|
|
(<span class="var-type">string</span> <span class="var-name">$filename</span>)
|
|
</div>
|
|
|
|
<ul class="parameters">
|
|
<li>
|
|
<span class="var-type">string</span>
|
|
<span class="var-name">$filename</span><span class="var-description">: filename of the config file</span> </li>
|
|
</ul>
|
|
|
|
|
|
</div>
|
|
<a name="method__get" id="__get"><!-- --></a>
|
|
<div class="oddrow">
|
|
|
|
<div class="method-header">
|
|
<span class="method-title">__get</span> (line <span class="line-number">176</span>)
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">Magic Getter Method</p>
|
|
<p class="description"><p>Attempts to load the config variable. If it's not set, will override the variable with boolean false.</p></p>
|
|
<ul class="tags">
|
|
<li><span class="field">return:</span> value of the variable or boolean false</li>
|
|
<li><span class="field">access:</span> public</li>
|
|
</ul>
|
|
|
|
<div class="method-signature">
|
|
<span class="method-result">mixed</span>
|
|
<span class="method-name">
|
|
__get
|
|
</span>
|
|
(<span class="var-type">string</span> <span class="var-name">$name</span>)
|
|
</div>
|
|
|
|
<ul class="parameters">
|
|
<li>
|
|
<span class="var-type">string</span>
|
|
<span class="var-name">$name</span><span class="var-description">: name of the variable requested</span> </li>
|
|
</ul>
|
|
|
|
|
|
</div>
|
|
<a name="method__set" id="__set"><!-- --></a>
|
|
<div class="evenrow">
|
|
|
|
<div class="method-header">
|
|
<span class="method-title">__set</span> (line <span class="line-number">162</span>)
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">Magic Setter Method</p>
|
|
<p class="description"><p>Prohibits the direct modification of module variables.</p></p>
|
|
<ul class="tags">
|
|
<li><span class="field">access:</span> public</li>
|
|
</ul>
|
|
|
|
<div class="method-signature">
|
|
<span class="method-result">void</span>
|
|
<span class="method-name">
|
|
__set
|
|
</span>
|
|
(<span class="var-type">string</span> <span class="var-name">$name</span>, <span class="var-type">mixed</span> <span class="var-name">$value</span>)
|
|
</div>
|
|
|
|
<ul class="parameters">
|
|
<li>
|
|
<span class="var-type">string</span>
|
|
<span class="var-name">$name</span><span class="var-description">: name of the variable to be set</span> </li>
|
|
<li>
|
|
<span class="var-type">mixed</span>
|
|
<span class="var-name">$value</span><span class="var-description">: value of the variable to be set</span> </li>
|
|
</ul>
|
|
|
|
|
|
</div>
|
|
<h4>Inherited Methods</h4>
|
|
<a name='inherited_methods'><!-- --></a>
|
|
<!-- =========== Summary =========== -->
|
|
<p>Inherited From <span class="classname"><a href="../PICKLES/Object.html">Object</a></span></p>
|
|
<blockquote>
|
|
<span class="method-name"><a href="../PICKLES/Object.html#method__construct">Object::__construct()</a></span><br>
|
|
<span class="method-name"><a href="../PICKLES/Object.html#methodgetInstance">Object::getInstance()</a></span><br>
|
|
<span class="method-name"><a href="../PICKLES/Object.html#method__destruct">Object::__destruct()</a></span><br>
|
|
</blockquote>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<p class="notes" id="credit">
|
|
Documentation generated on Sun, 17 Oct 2010 23:17:22 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
|
|
</p>
|
|
</div></body>
|
|
</html> |