Docs For Class BankAccountField

Description

Field for displaying bank account numbers. It separates the bank, branch, account-number and account-suffix.

Located in /sapphire/forms/BankAccountField.php (line 7)

Object
   |
   --ViewableData
      |
      --RequestHandlingData
         |
         --FormField
            |
            --BankAccountField

Variable Summary

mixed $bankCode

mixed $branchCode

mixed $isRequired

mixed $requiredFields

array $valueArr

Method Summary

static array convert_format_nz ($value $value)

static boolean is_valid_array_structure (array $arr)

static string join_bank_number (mixed $value)

BankAccountField __construct ( $name, $title, [ $value = null], [ $bankCode = null], [ $branchCode = null], [ $form = null])

void Field ()

string getAccountNumber ()

string getAccountSuffix ()

string getBankCode ()

string getBranchCode ()

void jsValidation ()

void setValue ( $value)

void validate ( $validator)

Variables

mixed $bankCode (line 9)

access: protected

mixed $branchCode (line 10)

access: protected

mixed $isRequired = false (line 21)

HACK Proper requiring of compositefields would involve serious restructuring.

access: public

mixed $requiredFields = array(
"BankCode",
"BranchCode",
"AccountNumber",
) (line 22)

access: public

array $valueArr = array() (line 16)

var: Stores value in associative array-format, with: BankCode, BranchCode, AccountNumber, AccountSuffix
access: protected

Inherited Variables

Inherited from FormField

FormField::$containerFieldSet
FormField::$description
FormField::$disabled
FormField::$dontEscape
FormField::$extraClass
FormField::$extraClasses
FormField::$form
FormField::$leftTitle
FormField::$message
FormField::$messageType
FormField::$name
FormField::$readonly
FormField::$rightTitle
FormField::$tabIndex
FormField::$title
FormField::$value

Inherited from RequestHandlingData

RequestHandlingData::$allowed_actions
RequestHandlingData::$request
RequestHandlingData::$url_handlers

Inherited from ViewableData

ViewableData::$casting
ViewableData::$castingHelperPair_cache
ViewableData::$customisedObj
ViewableData::$failover
ViewableData::$iteratorPos
ViewableData::$iteratorTotalItems
ViewableData::$namedAs
ViewableData::$parent
ViewableData::$_natural_cache
ViewableData::$_object_cache
ViewableData::$_xml_cache

Inherited from Object

Object::$builtInMethods
Object::$class
Object::$classConstructed
Object::$extensions
Object::$extension_instances
Object::$extraMethods
Object::$extraStatics
Object::$statics
Object::$static_cached

Methods

static method convert_format_nz (line 227)

Convert from old format (2-4-7-2) to new format (2-4-8-3).

static array convert_format_nz ($value $value)

$value $value: array BankCode, BranchCode, AccountNumber, AccountSuffix

static method is_valid_array_structure (line 80)

Checks for a valid array structure.

access: protected

static boolean is_valid_array_structure (array $arr)

array $arr

static method join_bank_number (line 125)

Makes sure the number is a string with spaces instead of hyphens, and adjusts to new format (2-4-8-3) by using conver_format_nz().

access: public

static string join_bank_number (mixed $value)

mixed $value: String- or Array-representation of full bank-account-number.

Constructor __construct (line 28)

access: public

BankAccountField __construct ( $name, $title, [ $value = null], [ $bankCode = null], [ $branchCode = null], [ $form = null])

$name
$title
$value
$bankCode
$branchCode
$form

Redefinition of:

FormField::__construct(): Create a new field.

Field (line 39)

access: public

void Field ()

Redefinition of:

FormField::Field(): Returns the form field - used by templates.

getAccountNumber (line 107)

string getAccountNumber ()

getAccountSuffix (line 114)

string getAccountSuffix ()

getBankCode (line 93)

string getBankCode ()

getBranchCode (line 100)

string getBranchCode ()

jsValidation (line 149)

todo: Very basic validation at the moment

void jsValidation ()

Redefinition of:

FormField::jsValidation(): javascript handler Functions for each field type by default formfield doesnt have a validation function

setValue (line 61)

access: public

void setValue ( $value)

$value

Redefinition of:

FormField::setValue(): Set the field value.

