| [ Index ] |
|
Code source de PRADO 3.0.6 |
1 <?xml version="1.0" encoding="iso-8859-1"?> 2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> 3 <html xmlns="http://www.w3.org/1999/xhtml"> 4 <head> 5 <!-- template designed by Marco Von Ballmoos --> 6 <title>Docs For Class TPropertyValue</title> 7 <link rel="stylesheet" href="../media/stylesheet.css" /> 8 <meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/> 9 </head> 10 <body> 11 <div class="page-body"> 12 <h2 class="class-name">Class TPropertyValue</h2> 13 14 <a name="sec-description"></a> 15 <div class="info-box"> 16 <div class="info-box-title">Description</div> 17 <div class="nav-bar"> 18 <span class="disabled">Description</span> | 19 <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>) 20 21 </div> 22 <div class="info-box-body"> 23 <!-- ========== Info from phpDoc block ========= --> 24 <p class="short-description">TPropertyValue class</p> 25 <p class="description"><p>TPropertyValue is a utility class that provides static methods to convert component property values to specific types.</p><p>TPropertyValue is commonly used in component setter methods to ensure the new property value is of specific type. For example, a boolean-typed property setter method would be as follows, <pre><ol><code><pre><li> <span class="src-key">function </span><span class="src-id">setPropertyName</span><span class="src-sym">(</span><span class="src-var">$value</span><span class="src-sym">) </span><span class="src-sym">{</span></li> 26 <li> <span class="src-var">$value</span>=<span class="src-id"><a href="../System/TPropertyValue.html">TPropertyValue</a></span><span class="src-sym">::</span><a href="../System/TPropertyValue.html#methodensureBoolean">ensureBoolean</a><span class="src-sym">(</span><span class="src-var">$value</span><span class="src-sym">)</span><span class="src-sym">;</span></li> 27 <li> <span class="src-comm">// $value is now of boolean type</span></li> 28 <li> <span class="src-sym">}</span></li> 29 </pre></code></ol></pre></p><p>Properties can be of the following types with specific type conversion rules: <ul><li>string: a boolean value will be converted to 'true' or 'false'.</li><li>boolean: string 'true' (case-insensitive) will be converted to true, 30 string 'false' (case-insensitive) will be converted to false.</li><li>integer</li><li>float</li><li>array: string starting with '(' and ending with ')' will be considered as 31 as an array expression and will be evaluated. Otherwise, an array 32 with the value to be ensured is returned.</li><li>object</li><li>enum: enumerable type, represented by an array of strings.</li></ul></p></p> 33 <ul class="tags"> 34 <li><span class="field">since:</span> 3.0</li> 35 <li><span class="field">version:</span> $Id: TComponent.php 1457 2006-10-06 03:44:07Z wei $</li> 36 <li><span class="field">author:</span> Qiang Xue <<a href="mailto:qiang.xue@gmail.com">qiang.xue@gmail.com</a>></li> 37 </ul> 38 <p class="notes"> 39 Located in <a class="field" href="_TComponent_php.html">/TComponent.php</a> (line <span class="field">505</span>) 40 </p> 41 42 43 <pre></pre> 44 45 </div> 46 </div> 47 48 49 50 51 <a name="sec-method-summary"></a> 52 <div class="info-box"> 53 <div class="info-box-title">Method Summary</span></div> 54 <div class="nav-bar"> 55 <a href="#sec-description">Description</a> | 56 <span class="disabled">Methods</span> (<a href="#sec-methods">details</a>) 57 </div> 58 <div class="info-box-body"> 59 <div class="method-summary"> 60 61 <div class="method-definition"> 62 <span class="method-result">array</span> 63 <a href="#ensureArray" title="details" class="method-name">ensureArray</a> 64 (<span class="var-type">mixed</span> <span class="var-name">$value</span>) 65 </div> 66 67 <div class="method-definition"> 68 <span class="method-result">boolean</span> 69 <a href="#ensureBoolean" title="details" class="method-name">ensureBoolean</a> 70 (<span class="var-type">mixed</span> <span class="var-name">$value</span>) 71 </div> 72 73 <div class="method-definition"> 74 <span class="method-result">string</span> 75 <a href="#ensureEnum" title="details" class="method-name">ensureEnum</a> 76 (<span class="var-type">mixed</span> <span class="var-name">$value</span>, <span class="var-type">mixed</span> <span class="var-name">$enums</span>) 77 </div> 78 79 <div class="method-definition"> 80 <span class="method-result">float</span> 81 <a href="#ensureFloat" title="details" class="method-name">ensureFloat</a> 82 (<span class="var-type">mixed</span> <span class="var-name">$value</span>) 83 </div> 84 85 <div class="method-definition"> 86 <span class="method-result">integer</span> 87 <a href="#ensureInteger" title="details" class="method-name">ensureInteger</a> 88 (<span class="var-type">mixed</span> <span class="var-name">$value</span>) 89 </div> 90 91 <div class="method-definition"> 92 <span class="method-result">object</span> 93 <a href="#ensureObject" title="details" class="method-name">ensureObject</a> 94 (<span class="var-type">mixed</span> <span class="var-name">$value</span>) 95 </div> 96 97 <div class="method-definition"> 98 <span class="method-result">string</span> 99 <a href="#ensureString" title="details" class="method-name">ensureString</a> 100 (<span class="var-type">mixed</span> <span class="var-name">$value</span>) 101 </div> 102 </div> 103 </div> 104 </div> 105 106 107 <a name="sec-methods"></a> 108 <div class="info-box"> 109 <div class="info-box-title">Methods</div> 110 <div class="nav-bar"> 111 <a href="#sec-description">Description</a> | 112 <a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>) 113 114 </div> 115 <div class="info-box-body"> 116 <A NAME='method_detail'></A> 117 <a name="methodensureArray" id="ensureArray"><!-- --></a> 118 <div class="evenrow"> 119 120 <div class="method-header"> 121 <span class="method-title">ensureArray</span> (line <span class="line-number">567</span>) 122 </div> 123 124 <!-- ========== Info from phpDoc block ========= --> 125 <p class="short-description">Converts a value to array type. If the value is a string and it is</p> 126 <p class="description"><p>in the form (a,b,c) then an array consisting of each of the elements will be returned. If the value is a string and it is not in this form then an array consisting of just the string will be returned. If the value is not a string then</p></p> 127 <ul class="tags"> 128 <li><span class="field">static:</span> </li> 129 <li><span class="field">access:</span> public</li> 130 </ul> 131 132 <div class="method-signature"> 133 <span class="method-result">array</span> 134 <span class="method-name"> 135 ensureArray 136 </span> 137 (<span class="var-type">mixed</span> <span class="var-name">$value</span>) 138 </div> 139 140 <ul class="parameters"> 141 <li> 142 <span class="var-type">mixed</span> 143 <span class="var-name">$value</span><span class="var-description">: the value to be converted.</span> </li> 144 </ul> 145 146 147 </div> 148 <a name="methodensureBoolean" id="ensureBoolean"><!-- --></a> 149 <div class="oddrow"> 150 151 <div class="method-header"> 152 <span class="method-title">ensureBoolean</span> (line <span class="line-number">515</span>) 153 </div> 154 155 <!-- ========== Info from phpDoc block ========= --> 156 <p class="short-description">Converts a value to boolean type.</p> 157 <p class="description"><p>Note, string 'true' (case-insensitive) will be converted to true, string 'false' (case-insensitive) will be converted to false. If a string represents a non-zero number, it will be treated as true.</p></p> 158 <ul class="tags"> 159 <li><span class="field">static:</span> </li> 160 <li><span class="field">access:</span> public</li> 161 </ul> 162 163 <div class="method-signature"> 164 <span class="method-result">boolean</span> 165 <span class="method-name"> 166 ensureBoolean 167 </span> 168 (<span class="var-type">mixed</span> <span class="var-name">$value</span>) 169 </div> 170 171 <ul class="parameters"> 172 <li> 173 <span class="var-type">mixed</span> 174 <span class="var-name">$value</span><span class="var-description">: the value to be converted.</span> </li> 175 </ul> 176 177 178 </div> 179 <a name="methodensureEnum" id="ensureEnum"><!-- --></a> 180 <div class="evenrow"> 181 182 <div class="method-header"> 183 <span class="method-title">ensureEnum</span> (line <span class="line-number">611</span>) 184 </div> 185 186 <!-- ========== Info from phpDoc block ========= --> 187 <p class="short-description">Converts a value to enum type.</p> 188 <p class="description"><p>This method checks if the value is of the specified enumerable type. A value is a valid enumerable value if it is equal to the name of a constant in the specified enumerable type (class). For more details about enumerable, see <a href="../System/TEnumerable.html">TEnumerable</a>.</p><p>For backward compatibility, this method also supports sanity check of a string value to see if it is among the given list of strings.</p></p> 189 <ul class="tags"> 190 <li><span class="field">return:</span> the valid enumeration value</li> 191 <li><span class="field">static:</span> </li> 192 <li><span class="field">access:</span> public</li> 193 <li><span class="field">throws:</span> TInvalidDataValueException if the original value is not in the string array.</li> 194 </ul> 195 196 <div class="method-signature"> 197 <span class="method-result">string</span> 198 <span class="method-name"> 199 ensureEnum 200 </span> 201 (<span class="var-type">mixed</span> <span class="var-name">$value</span>, <span class="var-type">mixed</span> <span class="var-name">$enums</span>) 202 </div> 203 204 <ul class="parameters"> 205 <li> 206 <span class="var-type">mixed</span> 207 <span class="var-name">$value</span><span class="var-description">: the value to be converted.</span> </li> 208 <li> 209 <span class="var-type">mixed</span> 210 <span class="var-name">$enums</span><span class="var-description">: class name of the enumerable type, or array of valid enumeration values. If this is not an array, the method considers its parameters are of variable length, and the second till the last parameters are enumeration values.</span> </li> 211 </ul> 212 213 214 </div> 215 <a name="methodensureFloat" id="ensureFloat"><!-- --></a> 216 <div class="oddrow"> 217 218 <div class="method-header"> 219 <span class="method-title">ensureFloat</span> (line <span class="line-number">553</span>) 220 </div> 221 222 <!-- ========== Info from phpDoc block ========= --> 223 <p class="short-description">Converts a value to float type.</p> 224 <ul class="tags"> 225 <li><span class="field">static:</span> </li> 226 <li><span class="field">access:</span> public</li> 227 </ul> 228 229 <div class="method-signature"> 230 <span class="method-result">float</span> 231 <span class="method-name"> 232 ensureFloat 233 </span> 234 (<span class="var-type">mixed</span> <span class="var-name">$value</span>) 235 </div> 236 237 <ul class="parameters"> 238 <li> 239 <span class="var-type">mixed</span> 240 <span class="var-name">$value</span><span class="var-description">: the value to be converted.</span> </li> 241 </ul> 242 243 244 </div> 245 <a name="methodensureInteger" id="ensureInteger"><!-- --></a> 246 <div class="evenrow"> 247 248 <div class="method-header"> 249 <span class="method-title">ensureInteger</span> (line <span class="line-number">543</span>) 250 </div> 251 252 <!-- ========== Info from phpDoc block ========= --> 253 <p class="short-description">Converts a value to integer type.</p> 254 <ul class="tags"> 255 <li><span class="field">static:</span> </li> 256 <li><span class="field">access:</span> public</li> 257 </ul> 258 259 <div class="method-signature"> 260 <span class="method-result">integer</span> 261 <span class="method-name"> 262 ensureInteger 263 </span> 264 (<span class="var-type">mixed</span> <span class="var-name">$value</span>) 265 </div> 266 267 <ul class="parameters"> 268 <li> 269 <span class="var-type">mixed</span> 270 <span class="var-name">$value</span><span class="var-description">: the value to be converted.</span> </li> 271 </ul> 272 273 274 </div> 275 <a name="methodensureObject" id="ensureObject"><!-- --></a> 276 <div class="oddrow"> 277 278 <div class="method-header"> 279 <span class="method-title">ensureObject</span> (line <span class="line-number">590</span>) 280 </div> 281 282 <!-- ========== Info from phpDoc block ========= --> 283 <p class="short-description">Converts a value to object type.</p> 284 <ul class="tags"> 285 <li><span class="field">static:</span> </li> 286 <li><span class="field">access:</span> public</li> 287 </ul> 288 289 <div class="method-signature"> 290 <span class="method-result">object</span> 291 <span class="method-name"> 292 ensureObject 293 </span> 294 (<span class="var-type">mixed</span> <span class="var-name">$value</span>) 295 </div> 296 297 <ul class="parameters"> 298 <li> 299 <span class="var-type">mixed</span> 300 <span class="var-name">$value</span><span class="var-description">: the value to be converted.</span> </li> 301 </ul> 302 303 304 </div> 305 <a name="methodensureString" id="ensureString"><!-- --></a> 306 <div class="evenrow"> 307 308 <div class="method-header"> 309 <span class="method-title">ensureString</span> (line <span class="line-number">530</span>) 310 </div> 311 312 <!-- ========== Info from phpDoc block ========= --> 313 <p class="short-description">Converts a value to string type.</p> 314 <p class="description"><p>Note, a boolean value will be converted to 'true' if it is true and 'false' if it is false.</p></p> 315 <ul class="tags"> 316 <li><span class="field">static:</span> </li> 317 <li><span class="field">access:</span> public</li> 318 </ul> 319 320 <div class="method-signature"> 321 <span class="method-result">string</span> 322 <span class="method-name"> 323 ensureString 324 </span> 325 (<span class="var-type">mixed</span> <span class="var-name">$value</span>) 326 </div> 327 328 <ul class="parameters"> 329 <li> 330 <span class="var-type">mixed</span> 331 <span class="var-name">$value</span><span class="var-description">: the value to be converted.</span> </li> 332 </ul> 333 334 335 </div> 336 337 </div> 338 </div> 339 340 341 <p class="notes" id="credit"> 342 Documentation generated on Mon, 04 Dec 2006 11:26:10 -0500 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.0RC4</a> 343 </p> 344 </div></body> 345 </html>
titre
Description
Corps
titre
Description
Corps
titre
Description
Corps
titre
Corps
| Généré le : Sun Feb 25 21:07:04 2007 | par Balluche grâce à PHPXref 0.7 |