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 [[iHRIS 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.0-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.0-release/annotate/head:/lib/I2CE_Validate.php lib/I2CE_Validate.php]
==Variables==
==Variables==

Revision as of 12:11, 19 October 2009

This article describes the class I2CE_Validate.

Variables

$false

  • Type: static protected $false

$true

  • Type: static protected $true

$BaseChar

  • Type: static protected $BaseChar

$Ideographic

  • Type: static protected $Ideographic

$Letter

  • Type: static protected $Letter

$Digit

  • Type: static protected $Digit

$CombiningChar

  • Type: static protected $CombiningChar

$Extender

  • Type: static protected $Extender

$NameChar

  • Type: static protected $NameChar

$Name

  • Type: static protected $Name

$tokenRegexps

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

  • Signature: static public function checkCurrency($data)
  • Parameters:
    • number $data
  • Returns: boolean

checkDate()

Checks to make sure a date is valid

  • Signature: static public function checkDate($data)
  • Parameters:
  • Returns: boolean

checkEmail()

  • Signature: static public function checkEmail($email)
  • Parameters:
    • $email

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.

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

  • Signature: static public function checkString($data)
  • Parameters:
  • 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'

  • 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')

  • 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()

  • Signature: static public function isNmToken($val)
  • Parameters:
    • $val

isTokenDigit()

  • Signature: static public function isTokenDigit($val)
  • Parameters:
    • $val

isTokenLetter()

  • Signature: static public function isTokenLetter($val)
  • Parameters:
    • $val

isTokenName()

  • Signature: static public function isTokenName($val)
  • Parameters:
    • $val

setupTokenRegexps()

  • Signature: protected function setupTokenRegexps()

stripCurrency()

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

  • Signature: static public function stripCurrency($data)
  • Parameters:
  • Returns: number