Class: I2CE Validate: Difference between revisions

From IHRIS Wiki
No edit summary
No edit summary
Line 1: Line 1:
This article describes the class ''I2CE_Validate''.
This article describes the class ''I2CE_Validate''.
*Location: Part of the module [[I2CE Module List#I2CE|I2CE]] in the package [https://launchpad.net/i2ce I2CE]
*Location: Part of the module [[I2CE Module List#I2CE|I2CE]] in the package [https://launchpad.net/i2ce I2CE]
*Source: Defined in the file [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.1-release/annotate/head:/lib/I2CE_Validate.php lib/I2CE_Validate.php]
*Source: Defined in the file [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/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.0.2-release/annotate/head:/lib/I2CE_Validate.php#L135 i2ce/lib/I2CE_Validate.php] on line 135
*Type: static protected $false
*Type: static protected $false


===$true===
===$true===
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/lib/I2CE_Validate.php#L136 i2ce/lib/I2CE_Validate.php] on line 136
*Type: static protected $true
*Type: static protected $true


===$BaseChar===
===$BaseChar===
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/lib/I2CE_Validate.php#L263 i2ce/lib/I2CE_Validate.php] on line 263
*Type: static protected $BaseChar
*Type: static protected $BaseChar


===$Ideographic===
===$Ideographic===
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/lib/I2CE_Validate.php#L264 i2ce/lib/I2CE_Validate.php] on line 264
*Type: static protected $Ideographic
*Type: static protected $Ideographic


===$Letter===
===$Letter===
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/lib/I2CE_Validate.php#L265 i2ce/lib/I2CE_Validate.php] on line 265
*Type: static protected $Letter
*Type: static protected $Letter


===$Digit===
===$Digit===
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/lib/I2CE_Validate.php#L266 i2ce/lib/I2CE_Validate.php] on line 266
*Type: static protected $Digit
*Type: static protected $Digit


===$CombiningChar===
===$CombiningChar===
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/lib/I2CE_Validate.php#L267 i2ce/lib/I2CE_Validate.php] on line 267
*Type: static protected $CombiningChar
*Type: static protected $CombiningChar


===$Extender===
===$Extender===
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/lib/I2CE_Validate.php#L268 i2ce/lib/I2CE_Validate.php] on line 268
*Type: static protected $Extender
*Type: static protected $Extender


===$NameChar===
===$NameChar===
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/lib/I2CE_Validate.php#L269 i2ce/lib/I2CE_Validate.php] on line 269
*Type: static protected $NameChar
*Type: static protected $NameChar


===$Name===
===$Name===
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/lib/I2CE_Validate.php#L270 i2ce/lib/I2CE_Validate.php] on line 270
*Type: static protected $Name
*Type: static protected $Name


===$tokenRegexps===
===$tokenRegexps===
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/lib/I2CE_Validate.php#L271 i2ce/lib/I2CE_Validate.php] on line 271
*Type: static protected $tokenRegexps
*Type: static protected $tokenRegexps


Line 39: Line 50:
===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.0.2-release/annotate/head:/lib/I2CE_Validate.php#L97 i2ce/lib/I2CE_Validate.php] on line 97
*Signature: static public function checkCurrency($data)
*Signature: static public function checkCurrency($data)
*Parameters:
*Parameters:
Line 45: Line 57:
===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.0.2-release/annotate/head:/lib/I2CE_Validate.php#L128 i2ce/lib/I2CE_Validate.php] on line 128
*Signature: static public function checkDate($data)
*Signature: static public function checkDate($data)
*Parameters:
*Parameters:
Line 50: Line 63:
*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.0.2-release/annotate/head:/lib/I2CE_Validate.php#L108 i2ce/lib/I2CE_Validate.php] on line 108
*Signature: static public function checkEmail($email)
*Signature: static public function checkEmail($email)
*Parameters:
*Parameters:
Line 55: Line 69:
===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.0.2-release/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 61: Line 76:
===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.0.2-release/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 69: Line 85:
===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.0.2-release/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 75: Line 92:
===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.0.2-release/annotate/head:/lib/I2CE_Validate.php#L177 i2ce/lib/I2CE_Validate.php] on line 177
*Signature: static public function checkVersion($vers1,$operator,$vers2)
*Signature: static public function checkVersion($vers1,$operator,$vers2)
*Parameters:
*Parameters:
Line 83: Line 101:
===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.0.2-release/annotate/head:/lib/I2CE_Validate.php#L143 i2ce/lib/I2CE_Validate.php] on line 143
*Signature: static public function convertToBoolean($string,$asBool)
*Signature: static public function convertToBoolean($string,$asBool)
*Parameters:
*Parameters:
Line 90: Line 109:
*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.0.2-release/annotate/head:/lib/I2CE_Validate.php#L298 i2ce/lib/I2CE_Validate.php] on line 298
*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.0.2-release/annotate/head:/lib/I2CE_Validate.php#L282 i2ce/lib/I2CE_Validate.php] on line 282
*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.0.2-release/annotate/head:/lib/I2CE_Validate.php#L288 i2ce/lib/I2CE_Validate.php] on line 288
*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.0.2-release/annotate/head:/lib/I2CE_Validate.php#L293 i2ce/lib/I2CE_Validate.php] on line 293
*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.0.2-release/annotate/head:/lib/I2CE_Validate.php#L272 i2ce/lib/I2CE_Validate.php] on line 272
*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.0.2-release/annotate/head:/lib/I2CE_Validate.php#L117 i2ce/lib/I2CE_Validate.php] on line 117
*Signature: static public function stripCurrency($data)
*Signature: static public function stripCurrency($data)
*Parameters:
*Parameters:

Revision as of 09:19, 10 November 2009

This article describes the class I2CE_Validate.

Variables

$false

$true

$BaseChar

$Ideographic

$Letter

$Digit

$CombiningChar

$Extender

$NameChar

$Name

$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.

checkDate()

Checks to make sure a date is valid

checkEmail()

checkMap()

Checks to make sure a mapped value is valid. Map values are saved as an array( "form", "id" );

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

checkString()

Checks to make sure a string isn't blank.

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 177
  • 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 143
  • Signature: static public function convertToBoolean($string,$asBool)
  • Parameters:
    • string $string
    • boolean $asBool
      Defaults to false. If true returns true/false otherwise returns 1/0. I know ... this is confusing.
      • Default Value: false
  • Returns: mixed
    string or null if it is not recognized

isNmToken()

isTokenDigit()

isTokenLetter()

isTokenName()

setupTokenRegexps()

stripCurrency()

Remove any invalid characters that can't be part of a valid currency value.