Class: I2CE Validate (Development): Difference between revisions
No edit summary |
No edit summary |
||
Line 1: | Line 1: | ||
{{otherversions|Class: I2CE_Validate}} | {{otherversions|Class: I2CE_Validate}} | ||
This article describes the class ''I2CE_Validate'' . | This article describes the class ''I2CE_Validate'' . | ||
*Location: Part of the module [[I2CE Module List (Development)#I2CE|I2CE]] in the package [https://launchpad.net/i2ce I2CE] 4. | *Location: Part of the module [[I2CE Module List (Development)#I2CE|I2CE]] in the package [https://launchpad.net/i2ce I2CE] 4.1-dev | ||
*Source: Defined in the file [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4. | *Source: Defined in the file [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/lib/I2CE_Validate.php#L34 lib/I2CE_Validate.php] on line 34 | ||
==Variables== | ==Variables== | ||
===$false=== | ===$false=== | ||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4. | *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/lib/I2CE_Validate.php#L153 i2ce/lib/I2CE_Validate.php] on line 153 | ||
*Type: static protected $false | *Type: static protected $false | ||
===$true=== | ===$true=== | ||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4. | *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/lib/I2CE_Validate.php#L154 i2ce/lib/I2CE_Validate.php] on line 154 | ||
*Type: static protected $true | *Type: static protected $true | ||
===$BaseChar=== | ===$BaseChar=== | ||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4. | *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/lib/I2CE_Validate.php#L281 i2ce/lib/I2CE_Validate.php] on line 281 | ||
*Type: static protected $BaseChar | *Type: static protected $BaseChar | ||
===$Ideographic=== | ===$Ideographic=== | ||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4. | *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/lib/I2CE_Validate.php#L282 i2ce/lib/I2CE_Validate.php] on line 282 | ||
*Type: static protected $Ideographic | *Type: static protected $Ideographic | ||
===$Letter=== | ===$Letter=== | ||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4. | *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/lib/I2CE_Validate.php#L283 i2ce/lib/I2CE_Validate.php] on line 283 | ||
*Type: static protected $Letter | *Type: static protected $Letter | ||
===$Digit=== | ===$Digit=== | ||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4. | *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/lib/I2CE_Validate.php#L284 i2ce/lib/I2CE_Validate.php] on line 284 | ||
*Type: static protected $Digit | *Type: static protected $Digit | ||
===$CombiningChar=== | ===$CombiningChar=== | ||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4. | *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/lib/I2CE_Validate.php#L285 i2ce/lib/I2CE_Validate.php] on line 285 | ||
*Type: static protected $CombiningChar | *Type: static protected $CombiningChar | ||
===$Extender=== | ===$Extender=== | ||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4. | *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/lib/I2CE_Validate.php#L286 i2ce/lib/I2CE_Validate.php] on line 286 | ||
*Type: static protected $Extender | *Type: static protected $Extender | ||
===$NameChar=== | ===$NameChar=== | ||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4. | *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/lib/I2CE_Validate.php#L287 i2ce/lib/I2CE_Validate.php] on line 287 | ||
*Type: static protected $NameChar | *Type: static protected $NameChar | ||
===$Name=== | ===$Name=== | ||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4. | *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/lib/I2CE_Validate.php#L288 i2ce/lib/I2CE_Validate.php] on line 288 | ||
*Type: static protected $Name | *Type: static protected $Name | ||
===$tokenRegexps=== | ===$tokenRegexps=== | ||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4. | *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/lib/I2CE_Validate.php#L289 i2ce/lib/I2CE_Validate.php] on line 289 | ||
*Type: static protected $tokenRegexps | *Type: static protected $tokenRegexps | ||
Line 51: | Line 51: | ||
===checkCurrency()=== | ===checkCurrency()=== | ||
Checks to make sure currency is valid. This method checks to make sure a number is valid for currency. It can have a decimal or comma with 2 digits past. | Checks to make sure currency is valid. This method checks to make sure a number is valid for currency. It can have a decimal or comma with 2 digits past. | ||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4. | *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/lib/I2CE_Validate.php#L98 i2ce/lib/I2CE_Validate.php] on line 98 | ||
*Signature: static public function checkCurrency($data) | *Signature: static public function checkCurrency($data) | ||
*Parameters: | *Parameters: | ||
Line 58: | Line 58: | ||
===checkDate()=== | ===checkDate()=== | ||
Checks to make sure a date is valid | Checks to make sure a date is valid | ||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4. | *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/lib/I2CE_Validate.php#L146 i2ce/lib/I2CE_Validate.php] on line 146 | ||
*Signature: static public function checkDate($data) | *Signature: static public function checkDate($data) | ||
*Parameters: | *Parameters: | ||
Line 64: | Line 64: | ||
*Returns: [http://www.php.net/manual/en/language.types.boolean.php boolean ] | *Returns: [http://www.php.net/manual/en/language.types.boolean.php boolean ] | ||
===checkEmail()=== | ===checkEmail()=== | ||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4. | *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/lib/I2CE_Validate.php#L109 i2ce/lib/I2CE_Validate.php] on line 109 | ||
*Signature: static public function checkEmail($email) | *Signature: static public function checkEmail($email) | ||
*Parameters: | *Parameters: | ||
Line 70: | Line 70: | ||
===checkMap()=== | ===checkMap()=== | ||
Checks to make sure a mapped value is valid. Map values are saved as an array( "form", "id" ); | Checks to make sure a mapped value is valid. Map values are saved as an array( "form", "id" ); | ||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4. | *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/lib/I2CE_Validate.php#L81 i2ce/lib/I2CE_Validate.php] on line 81 | ||
*Signature: static public function checkMap($data) | *Signature: static public function checkMap($data) | ||
*Parameters: | *Parameters: | ||
Line 77: | Line 77: | ||
===checkNumber()=== | ===checkNumber()=== | ||
Checks to make sure a number is valid This method checks to make sure the number is a number and optionally that it is greater than a specific value. | Checks to make sure a number is valid This method checks to make sure the number is a number and optionally that it is greater than a specific value. | ||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4. | *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/lib/I2CE_Validate.php#L59 i2ce/lib/I2CE_Validate.php] on line 59 | ||
*Signature: static public function checkNumber($data,$min_value) | *Signature: static public function checkNumber($data,$min_value) | ||
*Parameters: | *Parameters: | ||
Line 84: | Line 84: | ||
***Default Value: false | ***Default Value: false | ||
*Returns: [http://www.php.net/manual/en/language.types.boolean.php boolean ] | *Returns: [http://www.php.net/manual/en/language.types.boolean.php boolean ] | ||
===checkPassword()=== | |||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/lib/I2CE_Validate.php#L124 i2ce/lib/I2CE_Validate.php] on line 124 | |||
*Signature: static public function checkPassword($password) | |||
*Parameters: | |||
**$password | |||
===checkString()=== | ===checkString()=== | ||
Checks to make sure a string isn't blank. | Checks to make sure a string isn't blank. | ||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4. | *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/lib/I2CE_Validate.php#L41 i2ce/lib/I2CE_Validate.php] on line 41 | ||
*Signature: static public function checkString($data) | *Signature: static public function checkString($data) | ||
*Parameters: | *Parameters: | ||
Line 93: | Line 98: | ||
===checkVersion()=== | ===checkVersion()=== | ||
Checks to see if the versions meet the demans given by the operator. Opeartors are '<','lessthan','>','greaterthan','=','equal','equals','exactly','<=','atmost','>=','atleast' | Checks to see if the versions meet the demans given by the operator. Opeartors are '<','lessthan','>','greaterthan','=','equal','equals','exactly','<=','atmost','>=','atleast' | ||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4. | *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/lib/I2CE_Validate.php#L195 i2ce/lib/I2CE_Validate.php] on line 195 | ||
*Signature: static public function checkVersion($vers1,$operator,$vers2) | *Signature: static public function checkVersion($vers1,$operator,$vers2) | ||
*Parameters: | *Parameters: | ||
Line 102: | Line 107: | ||
===convertToBoolean()=== | ===convertToBoolean()=== | ||
Converts a string such as true/false/yes/no/1/0 to boolean value (stored as either the string '0' or '1') | Converts a string such as true/false/yes/no/1/0 to boolean value (stored as either the string '0' or '1') | ||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4. | *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/lib/I2CE_Validate.php#L161 i2ce/lib/I2CE_Validate.php] on line 161 | ||
*Signature: static public function convertToBoolean($string,$asBool) | *Signature: static public function convertToBoolean($string,$asBool) | ||
*Parameters: | *Parameters: | ||
Line 110: | Line 115: | ||
*Returns: [http://www.php.net/manual/en/language.pseudo-types.php mixed ]<br/>string or null if it is not recognized | *Returns: [http://www.php.net/manual/en/language.pseudo-types.php mixed ]<br/>string or null if it is not recognized | ||
===isNmToken()=== | ===isNmToken()=== | ||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4. | *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/lib/I2CE_Validate.php#L316 i2ce/lib/I2CE_Validate.php] on line 316 | ||
*Signature: static public function isNmToken($val) | *Signature: static public function isNmToken($val) | ||
*Parameters: | *Parameters: | ||
**$val | **$val | ||
===isTokenDigit()=== | ===isTokenDigit()=== | ||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4. | *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/lib/I2CE_Validate.php#L300 i2ce/lib/I2CE_Validate.php] on line 300 | ||
*Signature: static public function isTokenDigit($val) | *Signature: static public function isTokenDigit($val) | ||
*Parameters: | *Parameters: | ||
**$val | **$val | ||
===isTokenLetter()=== | ===isTokenLetter()=== | ||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4. | *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/lib/I2CE_Validate.php#L306 i2ce/lib/I2CE_Validate.php] on line 306 | ||
*Signature: static public function isTokenLetter($val) | *Signature: static public function isTokenLetter($val) | ||
*Parameters: | *Parameters: | ||
**$val | **$val | ||
===isTokenName()=== | ===isTokenName()=== | ||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4. | *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/lib/I2CE_Validate.php#L311 i2ce/lib/I2CE_Validate.php] on line 311 | ||
*Signature: static public function isTokenName($val) | *Signature: static public function isTokenName($val) | ||
*Parameters: | *Parameters: | ||
**$val | **$val | ||
===setupTokenRegexps()=== | ===setupTokenRegexps()=== | ||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4. | *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/lib/I2CE_Validate.php#L290 i2ce/lib/I2CE_Validate.php] on line 290 | ||
*Signature: protected function setupTokenRegexps() | *Signature: protected function setupTokenRegexps() | ||
===stripCurrency()=== | ===stripCurrency()=== | ||
Remove any invalid characters that can't be part of a valid currency value. | Remove any invalid characters that can't be part of a valid currency value. | ||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4. | *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/lib/I2CE_Validate.php#L119 i2ce/lib/I2CE_Validate.php] on line 119 | ||
*Signature: static public function stripCurrency($data) | *Signature: static public function stripCurrency($data) | ||
*Parameters: | *Parameters: |
Latest revision as of 08:20, 6 May 2015
This article describes the class I2CE_Validate .
- Location: Part of the module I2CE in the package I2CE 4.1-dev
- Source: Defined in the file lib/I2CE_Validate.php on line 34
Variables
$false
- Defined in i2ce/lib/I2CE_Validate.php on line 153
- Type: static protected $false
$true
- Defined in i2ce/lib/I2CE_Validate.php on line 154
- Type: static protected $true
$BaseChar
- Defined in i2ce/lib/I2CE_Validate.php on line 281
- Type: static protected $BaseChar
$Ideographic
- Defined in i2ce/lib/I2CE_Validate.php on line 282
- Type: static protected $Ideographic
$Letter
- Defined in i2ce/lib/I2CE_Validate.php on line 283
- Type: static protected $Letter
$Digit
- Defined in i2ce/lib/I2CE_Validate.php on line 284
- Type: static protected $Digit
$CombiningChar
- Defined in i2ce/lib/I2CE_Validate.php on line 285
- Type: static protected $CombiningChar
$Extender
- Defined in i2ce/lib/I2CE_Validate.php on line 286
- Type: static protected $Extender
$NameChar
- Defined in i2ce/lib/I2CE_Validate.php on line 287
- Type: static protected $NameChar
$Name
- Defined in i2ce/lib/I2CE_Validate.php on line 288
- Type: static protected $Name
$tokenRegexps
- Defined in i2ce/lib/I2CE_Validate.php on line 289
- Type: static protected $tokenRegexps
Methods
checkCurrency()
Checks to make sure currency is valid. This method checks to make sure a number is valid for currency. It can have a decimal or comma with 2 digits past.
- Defined in i2ce/lib/I2CE_Validate.php on line 98
- Signature: static public function checkCurrency($data)
- Parameters:
- number $data
- Returns: boolean
checkDate()
Checks to make sure a date is valid
- Defined in i2ce/lib/I2CE_Validate.php on line 146
- Signature: static public function checkDate($data)
- Parameters:
- I2CE_Date $data
- Returns: boolean
checkEmail()
- Defined in i2ce/lib/I2CE_Validate.php on line 109
- Signature: static public function checkEmail($email)
- Parameters:
checkMap()
Checks to make sure a mapped value is valid. Map values are saved as an array( "form", "id" );
- Defined in i2ce/lib/I2CE_Validate.php on line 81
- Signature: static public function checkMap($data)
- Parameters:
- array $data
- Returns: boolean
checkNumber()
Checks to make sure a number is valid This method checks to make sure the number is a number and optionally that it is greater than a specific value.
- Defined in i2ce/lib/I2CE_Validate.php on line 59
- Signature: static public function checkNumber($data,$min_value)
- Parameters:
- number $data
- number $min_value
- Default Value: false
- Returns: boolean
checkPassword()
- Defined in i2ce/lib/I2CE_Validate.php on line 124
- Signature: static public function checkPassword($password)
- Parameters:
- $password
checkString()
Checks to make sure a string isn't blank.
- Defined in i2ce/lib/I2CE_Validate.php on line 41
- Signature: static public function checkString($data)
- Parameters:
- string $data
- Returns: boolean
checkVersion()
Checks to see if the versions meet the demans given by the operator. Opeartors are '<','lessthan','>','greaterthan','=','equal','equals','exactly','<=','atmost','>=','atleast'
- Defined in i2ce/lib/I2CE_Validate.php on line 195
- Signature: static public function checkVersion($vers1,$operator,$vers2)
- Parameters:
- $vers1
- $operator
- $vers2
- Returns: true
on sucess. false on failure
convertToBoolean()
Converts a string such as true/false/yes/no/1/0 to boolean value (stored as either the string '0' or '1')
- Defined in i2ce/lib/I2CE_Validate.php on line 161
- Signature: static public function convertToBoolean($string,$asBool)
- Parameters:
- Returns: mixed
string or null if it is not recognized
isNmToken()
- Defined in i2ce/lib/I2CE_Validate.php on line 316
- Signature: static public function isNmToken($val)
- Parameters:
- $val
isTokenDigit()
- Defined in i2ce/lib/I2CE_Validate.php on line 300
- Signature: static public function isTokenDigit($val)
- Parameters:
- $val
isTokenLetter()
- Defined in i2ce/lib/I2CE_Validate.php on line 306
- Signature: static public function isTokenLetter($val)
- Parameters:
- $val
isTokenName()
- Defined in i2ce/lib/I2CE_Validate.php on line 311
- Signature: static public function isTokenName($val)
- Parameters:
- $val
setupTokenRegexps()
- Defined in i2ce/lib/I2CE_Validate.php on line 290
- Signature: protected function setupTokenRegexps()
stripCurrency()
Remove any invalid characters that can't be part of a valid currency value.
- Defined in i2ce/lib/I2CE_Validate.php on line 119
- Signature: static public function stripCurrency($data)
- Parameters:
- string $data
- Returns: number