Class waContactCompositeField

This file is part of Webasyst framework.

Licensed under the terms of the GNU Lesser General Public License (LGPL). http://www.webasyst.com/framework/license/

waContactCompositeField

Direct known subclasses

Package: wa-system\Contact
Copyright: 2011 Webasyst LLC
License: LGPL
Author: Webasyst LLC
Link: http://www.webasyst.com/
Located at wa-system/contact/waContactCompositeField.class.php

Methods summary
`protected`	# `init( )` Overrides `waContactField::init()`
`public`	# `getInfo( )` Overrides `waContactField::getInfo()`
`public`	# `get( waContact $contact, mixed $format = null )` Overrides `waContactField::get()`
`public array\|string\|null`	# `validate( mixed $data, integer $contact_id = null )` Validate field value and returns errors or null if value is valud Validate field value and returns errors or null if value is valud Parameters `$data` `mixed` $data `$contact_id` `integer` $contact_id Returns `array\|string\|null` Overrides `waContactField::validate()`
`public`	# `format( mixed $data, mixed $format = null )` Overrides `waContactField::format()`
`public array`	# `getField( boolean $with_parent_id = true )` Parameters `$with_parent_id` `boolean` $with_parent_id Returns `array` Overrides `waContactField::getField()`
`public array`	# `set( waContact $contact, mixed $value, array $params = array(), boolean $add = false )` Prepare value to be stored in DB. Data returned will be validated and later passed to $this->getStorage()->set(). For non-multi fields return string or array(value=>string, ext=>string). For multi fields return list of arrays(value=>string, ext=>string); ext is optional, see $this->isExt() Prepare value to be stored in DB. Data returned will be validated and later passed to $this->getStorage()->set(). For non-multi fields return string or array(value=>string, ext=>string). For multi fields return list of arrays(value=>string, ext=>string); ext is optional, see $this->isExt() Parameters `$contact` `waContact` $contact `$value` `mixed` $value can be a string, an array(value=>..., ext=>...) or list of these. `$params` `array` $params `$add` `boolean` $add Returns `array` Overrides `waContactField::set()`
`protected mixed`	# `setValue( mixed $value )` Helper for $this->set() to format value of a field before inserting into DB (actually even before validation, so beware). Helper for $this->set() to format value of a field before inserting into DB (actually even before validation, so beware). $value is a single value passed to waContact['field_id'] via assignment. No extension, just the value, e.g.: 'a@b.com', not array('value' => 'a@b.com', 'ext' => 'work'). Note that for composite fields this behaves a little differently, see waContactCompositeField. Parameters `$value` `mixed` $value Returns `mixed` possibly changed $value Overrides `waContactField::setValue()`
`public array\|waContactField`	# `getFields( string $subfield_name = null )` Parameters `$subfield_name` `string` $subfield_name Returns `array\|waContactField`
`public`	# `prepareVarExport( )` Overrides `waContactField::prepareVarExport()`
`public`	# `setParameter( mixed $p, mixed $value )` Set the value of option $p. Used by a Field Constructor editor to change field parameters. Set the value of option $p. Used by a Field Constructor editor to change field parameters. localized_names = array(locale => name) required = boolean unique = boolean Parameters `$p` `mixed` $p string parameter to set `$value` `mixed` $value mixed value to set Overrides `waContactField::setParameter()`
`public`	# `getHtmlOne( mixed $params = array(), mixed $attrs = '' )` Overrides `waContactField::getHtmlOne()`
`public`	# `getHtmlOneWithErrors( mixed $errors, mixed $params = array(), mixed $attrs = '' )` Overrides `waContactField::getHtmlOneWithErrors()`

Methods inherited from waContactField
`__construct(), __set_state(), getFormatter(), getHTML(), getHTMLName(), getId(), getName(), getParameter(), getParameters(), getStorage(), getType(), getValidator(), isExt(), isMulti(), isRequired(), isUnique(), prepareSave(), setParameters(), validateUnique()`

Properties inherited from waContactField
`$_type, $id, $name, $options`

Packages

Classes

Class waContactCompositeField

Direct known subclasses

Overrides

Overrides

Overrides

Parameters

Returns

Overrides

Overrides

Parameters

Returns

Overrides

Parameters

Returns

Overrides

Parameters

Returns

Overrides

Parameters

Returns

Overrides

Parameters

Overrides

Overrides

Overrides