validate (line 202)

todo: Very basic validation at the moment

void validate ( $validator)

$validator

Redefinition of:

FormField::validate(): Validation Functions for each field type by default formfield doesnt have a validation function

Inherited Methods

Inherited From FormField

FormField::__construct()
FormField::addExtraClass()
FormField::attrName()
FormField::attrTitle()
FormField::attrValue()
FormField::createTag()
FormField::dataValue()
FormField::debug()
FormField::describe()
FormField::extraClass()
FormField::Field()
FormField::FieldHolder()
FormField::forTemplate()
FormField::getForm()
FormField::getTabIndex()
FormField::getTabIndexHTML()
FormField::hasClass()
FormField::hasData()
FormField::id()
FormField::isComposite()
FormField::isDisabled()
FormField::isReadonly()
FormField::jsValidation()
FormField::LeftTitle()
FormField::Link()
FormField::Message()
FormField::MessageType()
FormField::Name()
FormField::name_to_label()
FormField::performDisabledTransformation()
FormField::performReadonlyTransformation()
FormField::removeExtraClass()
FormField::Required()
FormField::RightTitle()
FormField::rootFieldSet()
FormField::saveInto()
FormField::setContainerFieldSet()
FormField::setDisabled()
FormField::setError()
FormField::setForm()
FormField::setLeftTitle()
FormField::setName()
FormField::setReadonly()
FormField::setRightTitle()
FormField::setTabIndex()
FormField::setTitle()
FormField::setValue()
FormField::SmallFieldHolder()
FormField::Title()
FormField::transform()
FormField::Type()
FormField::validate()
FormField::Value()

Inherited From RequestHandlingData

RequestHandlingData::checkAccessAction()
RequestHandlingData::getRequest()
RequestHandlingData::handleRequest()
RequestHandlingData::httpError()

Inherited From ViewableData

ViewableData::ATT_val()
ViewableData::BaseHref()
ViewableData::buildCastingHelperCache()
ViewableData::cachedCall()
ViewableData::castingHelper()
ViewableData::castingHelperPair()
ViewableData::castingObjectCreator()
ViewableData::castingObjectCreatorPair()
ViewableData::CSSClasses()
ViewableData::CurrentMember()
ViewableData::CurrentPage()
ViewableData::customise()
ViewableData::Debug()
ViewableData::defineMethods()
ViewableData::escapeTypeForField()
ViewableData::Even()
ViewableData::EvenOdd()
ViewableData::First()
ViewableData::FirstLast()
ViewableData::getField()
ViewableData::getIterator()
ViewableData::getXMLValues()
ViewableData::hasField()
ViewableData::HasPerm()
ViewableData::hasValue()
ViewableData::i18nLocale()
ViewableData::IsAjax()
ViewableData::iteratorProperties()
ViewableData::JS_val()
ViewableData::Last()
ViewableData::Me()
ViewableData::Middle()
ViewableData::MiddleString()
ViewableData::obj()
ViewableData::Odd()
ViewableData::Pos()
ViewableData::RAW_val()
ViewableData::renderWith()
ViewableData::SecurityID()
ViewableData::setCustomisedObj()
ViewableData::setField()
ViewableData::SQL_val()
ViewableData::ThemeDir()
ViewableData::Top()
ViewableData::TotalItems()
ViewableData::val()
ViewableData::XML_val()
ViewableData::__get()
ViewableData::__isset()
ViewableData::__set()

Inherited From Object

Object::__construct()
Object::addMethodsFrom()
Object::addStaticVars()
Object::addWrapperMethod()
Object::add_extension()
Object::allMethodNames()
Object::buildMethodList()
Object::cacheToFile()
Object::cacheToFileWithArgs()
Object::create()
Object::createMethod()
Object::defineMethods()
Object::exists()
Object::extend()
Object::extInstance()
Object::getCustomClass()
Object::hasExtension()
Object::hasMethod()
Object::invokeWithExtensions()
Object::is_a()
Object::loadCache()
Object::parentClass()
Object::sanitiseCachename()
Object::saveCache()
Object::set_stat()
Object::set_uninherited()
Object::stat()
Object::strong_create()
Object::uninherited()
Object::useCustomClass()
Object::__call()
Object::__toString()