PageRenderTime 66ms CodeModel.GetById 30ms RepoModel.GetById 0ms app.codeStats 0ms

/docs/api/CValidator.html

https://bitbucket.org/mscherbakov/idn
HTML | 778 lines | 704 code | 74 blank | 0 comment | 0 complexity | d9486b07884efea20523b64fe5ba89a7 MD5 | raw file
Possible License(s): LGPL-2.1 
    

  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
    2. 

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

  3. <head>
    4. 

  4. <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
    5. 

  5. <meta name="language" content="en" />
    6. 

  6. <link rel="stylesheet" type="text/css" href="css/style.css" />
    7. 

  7. <link rel="stylesheet" type="text/css" href="css/api.css" />
    8. 

  8. <script type="text/javascript" src="js/jquery.js"></script>
    9. 

  9. <title>CValidator</title>
    10. 

  10. </head>
    11. 

  11. 

  12. <body>
    13. 

  13. <div id="apiPage">
    14. 

  14. 

  15. <div id="apiHeader">
    16. 

  16. <a href="http://www.yiiframework.com">Yii Framework</a> v1.1.10 Class Reference
    17. 

  17. </div><!-- end of header -->
    18. 

  18. 

  19. <div id="content">
    20. 

  20. <h1>CValidator</h1>
    21. 

  21. <div id="nav">
    22. 

  22. <a href="index.html">All Packages</a>
    23. 

  23. | <a href="#properties">Properties</a>
    24. 

  24. | <a href="#methods">Methods</a>
    25. 

  25. </div>
    26. 

  26. 

  27. <table class="summaryTable docClass">
    28. 

  28. <colgroup>
    29. 

  29. 	<col class="col-name" />
    30. 

  30. 	<col class="col-value" />
    31. 

  31. </colgroup>
    32. 

  32. <tr>
    33. 

  33.   <th>Package</th>
    34. 

  34.   <td><a href="index.html#system.validators">system.validators</a></td>
    35. 

  35. </tr>
    36. 

  36. <tr>
    37. 

  37.   <th>Inheritance</th>
    38. 

  38.   <td>abstract class CValidator &raquo;
    39. 

  39. <a href="CComponent.html">CComponent</a></td>
    40. 

  40. </tr>
    41. 

  41. <tr>
    42. 

  42.   <th>Subclasses</th>
    43. 

  43.   <td><a href="CBooleanValidator.html">CBooleanValidator</a>, <a href="CCaptchaValidator.html">CCaptchaValidator</a>, <a href="CCompareValidator.html">CCompareValidator</a>, <a href="CDateValidator.html">CDateValidator</a>, <a href="CDefaultValueValidator.html">CDefaultValueValidator</a>, <a href="CEmailValidator.html">CEmailValidator</a>, <a href="CExistValidator.html">CExistValidator</a>, <a href="CFileValidator.html">CFileValidator</a>, <a href="CFilterValidator.html">CFilterValidator</a>, <a href="CInlineValidator.html">CInlineValidator</a>, <a href="CNumberValidator.html">CNumberValidator</a>, <a href="CRangeValidator.html">CRangeValidator</a>, <a href="CRegularExpressionValidator.html">CRegularExpressionValidator</a>, <a href="CRequiredValidator.html">CRequiredValidator</a>, <a href="CSafeValidator.html">CSafeValidator</a>, <a href="CStringValidator.html">CStringValidator</a>, <a href="CTypeValidator.html">CTypeValidator</a>, <a href="CUniqueValidator.html">CUniqueValidator</a>, <a href="CUnsafeValidator.html">CUnsafeValidator</a>, <a href="CUrlValidator.html">CUrlValidator</a></td>
    44. 

  44. </tr>
    45. 

  45. <tr>
    46. 

  46.   <th>Since</th>
    47. 

  47.   <td>1.0</td>
    48. 

  48. </tr>
    49. 

  49. <tr>
    50. 

  50.   <th>Version</th>
    51. 

  51.   <td>$Id: CValidator.php 3515 2011-12-28 12:29:24Z mdomba $</td>
    52. 

  52. </tr>
    53. 

  53. <tr>
    54. 

  54.   <th>Source Code</th>
    55. 

  55.   <td><a class="sourceLink" href="http://code.google.com/p/yii/source/browse/tags/1.1.10/framework/validators/CValidator.php">framework/validators/CValidator.php</a></td>
    56. 

  56. </tr>
    57. 

  57. </table>
    58. 

  58. 

  59. <div id="classDescription">
    60. 

  60. CValidator is the base class for all validators.
    61. 

  61. <br/><br/>
    62. 

  62. Child classes must implement the <a href="CValidator.html#validateAttribute">validateAttribute</a> method.
    63. 

  63. <br/><br/>
    64. 

  64. The following properties are defined in CValidator:
    65. 

  65. <ul>
    66. 

  66. <li><a href="CValidator.html#attributes">attributes</a>: array, list of attributes to be validated;</li>
    67. 

  67. <li><a href="CValidator.html#message">message</a>: string, the customized error message. The message
    68. 

  68.   may contain placeholders that will be replaced with the actual content.
    69. 

  69.   For example, the "{attribute}" placeholder will be replaced with the label
    70. 

  70.   of the problematic attribute. Different validators may define additional
    71. 

  71.   placeholders.</li>
    72. 

  72. <li><a href="CValidator.html#on">on</a>: string, in which scenario should the validator be in effect.
    73. 

  73.   This is used to match the 'on' parameter supplied when calling <a href="CModel.html#validate">CModel::validate</a>.</li>
    74. 

  74. </ul>
    75. 

  75. <br/><br/>
    76. 

  76. When using <a href="CValidator.html#createValidator">createValidator</a> to create a validator, the following aliases
    77. 

  77. are recognized as the corresponding built-in validator classes:
    78. 

  78. <ul>
    79. 

  79. <li>required: <a href="CRequiredValidator.html">CRequiredValidator</a></li>
    80. 

  80. <li>filter: <a href="CFilterValidator.html">CFilterValidator</a></li>
    81. 

  81. <li>match: <a href="CRegularExpressionValidator.html">CRegularExpressionValidator</a></li>
    82. 

  82. <li>email: <a href="CEmailValidator.html">CEmailValidator</a></li>
    83. 

  83. <li>url: <a href="CUrlValidator.html">CUrlValidator</a></li>
    84. 

  84. <li>unique: <a href="CUniqueValidator.html">CUniqueValidator</a></li>
    85. 

  85. <li>compare: <a href="CCompareValidator.html">CCompareValidator</a></li>
    86. 

  86. <li>length: <a href="CStringValidator.html">CStringValidator</a></li>
    87. 

  87. <li>in: <a href="CRangeValidator.html">CRangeValidator</a></li>
    88. 

  88. <li>numerical: <a href="CNumberValidator.html">CNumberValidator</a></li>
    89. 

  89. <li>captcha: <a href="CCaptchaValidator.html">CCaptchaValidator</a></li>
    90. 

  90. <li>type: <a href="CTypeValidator.html">CTypeValidator</a></li>
    91. 

  91. <li>file: <a href="CFileValidator.html">CFileValidator</a></li>
    92. 

  92. <li>default: <a href="CDefaultValueValidator.html">CDefaultValueValidator</a></li>
    93. 

  93. <li>exist: <a href="CExistValidator.html">CExistValidator</a></li>
    94. 

  94. <li>boolean: <a href="CBooleanValidator.html">CBooleanValidator</a></li>
    95. 

  95. <li>date: <a href="CDateValidator.html">CDateValidator</a></li>
    96. 

  96. <li>safe: <a href="CSafeValidator.html">CSafeValidator</a></li>
    97. 

  97. <li>unsafe: <a href="CUnsafeValidator.html">CUnsafeValidator</a></li>
    98. 

  98. </ul></div>
    99. 

  99. <a name="properties"></a>
    100. 

  100. 

  101. <div class="summary docProperty">
    102. 

  102. <h2>Public Properties</h2>
    103. 

  103. 

  104. <p><a href="#" class="toggle">Hide inherited properties</a></p>
    105. 

  105. 

  106. <table class="summaryTable">
    107. 

  107. <colgroup>
    108. 

  108. 	<col class="col-property" />
    109. 

  109. 	<col class="col-type" />
    110. 

  110. 	<col class="col-description" />
    111. 

  111. 	<col class="col-defined" />
    112. 

  112. </colgroup>
    113. 

  113. <tr>
    114. 

  114.   <th>Property</th><th>Type</th><th>Description</th><th>Defined By</th>
    115. 

  115. </tr>
    116. 

  116. <tr id="attributes">
    117. 

  117.   <td><a href="CValidator.html#attributes-detail">attributes</a></td>
    118. 

  118.   <td>array</td>
    119. 

  119.   <td>list of attributes to be validated.</td>
    120. 

  120.   <td>CValidator</td>
    121. 

  121. </tr>
    122. 

  122. <tr id="builtInValidators">
    123. 

  123.   <td><a href="CValidator.html#builtInValidators-detail">builtInValidators</a></td>
    124. 

  124.   <td>array</td>
    125. 

  125.   <td>list of built-in validators (name=>class)</td>
    126. 

  126.   <td>CValidator</td>
    127. 

  127. </tr>
    128. 

  128. <tr id="enableClientValidation">
    129. 

  129.   <td><a href="CValidator.html#enableClientValidation-detail">enableClientValidation</a></td>
    130. 

  130.   <td>boolean</td>
    131. 

  131.   <td>whether to perform client-side validation.</td>
    132. 

  132.   <td>CValidator</td>
    133. 

  133. </tr>
    134. 

  134. <tr id="message">
    135. 

  135.   <td><a href="CValidator.html#message-detail">message</a></td>
    136. 

  136.   <td>string</td>
    137. 

  137.   <td>the user-defined error message.</td>
    138. 

  138.   <td>CValidator</td>
    139. 

  139. </tr>
    140. 

  140. <tr id="on">
    141. 

  141.   <td><a href="CValidator.html#on-detail">on</a></td>
    142. 

  142.   <td>array</td>
    143. 

  143.   <td>list of scenarios that the validator should be applied.</td>
    144. 

  144.   <td>CValidator</td>
    145. 

  145. </tr>
    146. 

  146. <tr id="safe">
    147. 

  147.   <td><a href="CValidator.html#safe-detail">safe</a></td>
    148. 

  148.   <td>boolean</td>
    149. 

  149.   <td>whether attributes listed with this validator should be considered safe for massive assignment.</td>
    150. 

  150.   <td>CValidator</td>
    151. 

  151. </tr>
    152. 

  152. <tr id="skipOnError">
    153. 

  153.   <td><a href="CValidator.html#skipOnError-detail">skipOnError</a></td>
    154. 

  154.   <td>boolean</td>
    155. 

  155.   <td>whether this validation rule should be skipped when there is already a validation
    156. 

  156. error for the current attribute.</td>
    157. 

  157.   <td>CValidator</td>
    158. 

  158. </tr>
    159. 

  159. </table>
    160. 

  160. </div>
    161. 

  161. <a name="methods"></a>
    162. 

  162. 

  163. <div class="summary docMethod">
    164. 

  164. <h2>Public Methods</h2>
    165. 

  165. 

  166. <p><a href="#" class="toggle">Hide inherited methods</a></p>
    167. 

  167. 

  168. <table class="summaryTable">
    169. 

  169. <colgroup>
    170. 

  170. 	<col class="col-method" />
    171. 

  171. 	<col class="col-description" />
    172. 

  172. 	<col class="col-defined" />
    173. 

  173. </colgroup>
    174. 

  174. <tr>
    175. 

  175.   <th>Method</th><th>Description</th><th>Defined By</th>
    176. 

  176. </tr>
    177. 

  177. <tr class="inherited" id="__call">
    178. 

  178.   <td><a href="CComponent.html#__call-detail">__call()</a></td>
    179. 

  179.   <td>Calls the named method which is not a class method.</td>
    180. 

  180.   <td><a href="CComponent.html">CComponent</a></td>
    181. 

  181. </tr>
    182. 

  182. <tr class="inherited" id="__get">
    183. 

  183.   <td><a href="CComponent.html#__get-detail">__get()</a></td>
    184. 

  184.   <td>Returns a property value, an event handler list or a behavior based on its name.</td>
    185. 

  185.   <td><a href="CComponent.html">CComponent</a></td>
    186. 

  186. </tr>
    187. 

  187. <tr class="inherited" id="__isset">
    188. 

  188.   <td><a href="CComponent.html#__isset-detail">__isset()</a></td>
    189. 

  189.   <td>Checks if a property value is null.</td>
    190. 

  190.   <td><a href="CComponent.html">CComponent</a></td>
    191. 

  191. </tr>
    192. 

  192. <tr class="inherited" id="__set">
    193. 

  193.   <td><a href="CComponent.html#__set-detail">__set()</a></td>
    194. 

  194.   <td>Sets value of a component property.</td>
    195. 

  195.   <td><a href="CComponent.html">CComponent</a></td>
    196. 

  196. </tr>
    197. 

  197. <tr class="inherited" id="__unset">
    198. 

  198.   <td><a href="CComponent.html#__unset-detail">__unset()</a></td>
    199. 

  199.   <td>Sets a component property to be null.</td>
    200. 

  200.   <td><a href="CComponent.html">CComponent</a></td>
    201. 

  201. </tr>
    202. 

  202. <tr id="applyTo">
    203. 

  203.   <td><a href="CValidator.html#applyTo-detail">applyTo()</a></td>
    204. 

  204.   <td>Returns a value indicating whether the validator applies to the specified scenario.</td>
    205. 

  205.   <td>CValidator</td>
    206. 

  206. </tr>
    207. 

  207. <tr class="inherited" id="asa">
    208. 

  208.   <td><a href="CComponent.html#asa-detail">asa()</a></td>
    209. 

  209.   <td>Returns the named behavior object.</td>
    210. 

  210.   <td><a href="CComponent.html">CComponent</a></td>
    211. 

  211. </tr>
    212. 

  212. <tr class="inherited" id="attachBehavior">
    213. 

  213.   <td><a href="CComponent.html#attachBehavior-detail">attachBehavior()</a></td>
    214. 

  214.   <td>Attaches a behavior to this component.</td>
    215. 

  215.   <td><a href="CComponent.html">CComponent</a></td>
    216. 

  216. </tr>
    217. 

  217. <tr class="inherited" id="attachBehaviors">
    218. 

  218.   <td><a href="CComponent.html#attachBehaviors-detail">attachBehaviors()</a></td>
    219. 

  219.   <td>Attaches a list of behaviors to the component.</td>
    220. 

  220.   <td><a href="CComponent.html">CComponent</a></td>
    221. 

  221. </tr>
    222. 

  222. <tr class="inherited" id="attachEventHandler">
    223. 

  223.   <td><a href="CComponent.html#attachEventHandler-detail">attachEventHandler()</a></td>
    224. 

  224.   <td>Attaches an event handler to an event.</td>
    225. 

  225.   <td><a href="CComponent.html">CComponent</a></td>
    226. 

  226. </tr>
    227. 

  227. <tr class="inherited" id="canGetProperty">
    228. 

  228.   <td><a href="CComponent.html#canGetProperty-detail">canGetProperty()</a></td>
    229. 

  229.   <td>Determines whether a property can be read.</td>
    230. 

  230.   <td><a href="CComponent.html">CComponent</a></td>
    231. 

  231. </tr>
    232. 

  232. <tr class="inherited" id="canSetProperty">
    233. 

  233.   <td><a href="CComponent.html#canSetProperty-detail">canSetProperty()</a></td>
    234. 

  234.   <td>Determines whether a property can be set.</td>
    235. 

  235.   <td><a href="CComponent.html">CComponent</a></td>
    236. 

  236. </tr>
    237. 

  237. <tr id="clientValidateAttribute">
    238. 

  238.   <td><a href="CValidator.html#clientValidateAttribute-detail">clientValidateAttribute()</a></td>
    239. 

  239.   <td>Returns the JavaScript needed for performing client-side validation.</td>
    240. 

  240.   <td>CValidator</td>
    241. 

  241. </tr>
    242. 

  242. <tr id="createValidator">
    243. 

  243.   <td><a href="CValidator.html#createValidator-detail">createValidator()</a></td>
    244. 

  244.   <td>Creates a validator object.</td>
    245. 

  245.   <td>CValidator</td>
    246. 

  246. </tr>
    247. 

  247. <tr class="inherited" id="detachBehavior">
    248. 

  248.   <td><a href="CComponent.html#detachBehavior-detail">detachBehavior()</a></td>
    249. 

  249.   <td>Detaches a behavior from the component.</td>
    250. 

  250.   <td><a href="CComponent.html">CComponent</a></td>
    251. 

  251. </tr>
    252. 

  252. <tr class="inherited" id="detachBehaviors">
    253. 

  253.   <td><a href="CComponent.html#detachBehaviors-detail">detachBehaviors()</a></td>
    254. 

  254.   <td>Detaches all behaviors from the component.</td>
    255. 

  255.   <td><a href="CComponent.html">CComponent</a></td>
    256. 

  256. </tr>
    257. 

  257. <tr class="inherited" id="detachEventHandler">
    258. 

  258.   <td><a href="CComponent.html#detachEventHandler-detail">detachEventHandler()</a></td>
    259. 

  259.   <td>Detaches an existing event handler.</td>
    260. 

  260.   <td><a href="CComponent.html">CComponent</a></td>
    261. 

  261. </tr>
    262. 

  262. <tr class="inherited" id="disableBehavior">
    263. 

  263.   <td><a href="CComponent.html#disableBehavior-detail">disableBehavior()</a></td>
    264. 

  264.   <td>Disables an attached behavior.</td>
    265. 

  265.   <td><a href="CComponent.html">CComponent</a></td>
    266. 

  266. </tr>
    267. 

  267. <tr class="inherited" id="disableBehaviors">
    268. 

  268.   <td><a href="CComponent.html#disableBehaviors-detail">disableBehaviors()</a></td>
    269. 

  269.   <td>Disables all behaviors attached to this component.</td>
    270. 

  270.   <td><a href="CComponent.html">CComponent</a></td>
    271. 

  271. </tr>
    272. 

  272. <tr class="inherited" id="enableBehavior">
    273. 

  273.   <td><a href="CComponent.html#enableBehavior-detail">enableBehavior()</a></td>
    274. 

  274.   <td>Enables an attached behavior.</td>
    275. 

  275.   <td><a href="CComponent.html">CComponent</a></td>
    276. 

  276. </tr>
    277. 

  277. <tr class="inherited" id="enableBehaviors">
    278. 

  278.   <td><a href="CComponent.html#enableBehaviors-detail">enableBehaviors()</a></td>
    279. 

  279.   <td>Enables all behaviors attached to this component.</td>
    280. 

  280.   <td><a href="CComponent.html">CComponent</a></td>
    281. 

  281. </tr>
    282. 

  282. <tr class="inherited" id="evaluateExpression">
    283. 

  283.   <td><a href="CComponent.html#evaluateExpression-detail">evaluateExpression()</a></td>
    284. 

  284.   <td>Evaluates a PHP expression or callback under the context of this component.</td>
    285. 

  285.   <td><a href="CComponent.html">CComponent</a></td>
    286. 

  286. </tr>
    287. 

  287. <tr class="inherited" id="getEventHandlers">
    288. 

  288.   <td><a href="CComponent.html#getEventHandlers-detail">getEventHandlers()</a></td>
    289. 

  289.   <td>Returns the list of attached event handlers for an event.</td>
    290. 

  290.   <td><a href="CComponent.html">CComponent</a></td>
    291. 

  291. </tr>
    292. 

  292. <tr class="inherited" id="hasEvent">
    293. 

  293.   <td><a href="CComponent.html#hasEvent-detail">hasEvent()</a></td>
    294. 

  294.   <td>Determines whether an event is defined.</td>
    295. 

  295.   <td><a href="CComponent.html">CComponent</a></td>
    296. 

  296. </tr>
    297. 

  297. <tr class="inherited" id="hasEventHandler">
    298. 

  298.   <td><a href="CComponent.html#hasEventHandler-detail">hasEventHandler()</a></td>
    299. 

  299.   <td>Checks whether the named event has attached handlers.</td>
    300. 

  300.   <td><a href="CComponent.html">CComponent</a></td>
    301. 

  301. </tr>
    302. 

  302. <tr class="inherited" id="hasProperty">
    303. 

  303.   <td><a href="CComponent.html#hasProperty-detail">hasProperty()</a></td>
    304. 

  304.   <td>Determines whether a property is defined.</td>
    305. 

  305.   <td><a href="CComponent.html">CComponent</a></td>
    306. 

  306. </tr>
    307. 

  307. <tr class="inherited" id="raiseEvent">
    308. 

  308.   <td><a href="CComponent.html#raiseEvent-detail">raiseEvent()</a></td>
    309. 

  309.   <td>Raises an event.</td>
    310. 

  310.   <td><a href="CComponent.html">CComponent</a></td>
    311. 

  311. </tr>
    312. 

  312. <tr id="validate">
    313. 

  313.   <td><a href="CValidator.html#validate-detail">validate()</a></td>
    314. 

  314.   <td>Validates the specified object.</td>
    315. 

  315.   <td>CValidator</td>
    316. 

  316. </tr>
    317. 

  317. </table>
    318. 

  318. </div>
    319. 

  319. <div class="summary docMethod">
    320. 

  320. <h2>Protected Methods</h2>
    321. 

  321. 

  322. <p><a href="#" class="toggle">Hide inherited methods</a></p>
    323. 

  323. 

  324. <table class="summaryTable">
    325. 

  325. <colgroup>
    326. 

  326. 	<col class="col-method" />
    327. 

  327. 	<col class="col-description" />
    328. 

  328. 	<col class="col-defined" />
    329. 

  329. </colgroup>
    330. 

  330. <tr>
    331. 

  331.   <th>Method</th><th>Description</th><th>Defined By</th>
    332. 

  332. </tr>
    333. 

  333. <tr id="addError">
    334. 

  334.   <td><a href="CValidator.html#addError-detail">addError()</a></td>
    335. 

  335.   <td>Adds an error about the specified attribute to the active record.</td>
    336. 

  336.   <td>CValidator</td>
    337. 

  337. </tr>
    338. 

  338. <tr id="isEmpty">
    339. 

  339.   <td><a href="CValidator.html#isEmpty-detail">isEmpty()</a></td>
    340. 

  340.   <td>Checks if the given value is empty.</td>
    341. 

  341.   <td>CValidator</td>
    342. 

  342. </tr>
    343. 

  343. <tr id="validateAttribute">
    344. 

  344.   <td><a href="CValidator.html#validateAttribute-detail">validateAttribute()</a></td>
    345. 

  345.   <td>Validates a single attribute.</td>
    346. 

  346.   <td>CValidator</td>
    347. 

  347. </tr>
    348. 

  348. </table>
    349. 

  349. </div>
    350. 

  350. <a name="events"></a>
    351. 

  351. 

  352. <h2>Property Details</h2>
    353. 

  353. <div class="detailHeader" id="attributes-detail">
    354. 

  354. attributes<span class="detailHeaderTag">
    355. 

  355. property
    356. 

  356. </span>
    357. 

  357. </div>
    358. 

  358. 

  359. <div class="signature">
    360. 

  360. public array <b>$attributes</b>;</div>
    361. 

  361. 

  362. <p>list of attributes to be validated.</p>
    363. 

  363. 

  364. 

  365. <div class="detailHeader" id="builtInValidators-detail">
    366. 

  366. builtInValidators<span class="detailHeaderTag">
    367. 

  367. property
    368. 

  368. </span>
    369. 

  369. </div>
    370. 

  370. 

  371. <div class="signature">
    372. 

  372. public static array <b>$builtInValidators</b>;</div>
    373. 

  373. 

  374. <p>list of built-in validators (name=>class)</p>
    375. 

  375. 

  376. 

  377. <div class="detailHeader" id="enableClientValidation-detail">
    378. 

  378. enableClientValidation<span class="detailHeaderTag">
    379. 

  379. property
    380. 

  380.  (available since v1.1.7)
    381. 

  381. </span>
    382. 

  382. </div>
    383. 

  383. 

  384. <div class="signature">
    385. 

  385. public boolean <b>$enableClientValidation</b>;</div>
    386. 

  386. 

  387. <p>whether to perform client-side validation. Defaults to true.
    388. 

  388. Please refer to <a href="CActiveForm.html#enableClientValidation">CActiveForm::enableClientValidation</a> for more details about client-side validation.</p>
    389. 

  389. 

  390. 

  391. <div class="detailHeader" id="message-detail">
    392. 

  392. message<span class="detailHeaderTag">
    393. 

  393. property
    394. 

  394. </span>
    395. 

  395. </div>
    396. 

  396. 

  397. <div class="signature">
    398. 

  398. public string <b>$message</b>;</div>
    399. 

  399. 

  400. <p>the user-defined error message. Different validators may define various
    401. 

  401. placeholders in the message that are to be replaced with actual values. All validators
    402. 

  402. recognize "{attribute}" placeholder, which will be replaced with the label of the attribute.</p>
    403. 

  403. 

  404. 

  405. <div class="detailHeader" id="on-detail">
    406. 

  406. on<span class="detailHeaderTag">
    407. 

  407. property
    408. 

  408. </span>
    409. 

  409. </div>
    410. 

  410. 

  411. <div class="signature">
    412. 

  412. public array <b>$on</b>;</div>
    413. 

  413. 

  414. <p>list of scenarios that the validator should be applied.
    415. 

  415. Each array value refers to a scenario name with the same name as its array key.</p>
    416. 

  416. 

  417. 

  418. <div class="detailHeader" id="safe-detail">
    419. 

  419. safe<span class="detailHeaderTag">
    420. 

  420. property
    421. 

  421.  (available since v1.1.4)
    422. 

  422. </span>
    423. 

  423. </div>
    424. 

  424. 

  425. <div class="signature">
    426. 

  426. public boolean <b>$safe</b>;</div>
    427. 

  427. 

  428. <p>whether attributes listed with this validator should be considered safe for massive assignment.
    429. 

  429. Defaults to true.</p>
    430. 

  430. 

  431. 

  432. <div class="detailHeader" id="skipOnError-detail">
    433. 

  433. skipOnError<span class="detailHeaderTag">
    434. 

  434. property
    435. 

  435.  (available since v1.1.1)
    436. 

  436. </span>
    437. 

  437. </div>
    438. 

  438. 

  439. <div class="signature">
    440. 

  440. public boolean <b>$skipOnError</b>;</div>
    441. 

  441. 

  442. <p>whether this validation rule should be skipped when there is already a validation
    443. 

  443. error for the current attribute. Defaults to false.</p>
    444. 

  444. 

  445. 

  446. <h2>Method Details</h2>
    447. 

  447. 

  448. <div class="detailHeader" id="addError-detail">
    449. 

  449. addError()
    450. 

  450. <span class="detailHeaderTag">
    451. 

  451. method
    452. 

  452. </span>
    453. 

  453. </div>
    454. 

  454. 

  455. <table class="summaryTable">
    456. 

  456. <tr><td colspan="3">
    457. 

  457. <div class="signature2">
    458. 

  458. protected void <b>addError</b>(<a href="CModel.html">CModel</a> $object, string $attribute, string $message, array $params=array (
    459. 

  459. ))</div>
    460. 

  460. </td></tr>
    461. 

  461. <tr>
    462. 

  462.   <td class="paramNameCol">$object</td>
    463. 

  463.   <td class="paramTypeCol"><a href="CModel.html">CModel</a></td>
    464. 

  464.   <td class="paramDescCol">the data object being validated</td>
    465. 

  465. </tr>
    466. 

  466. <tr>
    467. 

  467.   <td class="paramNameCol">$attribute</td>
    468. 

  468.   <td class="paramTypeCol">string</td>
    469. 

  469.   <td class="paramDescCol">the attribute being validated</td>
    470. 

  470. </tr>
    471. 

  471. <tr>
    472. 

  472.   <td class="paramNameCol">$message</td>
    473. 

  473.   <td class="paramTypeCol">string</td>
    474. 

  474.   <td class="paramDescCol">the error message</td>
    475. 

  475. </tr>
    476. 

  476. <tr>
    477. 

  477.   <td class="paramNameCol">$params</td>
    478. 

  478.   <td class="paramTypeCol">array</td>
    479. 

  479.   <td class="paramDescCol">values for the placeholders in the error message</td>
    480. 

  480. </tr>
    481. 

  481. </table>
    482. 

  482. 

  483. <div class="sourceCode">
    484. 

  484. <b>Source Code:</b> <a class="sourceLink" href="http://code.google.com/p/yii/source/browse/tags/1.1.10/framework/validators/CValidator.php#242">framework/validators/CValidator.php#242</a> (<b><a href="#" class="show">show</a></b>)
    485. 

  485. <div class="code"><code><span style="color: #000000">
    486. 

  486. <span style="color: #0000BB"></span><span style="color: #007700">protected&nbsp;function&nbsp;</span><span style="color: #0000BB">addError</span><span style="color: #007700">(</span><span style="color: #0000BB">$object</span><span style="color: #007700">,</span><span style="color: #0000BB">$attribute</span><span style="color: #007700">,</span><span style="color: #0000BB">$message</span><span style="color: #007700">,</span><span style="color: #0000BB">$params</span><span style="color: #007700">=array())<br />{<br />&nbsp;&nbsp;&nbsp;&nbsp;</span><span style="color: #0000BB">$params</span><span style="color: #007700">[</span><span style="color: #DD0000">'{attribute}'</span><span style="color: #007700">]=</span><span style="color: #0000BB">$object</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">getAttributeLabel</span><span style="color: #007700">(</span><span style="color: #0000BB">$attribute</span><span style="color: #007700">);<br />&nbsp;&nbsp;&nbsp;&nbsp;</span><span style="color: #0000BB">$object</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">addError</span><span style="color: #007700">(</span><span style="color: #0000BB">$attribute</span><span style="color: #007700">,</span><span style="color: #0000BB">strtr</span><span style="color: #007700">(</span><span style="color: #0000BB">$message</span><span style="color: #007700">,</span><span style="color: #0000BB">$params</span><span style="color: #007700">));<br />}</span>
    487. 

  487. </span>
    488. 

  488. </code></div>
    489. 

  489. </div>
    490. 

  490. <p>Adds an error about the specified attribute to the active record.
    491. 

  491. This is a helper method that performs message selection and internationalization.</p>
    492. 

  492. 

  493. 

  494. <div class="detailHeader" id="applyTo-detail">
    495. 

  495. applyTo()
    496. 

  496. <span class="detailHeaderTag">
    497. 

  497. method
    498. 

  498. </span>
    499. 

  499. </div>
    500. 

  500. 

  501. <table class="summaryTable">
    502. 

  502. <tr><td colspan="3">
    503. 

  503. <div class="signature2">
    504. 

  504. public boolean <b>applyTo</b>(string $scenario)</div>
    505. 

  505. </td></tr>
    506. 

  506. <tr>
    507. 

  507.   <td class="paramNameCol">$scenario</td>
    508. 

  508.   <td class="paramTypeCol">string</td>
    509. 

  509.   <td class="paramDescCol">scenario name</td>
    510. 

  510. </tr>
    511. 

  511. <tr>
    512. 

  512.   <td class="paramNameCol">{return}</td>
    513. 

  513.   <td class="paramTypeCol">boolean</td>
    514. 

  514.   <td class="paramDescCol">whether the validator applies to the specified scenario.</td>
    515. 

  515. </tr>
    516. 

  516. </table>
    517. 

  517. 

  518. <div class="sourceCode">
    519. 

  519. <b>Source Code:</b> <a class="sourceLink" href="http://code.google.com/p/yii/source/browse/tags/1.1.10/framework/validators/CValidator.php#229">framework/validators/CValidator.php#229</a> (<b><a href="#" class="show">show</a></b>)
    520. 

  520. <div class="code"><code><span style="color: #000000">
    521. 

  521. <span style="color: #0000BB"></span><span style="color: #007700">public&nbsp;function&nbsp;</span><span style="color: #0000BB">applyTo</span><span style="color: #007700">(</span><span style="color: #0000BB">$scenario</span><span style="color: #007700">)<br />{<br />&nbsp;&nbsp;&nbsp;&nbsp;return&nbsp;empty(</span><span style="color: #0000BB">$this</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">on</span><span style="color: #007700">)&nbsp;||&nbsp;isset(</span><span style="color: #0000BB">$this</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">on</span><span style="color: #007700">[</span><span style="color: #0000BB">$scenario</span><span style="color: #007700">]);<br />}</span>
    522. 

  522. </span>
    523. 

  523. </code></div>
    524. 

  524. </div>
    525. 

  525. <p>Returns a value indicating whether the validator applies to the specified scenario.
    526. 

  526. A validator applies to a scenario as long as any of the following conditions is met:
    527. 

  527. <ul>
    528. 

  528. <li>the validator's "on" property is empty</li>
    529. 

  529. <li>the validator's "on" property contains the specified scenario</li>
    530. 

  530. </ul></p>
    531. 

  531. 

  532. 

  533. <div class="detailHeader" id="clientValidateAttribute-detail">
    534. 

  534. clientValidateAttribute()
    535. 

  535. <span class="detailHeaderTag">
    536. 

  536. method
    537. 

  537. (available since v1.1.7)
    538. 

  538. </span>
    539. 

  539. </div>
    540. 

  540. 

  541. <table class="summaryTable">
    542. 

  542. <tr><td colspan="3">
    543. 

  543. <div class="signature2">
    544. 

  544. public string <b>clientValidateAttribute</b>(<a href="CModel.html">CModel</a> $object, string $attribute)</div>
    545. 

  545. </td></tr>
    546. 

  546. <tr>
    547. 

  547.   <td class="paramNameCol">$object</td>
    548. 

  548.   <td class="paramTypeCol"><a href="CModel.html">CModel</a></td>
    549. 

  549.   <td class="paramDescCol">the data object being validated</td>
    550. 

  550. </tr>
    551. 

  551. <tr>
    552. 

  552.   <td class="paramNameCol">$attribute</td>
    553. 

  553.   <td class="paramTypeCol">string</td>
    554. 

  554.   <td class="paramDescCol">the name of the attribute to be validated.</td>
    555. 

  555. </tr>
    556. 

  556. <tr>
    557. 

  557.   <td class="paramNameCol">{return}</td>
    558. 

  558.   <td class="paramTypeCol">string</td>
    559. 

  559.   <td class="paramDescCol">the client-side validation script. Null if the validator does not support client-side validation.</td>
    560. 

  560. </tr>
    561. 

  561. </table>
    562. 

  562. 

  563. <div class="sourceCode">
    564. 

  564. <b>Source Code:</b> <a class="sourceLink" href="http://code.google.com/p/yii/source/browse/tags/1.1.10/framework/validators/CValidator.php#215">framework/validators/CValidator.php#215</a> (<b><a href="#" class="show">show</a></b>)
    565. 

  565. <div class="code"><code><span style="color: #000000">
    566. 

  566. <span style="color: #0000BB"></span><span style="color: #007700">public&nbsp;function&nbsp;</span><span style="color: #0000BB">clientValidateAttribute</span><span style="color: #007700">(</span><span style="color: #0000BB">$object</span><span style="color: #007700">,</span><span style="color: #0000BB">$attribute</span><span style="color: #007700">)<br />{<br />}</span>
    567. 

  567. </span>
    568. 

  568. </code></div>
    569. 

  569. </div>
    570. 

  570. <p>Returns the JavaScript needed for performing client-side validation.
    571. 

  571. Do not override this method if the validator does not support client-side validation.
    572. 

  572. Two predefined JavaScript variables can be used:
    573. 

  573. <ul>
    574. 

  574. <li>value: the value to be validated</li>
    575. 

  575. <li>messages: an array used to hold the validation error messages for the value</li>
    576. 

  576. </ul></p>
    577. 

  577. 

  578. <div class="SeeAlso">
    579. 

  579. <h4>See Also</h4>
    580. 

  580. <ul>
    581. 

  581. 	<li><a href="CActiveForm.html#enableClientValidation">CActiveForm::enableClientValidation</a></li>
    582. 

  582. </ul>
    583. 

  583. </div>
    584. 

  584. 

  585. <div class="detailHeader" id="createValidator-detail">
    586. 

  586. createValidator()
    587. 

  587. <span class="detailHeaderTag">
    588. 

  588. method
    589. 

  589. </span>
    590. 

  590. </div>
    591. 

  591. 

  592. <table class="summaryTable">
    593. 

  593. <tr><td colspan="3">
    594. 

  594. <div class="signature2">
    595. 

  595. public static CValidator <b>createValidator</b>(string $name, <a href="CModel.html">CModel</a> $object, mixed $attributes, array $params=array (
    596. 

  596. ))</div>
    597. 

  597. </td></tr>
    598. 

  598. <tr>
    599. 

  599.   <td class="paramNameCol">$name</td>
    600. 

  600.   <td class="paramTypeCol">string</td>
    601. 

  601.   <td class="paramDescCol">the name or class of the validator</td>
    602. 

  602. </tr>
    603. 

  603. <tr>
    604. 

  604.   <td class="paramNameCol">$object</td>
    605. 

  605.   <td class="paramTypeCol"><a href="CModel.html">CModel</a></td>
    606. 

  606.   <td class="paramDescCol">the data object being validated that may contain the inline validation method</td>
    607. 

  607. </tr>
    608. 

  608. <tr>
    609. 

  609.   <td class="paramNameCol">$attributes</td>
    610. 

  610.   <td class="paramTypeCol">mixed</td>
    611. 

  611.   <td class="paramDescCol">list of attributes to be validated. This can be either an array of
    612. 

  612. the attribute names or a string of comma-separated attribute names.</td>
    613. 

  613. </tr>
    614. 

  614. <tr>
    615. 

  615.   <td class="paramNameCol">$params</td>
    616. 

  616.   <td class="paramTypeCol">array</td>
    617. 

  617.   <td class="paramDescCol">initial values to be applied to the validator properties</td>
    618. 

  618. </tr>
    619. 

  619. <tr>
    620. 

  620.   <td class="paramNameCol">{return}</td>
    621. 

  621.   <td class="paramTypeCol">CValidator</td>
    622. 

  622.   <td class="paramDescCol">the validator</td>
    623. 

  623. </tr>
    624. 

  624. </table>
    625. 

  625. 

  626. <div class="sourceCode">
    627. 

  627. <b>Source Code:</b> <a class="sourceLink" href="http://code.google.com/p/yii/source/browse/tags/1.1.10/framework/validators/CValidator.php#136">framework/validators/CValidator.php#136</a> (<b><a href="#" class="show">show</a></b>)
    628. 

  628. <div class="code"><code><span style="color: #000000">
    629. 

  629. <span style="color: #0000BB"></span><span style="color: #007700">public&nbsp;static&nbsp;function&nbsp;</span><span style="color: #0000BB">createValidator</span><span style="color: #007700">(</span><span style="color: #0000BB">$name</span><span style="color: #007700">,</span><span style="color: #0000BB">$object</span><span style="color: #007700">,</span><span style="color: #0000BB">$attributes</span><span style="color: #007700">,</span><span style="color: #0000BB">$params</span><span style="color: #007700">=array())<br />{<br />&nbsp;&nbsp;&nbsp;&nbsp;if(</span><span style="color: #0000BB">is_string</span><span style="color: #007700">(</span><span style="color: #0000BB">$attributes</span><span style="color: #007700">))<br />&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</span><span style="color: #0000BB">$attributes</span><span style="color: #007700">=</span><span style="color: #0000BB">preg_split</span><span style="color: #007700">(</span><span style="color: #DD0000">'/[\s,]+/'</span><span style="color: #007700">,</span><span style="color: #0000BB">$attributes</span><span style="color: #007700">,-</span><span style="color: #0000BB">1</span><span style="color: #007700">,</span><span style="color: #0000BB">PREG_SPLIT_NO_EMPTY</span><span style="color: #007700">);<br /><br />&nbsp;&nbsp;&nbsp;&nbsp;if(isset(</span><span style="color: #0000BB">$params</span><span style="color: #007700">[</span><span style="color: #DD0000">'on'</span><span style="color: #007700">]))<br />&nbsp;&nbsp;&nbsp;&nbsp;{<br />&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;if(</span><span style="color: #0000BB">is_array</span><span style="color: #007700">(</span><span style="color: #0000BB">$params</span><span style="color: #007700">[</span><span style="color: #DD0000">'on'</span><span style="color: #007700">]))<br />&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</span><span style="color: #0000BB">$on</span><span style="color: #007700">=</span><span style="color: #0000BB">$params</span><span style="color: #007700">[</span><span style="color: #DD0000">'on'</span><span style="color: #007700">];<br />&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;else<br />&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</span><span style="color: #0000BB">$on</span><span style="color: #007700">=</span><span style="color: #0000BB">preg_split</span><span style="color: #007700">(</span><span style="color: #DD0000">'/[\s,]+/'</span><span style="color: #007700">,</span><span style="color: #0000BB">$params</span><span style="color: #007700">[</span><span style="color: #DD0000">'on'</span><span style="color: #007700">],-</span><span style="color: #0000BB">1</span><span style="color: #007700">,</span><span style="color: #0000BB">PREG_SPLIT_NO_EMPTY</span><span style="color: #007700">);<br />&nbsp;&nbsp;&nbsp;&nbsp;}<br />&nbsp;&nbsp;&nbsp;&nbsp;else<br />&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</span><span style="color: #0000BB">$on</span><span style="color: #007700">=array();<br /><br />&nbsp;&nbsp;&nbsp;&nbsp;if(</span><span style="color: #0000BB">method_exists</span><span style="color: #007700">(</span><span style="color: #0000BB">$object</span><span style="color: #007700">,</span><span style="color: #0000BB">$name</span><span style="color: #007700">))<br />&nbsp;&nbsp;&nbsp;&nbsp;{<br />&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</span><span style="color: #0000BB">$validator</span><span style="color: #007700">=new&nbsp;</span><span style="color: #0000BB">CInlineValidator</span><span style="color: #007700">;<br />&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</span><span style="color: #0000BB">$validator</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">attributes</span><span style="color: #007700">=</span><span style="color: #0000BB">$attributes</span><span style="color: #007700">;<br />&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</span><span style="color: #0000BB">$validator</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">method</span><span style="color: #007700">=</span><span style="color: #0000BB">$name</span><span style="color: #007700">;<br />&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;if(isset(</span><span style="color: #0000BB">$params</span><span style="color: #007700">[</span><span style="color: #DD0000">'clientValidate'</span><span style="color: #007700">]))<br />&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;{<br />&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</span><span style="color: #0000BB">$validator</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">clientValidate</span><span style="color: #007700">=</span><span style="color: #0000BB">$params</span><span style="color: #007700">[</span><span style="color: #DD0000">'clientValidate'</span><span style="color: #007700">];<br />&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;unset(</span><span style="color: #0000BB">$params</span><span style="color: #007700">[</span><span style="color: #DD0000">'clientValidate'</span><span style="color: #007700">]);<br />&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;}<br />&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</span><span style="color: #0000BB">$validator</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">params</span><span style="color: #007700">=</span><span style="color: #0000BB">$params</span><span style="color: #007700">;<br />&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;if(isset(</span><span style="color: #0000BB">$params</span><span style="color: #007700">[</span><span style="color: #DD0000">'skipOnError'</span><span style="color: #007700">]))<br />&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</span><span style="color: #0000BB">$validator</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">skipOnError</span><span style="color: #007700">=</span><span style="color: #0000BB">$params</span><span style="color: #007700">[</span><span style="color: #DD0000">'skipOnError'</span><span style="color: #007700">];<br />&nbsp;&nbsp;&nbsp;&nbsp;}<br />&nbsp;&nbsp;&nbsp;&nbsp;else<br />&nbsp;&nbsp;&nbsp;&nbsp;{<br />&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</span><span style="color: #0000BB">$params</span><span style="color: #007700">[</span><span style="color: #DD0000">'attributes'</span><span style="color: #007700">]=</span><span style="color: #0000BB">$attributes</span><span style="color: #007700">;<br />&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;if(isset(</span><span style="color: #0000BB">self</span><span style="color: #007700">::</span><span style="color: #0000BB">$builtInValidators</span><span style="color: #007700">[</span><span style="color: #0000BB">$name</span><span style="color: #007700">]))<br />&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</span><span style="color: #0000BB">$className</span><span style="color: #007700">=</span><span style="color: #0000BB">Yii</span><span style="color: #007700">::</span><span style="color: #0000BB">import</span><span style="color: #007700">(</span><span style="color: #0000BB">self</span><span style="color: #007700">::</span><span style="color: #0000BB">$builtInValidators</span><span style="color: #007700">[</span><span style="color: #0000BB">$name</span><span style="color: #007700">],</span><span style="color: #0000BB">true</span><span style="color: #007700">);<br />&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;else<br />&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</span><span style="color: #0000BB">$className</span><span style="color: #007700">=</span><span style="color: #0000BB">Yii</span><span style="color: #007700">::</span><span style="color: #0000BB">import</span><span style="color: #007700">(</span><span style="color: #0000BB">$name</span><span style="color: #007700">,</span><span style="color: #0000BB">true</span><span style="color: #007700">);<br />&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</span><span style="color: #0000BB">$validator</span><span style="color: #007700">=new&nbsp;</span><span style="color: #0000BB">$className</span><span style="color: #007700">;<br />&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;foreach(</span><span style="color: #0000BB">$params&nbsp;</span><span style="color: #007700">as&nbsp;</span><span style="color: #0000BB">$name</span><span style="color: #007700">=&gt;</span><span style="color: #0000BB">$value</span><span style="color: #007700">)<br />&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</span><span style="color: #0000BB">$validator</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">$name</span><span style="color: #007700">=</span><span style="color: #0000BB">$value</span><span style="color: #007700">;<br />&nbsp;&nbsp;&nbsp;&nbsp;}<br /><br />&nbsp;&nbsp;&nbsp;&nbsp;</span><span style="color: #0000BB">$validator</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">on</span><span style="color: #007700">=empty(</span><span style="color: #0000BB">$on</span><span style="color: #007700">)&nbsp;?&nbsp;array()&nbsp;:&nbsp;</span><span style="color: #0000BB">array_combine</span><span style="color: #007700">(</span><span style="color: #0000BB">$on</span><span style="color: #007700">,</span><span style="color: #0000BB">$on</span><span style="color: #007700">);<br /><br />&nbsp;&nbsp;&nbsp;&nbsp;return&nbsp;</span><span style="color: #0000BB">$validator</span><span style="color: #007700">;<br />}</span>
    630. 

  630. </span>
    631. 

  631. </code></div>
    632. 

  632. </div>
    633. 

  633. <p>Creates a validator object.</p>
    634. 

  634. 

  635. 

  636. <div class="detailHeader" id="isEmpty-detail">
    637. 

  637. isEmpty()
    638. 

  638. <span class="detailHeaderTag">
    639. 

  639. method
    640. 

  640. </span>
    641. 

  641. </div>
    642. 

  642. 

  643. <table class="summaryTable">
    644. 

  644. <tr><td colspan="3">
    645. 

  645. <div class="signature2">
    646. 

  646. protected boolean <b>isEmpty</b>(mixed $value, boolean $trim=false)</div>
    647. 

  647. </td></tr>
    648. 

  648. <tr>
    649. 

  649.   <td class="paramNameCol">$value</td>
    650. 

  650.   <td class="paramTypeCol">mixed</td>
    651. 

  651.   <td class="paramDescCol">the value to be checked</td>
    652. 

  652. </tr>
    653. 

  653. <tr>
    654. 

  654.   <td class="paramNameCol">$trim</td>
    655. 

  655.   <td class="paramTypeCol">boolean</td>
    656. 

  656.   <td class="paramDescCol">whether to perform trimming before checking if the string is empty. Defaults to false.</td>
    657. 

  657. </tr>
    658. 

  658. <tr>
    659. 

  659.   <td class="paramNameCol">{return}</td>
    660. 

  660.   <td class="paramTypeCol">boolean</td>
    661. 

  661.   <td class="paramDescCol">whether the value is empty</td>
    662. 

  662. </tr>
    663. 

  663. </table>
    664. 

  664. 

  665. <div class="sourceCode">
    666. 

  666. <b>Source Code:</b> <a class="sourceLink" href="http://code.google.com/p/yii/source/browse/tags/1.1.10/framework/validators/CValidator.php#256">framework/validators/CValidator.php#256</a> (<b><a href="#" class="show">show</a></b>)
    667. 

  667. <div class="code"><code><span style="color: #000000">
    668. 

  668. <span style="color: #0000BB"></span><span style="color: #007700">protected&nbsp;function&nbsp;</span><span style="color: #0000BB">isEmpty</span><span style="color: #007700">(</span><span style="color: #0000BB">$value</span><span style="color: #007700">,</span><span style="color: #0000BB">$trim</span><span style="color: #007700">=</span><span style="color: #0000BB">false</span><span style="color: #007700">)<br />{<br />&nbsp;&nbsp;&nbsp;&nbsp;return&nbsp;</span><span style="color: #0000BB">$value</span><span style="color: #007700">===</span><span style="color: #0000BB">null&nbsp;</span><span style="color: #007700">||&nbsp;</span><span style="color: #0000BB">$value</span><span style="color: #007700">===array()&nbsp;||&nbsp;</span><span style="color: #0000BB">$value</span><span style="color: #007700">===</span><span style="color: #DD0000">''&nbsp;</span><span style="color: #007700">||&nbsp;</span><span style="color: #0000BB">$trim&nbsp;</span><span style="color: #007700">&amp;&amp;&nbsp;</span><span style="color: #0000BB">is_scalar</span><span style="color: #007700">(</span><span style="color: #0000BB">$value</span><span style="color: #007700">)&nbsp;&amp;&amp;&nbsp;</span><span style="color: #0000BB">trim</span><span style="color: #007700">(</span><span style="color: #0000BB">$value</span><span style="color: #007700">)===</span><span style="color: #DD0000">''</span><span style="color: #007700">;<br />}</span>
    669. 

  669. </span>
    670. 

  670. </code></div>
    671. 

  671. </div>
    672. 

  672. <p>Checks if the given value is empty.
    673. 

  673. A value is considered empty if it is null, an empty array, or the trimmed result is an empty string.
    674. 

  674. Note that this method is different from PHP empty(). It will return false when the value is 0.</p>
    675. 

  675. 

  676. 

  677. <div class="detailHeader" id="validate-detail">
    678. 

  678. validate()
    679. 

  679. <span class="detailHeaderTag">
    680. 

  680. method
    681. 

  681. </span>
    682. 

  682. </div>
    683. 

  683. 

  684. <table class="summaryTable">
    685. 

  685. <tr><td colspan="3">
    686. 

  686. <div class="signature2">
    687. 

  687. public void <b>validate</b>(<a href="CModel.html">CModel</a> $object, array $attributes=NULL)</div>
    688. 

  688. </td></tr>
    689. 

  689. <tr>
    690. 

  690.   <td class="paramNameCol">$object</td>
    691. 

  691.   <td class="paramTypeCol"><a href="CModel.html">CModel</a></td>
    692. 

  692.   <td class="paramDescCol">the data object being validated</td>
    693. 

  693. </tr>
    694. 

  694. <tr>
    695. 

  695.   <td class="paramNameCol">$attributes</td>
    696. 

  696.   <td class="paramTypeCol">array</td>
    697. 

  697.   <td class="paramDescCol">the list of attributes to be validated. Defaults to null,
    698. 

  698. meaning every attribute listed in <a href="CValidator.html#attributes">attributes</a> will be validated.</td>
    699. 

  699. </tr>
    700. 

  700. </table>
    701. 

  701. 

  702. <div class="sourceCode">
    703. 

  703. <b>Source Code:</b> <a class="sourceLink" href="http://code.google.com/p/yii/source/browse/tags/1.1.10/framework/validators/CValidator.php#188">framework/validators/CValidator.php#188</a> (<b><a href="#" class="show">show</a></b>)
    704. 

  704. <div class="code"><code><span style="color: #000000">
    705. 

  705. <span style="color: #0000BB"></span><span style="color: #007700">public&nbsp;function&nbsp;</span><span style="color: #0000BB">validate</span><span style="color: #007700">(</span><span style="color: #0000BB">$object</span><span style="color: #007700">,</span><span style="color: #0000BB">$attributes</span><span style="color: #007700">=</span><span style="color: #0000BB">null</span><span style="color: #007700">)<br />{<br />&nbsp;&nbsp;&nbsp;&nbsp;if(</span><span style="color: #0000BB">is_array</span><span style="color: #007700">(</span><span style="color: #0000BB">$attributes</span><span style="color: #007700">))<br />&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</span><span style="color: #0000BB">$attributes</span><span style="color: #007700">=</span><span style="color: #0000BB">array_intersect</span><span style="color: #007700">(</span><span style="color: #0000BB">$this</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">attributes</span><span style="color: #007700">,</span><span style="color: #0000BB">$attributes</span><span style="color: #007700">);<br />&nbsp;&nbsp;&nbsp;&nbsp;else<br />&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</span><span style="color: #0000BB">$attributes</span><span style="color: #007700">=</span><span style="color: #0000BB">$this</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">attributes</span><span style="color: #007700">;<br />&nbsp;&nbsp;&nbsp;&nbsp;foreach(</span><span style="color: #0000BB">$attributes&nbsp;</span><span style="color: #007700">as&nbsp;</span><span style="color: #0000BB">$attribute</span><span style="color: #007700">)<br />&nbsp;&nbsp;&nbsp;&nbsp;{<br />&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;if(!</span><span style="color: #0000BB">$this</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">skipOnError&nbsp;</span><span style="color: #007700">||&nbsp;!</span><span style="color: #0000BB">$object</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">hasErrors</span><span style="color: #007700">(</span><span style="color: #0000BB">$attribute</span><span style="color: #007700">))<br />&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</span><span style="color: #0000BB">$this</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">validateAttribute</span><span style="color: #007700">(</span><span style="color: #0000BB">$object</span><span style="color: #007700">,</span><span style="color: #0000BB">$attribute</span><span style="color: #007700">);<br />&nbsp;&nbsp;&nbsp;&nbsp;}<br />}</span>
    706. 

  706. </span>
    707. 

  707. </code></div>
    708. 

  708. </div>
    709. 

  709. <p>Validates the specified object.</p>
    710. 

  710. 

  711. 

  712. <div class="detailHeader" id="validateAttribute-detail">
    713. 

  713. validateAttribute()
    714. 

  714. <span class="detailHeaderTag">
    715. 

  715. method
    716. 

  716. </span>
    717. 

  717. </div>
    718. 

  718. 

  719. <table class="summaryTable">
    720. 

  720. <tr><td colspan="3">
    721. 

  721. <div class="signature2">
    722. 

  722. abstract protected void <b>validateAttribute</b>(<a href="CModel.html">CModel</a> $object, string $attribute)</div>
    723. 

  723. </td></tr>
    724. 

  724. <tr>
    725. 

  725.   <td class="paramNameCol">$object</td>
    726. 

  726.   <td class="paramTypeCol"><a href="CModel.html">CModel</a></td>
    727. 

  727.   <td class="paramDescCol">the data object being validated</td>
    728. 

  728. </tr>
    729. 

  729. <tr>
    730. 

  730.   <td class="paramNameCol">$attribute</td>
    731. 

  731.   <td class="paramTypeCol">string</td>
    732. 

  732.   <td class="paramDescCol">the name of the attribute to be validated.</td>
    733. 

  733. </tr>
    734. 

  734. </table>
    735. 

  735. 

  736. <div class="sourceCode">
    737. 

  737. <b>Source Code:</b> <a class="sourceLink" href="http://code.google.com/p/yii/source/browse/tags/1.1.10/framework/validators/CValidator.php#124">framework/validators/CValidator.php#124</a> (<b><a href="#" class="show">show</a></b>)
    738. 

  738. <div class="code"><code><span style="color: #000000">
    739. 

  739. <span style="color: #0000BB"></span><span style="color: #007700">abstract&nbsp;protected&nbsp;function&nbsp;</span><span style="color: #0000BB">validateAttribute</span><span style="color: #007700">(</span><span style="color: #0000BB">$object</span><span style="color: #007700">,</span><span style="color: #0000BB">$attribute</span><span style="color: #007700">);</span>
    740. 

  740. </span>
    741. 

  741. </code></div>
    742. 

  742. </div>
    743. 

  743. <p>Validates a single attribute.
    744. 

  744. This method should be overridden by child classes.</p>
    745. 

  745. 

  746. 

  747. </div><!-- end of content -->
    748. 

  748. 

  749. <div id="apiFooter">
    750. 

  750. Copyright &copy; 2008-2011 by <a href="http://www.yiisoft.com">Yii Software LLC</a><br/>
    751. 

  751. All Rights Reserved.<br/>
    752. 

  752. </div><!-- end of footer -->
    753. 

  753. 

  754. <script type="text/javascript">
    755. 

  755. /*<![CDATA[*/
    756. 

  756. $("a.toggle").toggle(function(){
    757. 

  757. 	$(this).text($(this).text().replace(/Hide/,'Show'));
    758. 

  758. 	$(this).parents(".summary").find(".inherited").hide();
    759. 

  759. },function(){
    760. 

  760. 	$(this).text($(this).text().replace(/Show/,'Hide'));
    761. 

  761. 	$(this).parents(".summary").find(".inherited").show();
    762. 

  762. });
    763. 

  763. $(".sourceCode a.show").toggle(function(){
    764. 

  764. 	$(this).text($(this).text().replace(/show/,'hide'));
    765. 

  765. 	$(this).parents(".sourceCode").find("div.code").show();
    766. 

  766. },function(){
    767. 

  767. 	$(this).text($(this).text().replace(/hide/,'show'));
    768. 

  768. 	$(this).parents(".sourceCode").find("div.code").hide();
    769. 

  769. });
    770. 

  770. $("a.sourceLink").click(function(){
    771. 

  771. 	$(this).attr('target','_blank');
    772. 

  772. });
    773. 

  773. /*]]>*/
    774. 

  774. </script>
    775. 

  775. 

  776. </div><!-- end of page -->
    777. 

  777. </body>
    778. 

  778. </html>
    779.