Inheritance diagram for oxInputValidator:

Collaboration diagram for oxInputValidator:

Public Member Functions
	__construct ()
	validateBasketAmount ($dAmount)
	validatePaymentInputData ($sPaymentId, &$aDynvalue)
	checkLogin ($oUser, $sLogin, $aInvAddress)
	checkEmail ($oUser, $sEmail)
	checkPassword ($oUser, $sNewPass, $sConfPass, $blCheckLenght=false)
	checkRequiredFields ($oUser, $aInvAddress, $aDelAddress)
	checkRequiredArrayFields ($oUser, $sFieldName, $aFieldValues)
	checkCountries ($oUser, $aInvAddress, $aDelAddress)
	checkVatId ($oUser, $aInvAddress)
	getFieldValidationErrors ()
	getFirstValidationError ()
Static Public Member Functions
static	getInstance ()
Protected Member Functions
	_addValidationError ($sFieldName, $oErr)
Protected Attributes
	$_aRequiredCCFields
	$_aInputValidationErrors = array()
	$_aPossibleCCType
	$_aRequiredDCFields
Static Private Attributes
static	$_instance = null

Detailed Description

Calss for validating input

Definition at line 7 of file oxinputvalidator.php.

Constructor & Destructor Documentation

oxInputValidator.__construct ( )

Class constructor. The constructor is defined in order to be possible to call parent.__construct() in modules.

Returns:: null;

Reimplemented from oxSuperCfg.

Definition at line 68 of file oxinputvalidator.php.

Member Function Documentation

oxInputValidator._addValidationError	(	$	sFieldName,
		$	oErr
	)			`[protected]`

Used to collect user validation errors. This method is called from all of the input checking functionality to report found error.

Parameters:

	string	$sFieldName field name
	exception	$oErr exception

Returns:: exception

Definition at line 190 of file oxinputvalidator.php.

oxInputValidator.checkCountries	(	$	oUser,
		$	aInvAddress,
		$	aDelAddress
	)

Checks if user defined countries (billing and delivery) are active

Parameters:

	oxuser	$oUser active user
	array	$aInvAddress billing address info
	array	$aDelAddress delivery address info

Returns:: null

Definition at line 401 of file oxinputvalidator.php.

oxInputValidator.checkEmail	(	$	oUser,
		$	sEmail
	)

Checks if email (used as login) is not empty and is valid.

Parameters:

	oxuser	$oUser active user
	string	$sEmail user email/login

Returns:: null

Definition at line 255 of file oxinputvalidator.php.

oxInputValidator.checkLogin	(	$	oUser,
		$	sLogin,
		$	aInvAddress
	)

Checks if user name does not break logics:

if user wants to UPDATE his login name, performing check if user entered correct password
additionally checking for user name dublicates. This is usually needed when creating new users. On any error exception is thrown.

Parameters:

	oxuser	$oUser active user
	string	$sLogin user preferred login name
	array	$aInvAddress user information

Returns:: string login name

Definition at line 209 of file oxinputvalidator.php.

oxInputValidator.checkPassword	(	$	oUser,
		$	sNewPass,
		$	sConfPass,
		$	blCheckLenght = `false`
	)

Checking if user password is fine. In case of error exception is thrown

Parameters:

	oxuser	$oUser active user
	string	$sNewPass new user password
	string	$sConfPass retyped user password
	bool	$blCheckLenght option to check password lenght

Returns:: null

Definition at line 285 of file oxinputvalidator.php.

oxInputValidator.checkRequiredArrayFields	(	$	oUser,
		$	sFieldName,
		$	aFieldValues
	)

Checks if all values are filled up

Parameters:

	oxuser	$oUser active user
	string	$sFieldName checking field name
	array	$aFieldValues field values

Returns:: null

Definition at line 380 of file oxinputvalidator.php.

oxInputValidator.checkRequiredFields	(	$	oUser,
		$	aInvAddress,
		$	aDelAddress
	)

Checking if all required fields were filled. In case of error exception is thrown

Parameters:

	oxuser	$oUser active user
	array	$aInvAddress billing address
	array	$aDelAddress delivery address

Returns:: null

Definition at line 322 of file oxinputvalidator.php.

oxInputValidator.checkVatId	(	$	oUser,
		$	aInvAddress
	)

Checks if user passed VAT id is valid. Exception is thrown if id is not valid

Parameters:

	oxuser	$oUser active user
	array	$aInvAddress user input array

Returns:: null

Definition at line 435 of file oxinputvalidator.php.

oxInputValidator.getFieldValidationErrors ( )

Returns error array if input validation for current field and rule reported an error

Returns:: array

Definition at line 462 of file oxinputvalidator.php.

oxInputValidator.getFirstValidationError ( )

Returns first user input validation error

Returns:: exception

Definition at line 472 of file oxinputvalidator.php.

static oxInputValidator.getInstance ( ) [static]

Returns oxInputValidator instance

Deprecated:: since v5.0 (2012-08-10); Use oxRegistry.get("oxInputValidator") instead

Returns:: oxInputValidator

Definition at line 79 of file oxinputvalidator.php.

oxInputValidator.validateBasketAmount ( $ dAmount )

Validates basket amount

Parameters:

float

$dAmount amount of article

Exceptions:

oxArticleInputException

if amount is not numeric or smaller 0

Returns:: float

Definition at line 93 of file oxinputvalidator.php.

oxInputValidator.validatePaymentInputData	(	$	sPaymentId,
		&$	aDynvalue
	)

Validates payment input data for credit card and debit note

Parameters:

	string	$sPaymentId the payment id of current payment
	array	&$aDynvalue values of payment

Returns:: bool

Definition at line 121 of file oxinputvalidator.php.

Member Data Documentation

oxInputValidator.$_aInputValidationErrors = array() [protected]

Definition at line 34 of file oxinputvalidator.php.

oxInputValidator.$_aPossibleCCType [protected]

Initial value:

 array( 'mcd', 
                                         'vis', 
                                         'amx', 
                                         'dsc', 
                                         'dnc', 
                                         'jcb', 
                                         'swi', 
                                         'dlt', 
                                         'enr'  
                                        )

Definition at line 41 of file oxinputvalidator.php.

oxInputValidator.$_aRequiredCCFields [protected]

Initial value:

 array( 'kktype',
                                           'kknumber',
                                           'kkmonth',
                                           'kkyear',
                                           'kkname',
                                           'kkpruef'
                                          )

Definition at line 21 of file oxinputvalidator.php.

oxInputValidator.$_aRequiredDCFields [protected]

Initial value:

 array( 'lsbankname',
                                           'lsblz',
                                           'lsktonr',
                                           'lsktoinhaber'
                                         )

Definition at line 57 of file oxinputvalidator.php.

oxInputValidator.$_instance = null [static, private]

Definition at line 14 of file oxinputvalidator.php.

The documentation for this class was generated from the following file:

core/oxinputvalidator.php

oxInputValidator Class Reference

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Static Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation