PageRenderTime 44ms CodeModel.GetById 15ms RepoModel.GetById 0ms app.codeStats 0ms

/version/1.1.2/apidoc/offline/class.Solar_Controller_Command.Properties.html

https://bitbucket.org/solarphp/docs
HTML | 212 lines | 172 code | 40 blank | 0 comment | 0 complexity | 5dd3a1d9b8b2f5a6eba720627a8ea711 MD5 | raw file
Possible License(s): IPL-1.0, LGPL-2.0, Apache-2.0, 0BSD 
    

  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
    2. 

  2.                       "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
    3. 

  3. <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
    4. 

  4. <head>
    5. 

  5.     <meta http-equiv="content-type" content="text/html; charset=UTF-8"/>
    6. 

  6.     <title>Solar Package and Class Documentation: Properties</title>
    7. 

  7. <link media="all" rel="stylesheet" type="text/css" href="styles/b4db1014032d6f7d071cc2ad04e14402-style.css" />
    8. 

  8. 

  9. </head>
    10. 

  10. <body>
    11. 

  11. <table width="100%">
    12. 

  12.     <tr valign="top">
    13. 

  13.         <td style="font-size: smaller;" width="15%">
    14. 

  14.         <style type="text/css">
    15. 

  15. #leftbar {
    16. 

  16. 	float: left;
    17. 

  17. 	width: 186px;
    18. 

  18. 	padding: 5px;
    19. 

  19. 	font-size: smaller;
    20. 

  20. }
    21. 

  21. ul.toc {
    22. 

  22. 	margin: 0px 5px 5px 5px;
    23. 

  23. 	padding: 0px;
    24. 

  24. }
    25. 

  25. ul.toc li {
    26. 

  26. 	font-size: 85%;
    27. 

  27. 	margin: 1px 0 1px 1px;
    28. 

  28. 	padding: 1px 0 1px 11px;
    29. 

  29. 	list-style-type: none;
    30. 

  30. 	background-repeat: no-repeat;
    31. 

  31. 	background-position: center left;
    32. 

  32. }
    33. 

  33. ul.toc li.header {
    34. 

  34. 	font-size: 115%;
    35. 

  35. 	padding: 5px 0px 5px 11px;
    36. 

  36. 	border-bottom: 1px solid #cccccc;
    37. 

  37. 	margin-bottom: 5px;
    38. 

  38. }
    39. 

  39. ul.toc li.active {
    40. 

  40. 	font-weight: bold;
    41. 

  41. }
    42. 

  42. ul.toc li a {
    43. 

  43. 	text-decoration: none;
    44. 

  44. }
    45. 

  45. ul.toc li a:hover {
    46. 

  46. 	text-decoration: underline;
    47. 

  47. }
    48. 

  48. </style>
    49. 

  49.  <ul class="toc">
    50. 

  50.   <li class="header home"><a href="apidoc.html">Solar Package and Class Documentation</a></li>
    51. 

  51.   <li class="header up"><a href="apidoc.html">Solar Package and Class Documentation</a></li>
    52. 

  52.   <li class="header up"><a href="class.html">Classes</a></li>
    53. 

  53.   <li class="header up"><a href="class.Solar_Controller_Command.html">Solar_Controller_Command</a></li>
    54. 

  54.   <li><a href="class.Solar_Controller_Command.Overview.html">Overview</a></li>
    55. 

  55.   <li><a href="class.Solar_Controller_Command.Config.html">Configuration</a></li>
    56. 

  56.   <li><a href="class.Solar_Controller_Command.Constants.html">Constants</a></li>
    57. 

  57.   <li class="active"><a href="class.Solar_Controller_Command.Properties.html">Properties</a></li>
    58. 

  58.   <li><a href="class.Solar_Controller_Command.Methods.html">Methods</a></li>
    59. 

  59.   <li><a href="class.Solar_Controller_Command.__construct.html">Solar_Controller_Command::__construct()</a></li>
    60. 

  60.   <li><a href="class.Solar_Controller_Command.__destruct.html">Solar_Controller_Command::__destruct()</a></li>
    61. 

  61.   <li><a href="class.Solar_Controller_Command._buildConfig.html">Solar_Controller_Command::_buildConfig()</a></li>
    62. 

  62.   <li><a href="class.Solar_Controller_Command._err.html">Solar_Controller_Command::_err()</a></li>
    63. 

  63.   <li><a href="class.Solar_Controller_Command._errln.html">Solar_Controller_Command::_errln()</a></li>
    64. 

  64.   <li><a href="class.Solar_Controller_Command._exception.html">Solar_Controller_Command::_exception()</a></li>
    65. 

  65.   <li><a href="class.Solar_Controller_Command._exec.html">Solar_Controller_Command::_exec()</a></li>
    66. 

  66.   <li><a href="class.Solar_Controller_Command._fetchGetoptOptions.html">Solar_Controller_Command::_fetchGetoptOptions()</a></li>
    67. 

  67.   <li><a href="class.Solar_Controller_Command._out.html">Solar_Controller_Command::_out()</a></li>
    68. 

  68.   <li><a href="class.Solar_Controller_Command._outln.html">Solar_Controller_Command::_outln()</a></li>
    69. 

  69.   <li><a href="class.Solar_Controller_Command._postConfig.html">Solar_Controller_Command::_postConfig()</a></li>
    70. 

  70.   <li><a href="class.Solar_Controller_Command._postConstruct.html">Solar_Controller_Command::_postConstruct()</a></li>
    71. 

  71.   <li><a href="class.Solar_Controller_Command._postExec.html">Solar_Controller_Command::_postExec()</a></li>
    72. 

  72.   <li><a href="class.Solar_Controller_Command._preConfig.html">Solar_Controller_Command::_preConfig()</a></li>
    73. 

  73.   <li><a href="class.Solar_Controller_Command._preExec.html">Solar_Controller_Command::_preExec()</a></li>
    74. 

  74.   <li><a href="class.Solar_Controller_Command._setup.html">Solar_Controller_Command::_setup()</a></li>
    75. 

  75.   <li><a href="class.Solar_Controller_Command.dump.html">Solar_Controller_Command::dump()</a></li>
    76. 

  76.   <li><a href="class.Solar_Controller_Command.exec.html">Solar_Controller_Command::exec()</a></li>
    77. 

  77.   <li><a href="class.Solar_Controller_Command.getInfoHelp.html">Solar_Controller_Command::getInfoHelp()</a></li>
    78. 

  78.   <li><a href="class.Solar_Controller_Command.getInfoOptions.html">Solar_Controller_Command::getInfoOptions()</a></li>
    79. 

  79.   <li><a href="class.Solar_Controller_Command.locale.html">Solar_Controller_Command::locale()</a></li>
    80. 

  80.   <li><a href="class.Solar_Controller_Command.setConsoleController.html">Solar_Controller_Command::setConsoleController()</a></li>
    81. 

  81.  </ul>
    82. 

  82. 

  83.         </td>
    84. 

  84.         <td width="85%">
    85. 

  85.             <div class="navheader">
    86. 

  86.                 <table width="100%" summary="Navigation header">
    87. 

  87.                     <tr>
    88. 

  88.                         <th colspan="3" align="center">Properties</th>
    89. 

  89.                     </tr>
    90. 

  90.                     <tr>
    91. 

  91.                         <td width="20%" align="left"><a accesskey="p" href="class.Solar_Controller_Command.Constants.html">Prev</a></td>
    92. 

  92.                         <th width="60%" align="center">Solar_Controller_Command</th>
    93. 

  93.                         <td width="20%" align="right"><a accesskey="n" href="class.Solar_Controller_Command.Methods.html">Next</a></td>
    94. 

  94.                     </tr>
    95. 

  95.                 </table>
    96. 

  96.             </div>
    97. 

  97.             <hr/>
    98. 

  98. 

  99. <div id="class.Solar_Controller_Command.Properties" class="section">
    100. 

  100. 

  101. <h1>Properties</h1>
    102. 

  102. 

  103. <p class="para">Properties existing in the <code class="literal">Solar_Controller_Command</code> class.</p>
    104. 

  104. 

  105. <div>
    106. 

  106. <h2>Public</h2>
    107. 

  107. 

  108. <p class="para">None.</p>
    109. 

  109. 

  110. </div>
    111. 

  111. 

  112. <div>
    113. 

  113. <h2>Protected</h2>
    114. 

  114. 

  115. <div id="class.Solar_Controller_Command.Properties._config">
    116. 

  116. <h3><code class="literal">$_config</code> </h3>
    117. 

  117. 

  118. <p class="para"><em class="emphasis">(array)</em> Collection point for configuration values.</p>
    119. 

  119. 

  120. <p class="para">Inherited from <a href="class.Solar_Base.Properties.html#class.Solar_Base.Properties._config" class="link">Solar_Base</a>.</p>
    121. 

  121. 

  122. <p class="para">Note that you do not define config defaults in $_config directly.</p>
    123. 

  123. 

  124. <pre class="programlisting"><code><span style="color: #000000"><span style="color: #0000BB">&lt;?php
    125. 

  125. </span><span style="color: #FF8000">// DO NOT DO THIS
    126. 

  126. </span><span style="color: #007700">protected </span><span style="color: #0000BB">$_config </span><span style="color: #007700">= array(
    127. 

  127.     </span><span style="color: #DD0000">'foo' </span><span style="color: #007700">=&gt; </span><span style="color: #DD0000">'bar'</span><span style="color: #007700">,
    128. 

  128.     </span><span style="color: #DD0000">'baz' </span><span style="color: #007700">=&gt; </span><span style="color: #DD0000">'dib'</span><span style="color: #007700">,
    129. 

  129. );</span></span></code></pre>
    130. 

  130. 

  131. 

  132. <p class="para">Instead, define config defaults in a protected property named for the
    133. 

  133. class, withan underscore prefix.</p>
    134. 

  134. 

  135. <p class="para">For exmple, a &quot;Vendor_Class_Name&quot; class would define the default 
    136. 

  136. config array in &quot;$_Vendor_Class_Name&quot;.  This convention lets 
    137. 

  137. child classes inherit parent config keys and values.</p>
    138. 

  138. 

  139. <pre class="programlisting"><code><span style="color: #000000"><span style="color: #0000BB">&lt;?php
    140. 

  140. </span><span style="color: #FF8000">// DO THIS INSTEAD
    141. 

  141. </span><span style="color: #007700">protected </span><span style="color: #0000BB">$_Vendor_Class_Name </span><span style="color: #007700">= array(
    142. 

  142.     </span><span style="color: #DD0000">'foo' </span><span style="color: #007700">=&gt; </span><span style="color: #DD0000">'bar'</span><span style="color: #007700">,
    143. 

  143.     </span><span style="color: #DD0000">'baz' </span><span style="color: #007700">=&gt; </span><span style="color: #DD0000">'dib'</span><span style="color: #007700">,
    144. 

  144. );</span></span></code></pre>
    145. 

  145. 

  146. 

  147. </div>
    148. 

  148. 

  149. <div id="class.Solar_Controller_Command.Properties._console">
    150. 

  150. <h3><code class="literal">$_console</code> </h3>
    151. 

  151. 

  152. <p class="para"><em class="emphasis">(Solar_Controller_Console)</em> The Solar_Controller_Console object (if any) that invoked this command.</p>
    153. 

  153. 

  154. </div>
    155. 

  155. 

  156. <div id="class.Solar_Controller_Command.Properties._getopt">
    157. 

  157. <h3><code class="literal">$_getopt</code> </h3>
    158. 

  158. 

  159. <p class="para"><em class="emphasis">(Solar_Getopt)</em> A Solar_Getopt object to manage options and parameters.</p>
    160. 

  160. 

  161. </div>
    162. 

  162. 

  163. <div id="class.Solar_Controller_Command.Properties._options">
    164. 

  164. <h3><code class="literal">$_options</code> </h3>
    165. 

  165. 

  166. <p class="para"><em class="emphasis">(array)</em> Option flags and values extracted from the command-line arguments.</p>
    167. 

  167. 

  168. </div>
    169. 

  169. 

  170. <div id="class.Solar_Controller_Command.Properties._stderr">
    171. 

  171. <h3><code class="literal">$_stderr</code> </h3>
    172. 

  172. 

  173. <p class="para"><em class="emphasis">(resource)</em> File handle pointing to STDERR for error output.</p>
    174. 

  174. 

  175. </div>
    176. 

  176. 

  177. <div id="class.Solar_Controller_Command.Properties._stdout">
    178. 

  178. <h3><code class="literal">$_stdout</code> </h3>
    179. 

  179. 

  180. <p class="para"><em class="emphasis">(resource)</em> File handle pointing to STDOUT for normal output.</p>
    181. 

  181. 

  182. </div>
    183. 

  183. 

  184. </div>
    185. 

  185. 

  186. <div>
    187. 

  187. <h2>Private</h2>
    188. 

  188. 

  189. <p class="para">None.</p>
    190. 

  190. 

  191. </div>
    192. 

  192.     
    193. 

  193. </div>
    194. 

  194.             <div class="navfooter">
    195. 

  195.                 <table width="100%" summary="Navigation footer">
    196. 

  196.                     <tr>
    197. 

  197.                         <td width="40%" align="left"><a accesskey="p" href="class.Solar_Controller_Command.Constants.html">Prev</a></td>
    198. 

  198.                         <td width="20%" align="center"><a accesskey="u" href="class.Solar_Controller_Command.html">Up</a></td>
    199. 

  199.                         <td width="40%" align="right"><a accesskey="n" href="class.Solar_Controller_Command.Methods.html">Next</a></td>
    200. 

  200.                     </tr>
    201. 

  201.                     <tr>
    202. 

  202.                         <td width="40%" align="left" valign="top">Constants</td>
    203. 

  203.                         <td width="20%" align="center"><a accesskey="h" href="apidoc.html">Home</a></td>
    204. 

  204.                         <td width="40%" align="right" valign="top">Methods</td>
    205. 

  205.                     </tr>
    206. 

  206.                 </table>
    207. 

  207.             </div>
    208. 

  208.         </td>
    209. 

  209.     </tr>
    210. 

  210. </table>
    211. 

  211. </body>
    212. 

  212. </html>
    213. 

  213.