/evolution/docs/phpdoc/default/Options.html
HTML | 238 lines | 184 code | 48 blank | 6 comment | 0 complexity | 9e3fae812ff15fa3c2475382faea50e8 MD5 | raw file
- <?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 Options</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 Options</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-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
-
- <a href="#sec-const-summary">Constants</a> (<a href="#sec-consts">details</a>)
-
- </div>
- <div class="info-box-body">
- <!-- ========== Info from phpDoc block ========= -->
- <p class="notes">
- Located in <a class="field" href="_evolution---assets---modules---phpids---classes---class.options.php.html">/evolution/assets/modules/phpids/classes/class.options.php</a> (line <span class="field">15</span>)
- </p>
-
-
- <pre></pre>
-
- </div>
- </div>
- <a name="sec-const-summary"></a>
- <div class="info-box">
- <div class="info-box-title">Class Constant Summary</span></div>
- <div class="nav-bar">
- <a href="#sec-description">Description</a> |
- <span class="disabled">Constants</span> (<a href="#sec-consts">details</a>)
- |
- <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
-
- </div>
- <div class="info-box-body">
- <div class="const-summary">
- <div class="const-title">
- <img src="../media/images/Constant.png" alt=" " />
- <a href="#OPTION_LAST_FILTER_UPDATE" title="details" class="const-name">OPTION_LAST_FILTER_UPDATE</a> = <span class="var-type"> 'LAST_FILTER_UPDATE'</span>
- </div>
- </div>
- </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-const-summary">Constants</a> (<a href="#sec-consts">details</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">
- <span class="method-result">Options</span>
- <a href="#__construct" title="details" class="method-name">__construct</a>
- (<span class="var-type">string</span> <span class="var-name">$tableName</span>)
- </div>
- <div class="method-definition">
- <span class="method-result">string</span>
- <a href="#getOption" title="details" class="method-name">getOption</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="#setOption" title="details" class="method-name">setOption</a>
- (<span class="var-type">string</span> <span class="var-name">$name</span>, <span class="var-type">string</span> <span class="var-name">$value</span>)
- </div>
- </div>
- </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-const-summary">Constants</a> (<a href="#sec-consts">details</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="method__construct" id="__construct"><!-- --></a>
- <div class="oddrow">
-
- <div class="method-header">
- <span class="method-title">Constructor __construct</span> (line <span class="line-number">37</span>)
- </div>
-
- <!-- ========== Info from phpDoc block ========= -->
- <p class="short-description">Creates the option object</p>
- <ul class="tags">
- <li><span class="field">access:</span> public</li>
- </ul>
-
- <div class="method-signature">
- <span class="method-result">Options</span>
- <span class="method-name">
- __construct
- </span>
- (<span class="var-type">string</span> <span class="var-name">$tableName</span>)
- </div>
-
- <ul class="parameters">
- <li>
- <span class="var-type">string</span>
- <span class="var-name">$tableName</span><span class="var-description">: The name of the table used to store the options</span> </li>
- </ul>
-
-
- </div>
- <a name="methodgetOption" id="getOption"><!-- --></a>
- <div class="evenrow">
-
- <div class="method-header">
- <span class="method-title">getOption</span> (line <span class="line-number">110</span>)
- </div>
-
- <!-- ========== Info from phpDoc block ========= -->
- <p class="short-description">Returns the option value for the given name, empty if the option does not exist.</p>
- <ul class="tags">
- <li><span class="field">return:</span> The option value for the given name, empty if the option does not exist</li>
- <li><span class="field">throws:</span> If $name is empty</li>
- <li><span class="field">access:</span> public</li>
- </ul>
-
- <div class="method-signature">
- <span class="method-result">string</span>
- <span class="method-name">
- getOption
- </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">: The name of the option</span> </li>
- </ul>
-
-
- </div>
- <a name="methodsetOption" id="setOption"><!-- --></a>
- <div class="oddrow">
-
- <div class="method-header">
- <span class="method-title">setOption</span> (line <span class="line-number">75</span>)
- </div>
-
- <!-- ========== Info from phpDoc block ========= -->
- <p class="short-description">Write an option value with the given option name to the database.</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">
- setOption
- </span>
- (<span class="var-type">string</span> <span class="var-name">$name</span>, <span class="var-type">string</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">: The name of the option</span> </li>
- <li>
- <span class="var-type">string</span>
- <span class="var-name">$value</span><span class="var-description">: The value of the option</span> </li>
- </ul>
-
-
- </div>
-
- </div>
- </div>
- <a name="sec-consts"></a>
- <div class="info-box">
- <div class="info-box-title">Class Constants</div>
- <div class="nav-bar">
- <a href="#sec-description">Description</a> |
- <a href="#sec-var-summary">Constants</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">
- <a name="constOPTION_LAST_FILTER_UPDATE" id="OPTION_LAST_FILTER_UPDATE"><!-- --></A>
- <div class="evenrow">
- <div class="const-header">
- <img src="../media/images/Variable.png" />
- <span class="const-title">
- <span class="const-name">OPTION_LAST_FILTER_UPDATE</span>
- = <span class="const-default"> 'LAST_FILTER_UPDATE'</span>
- (line <span class="line-number">19</span>)
- </span>
- </div>
- <!-- ========== Info from phpDoc block ========= -->
- <p class="short-description">Constant string with the option name for last filter update</p>
-
-
- </div>
-
- </div>
- </div>
- <p class="notes" id="credit">
- Documentation generated on Mon, 27 Feb 2012 21:57:01 +0100 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
- </p>
- </div></body>
- </html>