HTML_QuickForm
[ class tree: HTML_QuickForm ] [ index: HTML_QuickForm ] [ all elements ]
Packages:
HTML_QuickForm


Classes:
HTML_QuickForm
HTML_QuickForm_advcheckbox
HTML_QuickForm_autocomplete
HTML_QuickForm_button
HTML_QuickForm_checkbox
HTML_QuickForm_date
HTML_QuickForm_element
HTML_QuickForm_Error
HTML_QuickForm_file
HTML_QuickForm_group
HTML_QuickForm_header
HTML_QuickForm_hidden
HTML_QuickForm_hiddenselect
HTML_QuickForm_hierselect
HTML_QuickForm_html
HTML_QuickForm_image
HTML_QuickForm_input
HTML_QuickForm_link
HTML_QuickForm_password
HTML_QuickForm_radio
HTML_QuickForm_Renderer
HTML_QuickForm_Renderer_Array
HTML_QuickForm_Renderer_ArraySmarty
HTML_QuickForm_Renderer_Default
HTML_QuickForm_Renderer_ITDynamic
HTML_QuickForm_Renderer_ITStatic
HTML_QuickForm_Renderer_Object
HTML_QuickForm_Renderer_ObjectFlexy
HTML_QuickForm_Renderer_QuickHtml
HTML_QuickForm_reset
HTML_QuickForm_Rule
HTML_QuickForm_RuleRegistry
HTML_QuickForm_Rule_Callback
HTML_QuickForm_Rule_Compare
HTML_QuickForm_Rule_Email
HTML_QuickForm_Rule_Range
HTML_QuickForm_Rule_Regex
HTML_QuickForm_Rule_Required
HTML_QuickForm_select
HTML_QuickForm_static
HTML_QuickForm_submit
HTML_QuickForm_text
HTML_QuickForm_textarea
HTML_QuickForm_xbutton
QuickformElement
QuickformForm
Files:
advcheckbox.php
Array.php
ArraySmarty.php
autocomplete.php
button.php
Callback.php
checkbox.php
Compare.php
date.php
Default.php
element.php
Email.php
file.php
group.php
header.php
hidden.php
hiddenselect.php
hierselect.php
html.php
image.php
input.php
ITDynamic.php
ITStatic.php
link.php
Object.php
ObjectFlexy.php
password.php
QuickForm.php
QuickHtml.php
radio.php
Range.php
Regex.php
Renderer.php
Required.php
reset.php
Rule.php
RuleRegistry.php
select.php
static.php
submit.php
text.php
textarea.php
xbutton.php

Class: HTML_QuickForm_RuleRegistry

Source Location: /HTML_QuickForm-3.2.13/QuickForm/RuleRegistry.php

Class Overview




Registers rule objects and uses them for validation




Author(s):






                
        

Version:


    
  
  • Release: 3.2.13
    • 









Methods
















Inherited Variables





Inherited Methods














Class Details



[line 37]

Registers rule objects and uses them for validation









[ Top ]








Method Detail



	
	
getRule   [line 120]

	

    

    

		HTML_QuickForm_Rule &getRule(
string
$ruleName)
    

    


	
		Returns a reference to the requested rule object


    

  • Access: public
    • 








        
Parameters:

    

    

          

        string  
        $ruleName  
        —
          Name of the requested rule
      

        

    


        
[ Top ]

  

  
  
	
	
getValidationScript   [line 172]

	

    

    

		string getValidationScript(
array|HTML_QuickForm_element
&$element, string
$elementName, array
$ruleData)
    

    


	
		Returns the validation test in javascript code


    

  • Return: JavaScript for the rule
    • 

  • Access: public
    • 








        
Parameters:

    

    

          

        array|HTML_QuickForm_element  
        &$element  
        —
          Element(s) the rule applies to
      

          

        string  
        $elementName  
        —
          Element name, in case $element is                                           not an array
      

          

        array  
        $ruleData  
        —
          Rule data
      

        

    


        
[ Top ]

  

  
  
	
	
registerRule   [line 87]

	

    

    

		void registerRule(
string
$ruleName, string
$type, string
$data1, [string
$data2 = null])
    

    


	
		Registers a new validation rule
In order to use a custom rule in your form, you need to register it  first. For regular expressions, one can directly use the 'regex' type  rule in addRule(), this is faster than registering the rule.
Functions and methods can be registered. Use the 'function' type.  When registering a method, specify the class name as second parameter.
You can also register an HTML_QuickForm_Rule subclass with its own  validate() method.


    

  • Access: public
    • 








        
Parameters:

    

    

          

        string  
        $ruleName  
        —
          Name of validation rule
      

          

        string  
        $type  
        —
          Either: 'regex', 'function' or null
      

          

        string  
        $data1  
        —
          Name of function, regular expression or                                   HTML_QuickForm_Rule object class name
      

          

        string  
        $data2  
        —
          Object parent of above function or HTML_QuickForm_Rule file path
      

        

    


        
[ Top ]

  

  
  
	
	
singleton   [line 57]

	

    

    

		HTML_QuickForm_RuleRegistry &singleton(
)
    

    


	
		Returns a singleton of HTML_QuickForm_RuleRegistry
Usually, only one RuleRegistry object is needed, this is the reason  why it is recommended to use this method to get the validation object.


    

  • Access: public
    • 








        
[ Top ]

  

  
  
	
	
validate   [line 145]

	

    

    

		mixed validate(
string
$ruleName, mixed
$values, [mixed
$options = null], [mixed
$multiple = false])
    

    


	
		Performs validation on the given values


    

  • Return: true if no error found, int of valid values (when an array of values is given) or false if error
    • 

  • Access: public
    • 








        
Parameters:

    

    

          

        string  
        $ruleName  
        —
          Name of the rule to be used
      

          

        mixed  
        $values  
        —
          Can be a scalar or an array of values                                       to be validated
      

          

        mixed  
        $options  
        —
          Options used by the rule
      

          

        mixed  
        $multiple  
        —
          Whether to validate an array of values altogether
      

        

    


        
[ Top ]

  

  
  



        

		    

		    Documentation generated on Sat, 01 Oct 2011 09:00:19 +0000 by phpDocumentor 1.4.3. PEAR Logo Copyright ©  PHP Group 2004.