abstract class UcAddressesUcFieldHandler in Ubercart Addresses 6.2

Base class for Ubercart core address fields

Hierarchy

• class \UcAddressesFieldHandler
  • class \UcAddressesUcFieldHandler

1 string reference to 'UcAddressesUcFieldHandler'

uc_addresses_uc_addresses_field_handlers in ./uc_addresses.uc_addresses_fields.inc

Implementation of hook_uc_addresses_field_handlers().

File

handlers/ubercart.handlers.inc, line 12

Field handlers for Ubercart core address fields: first_name, last_name, company, etc.

abstract class UcAddressesUcFieldHandler extends UcAddressesFieldHandler {

  /**
   * Overrides UcAddressesFieldHandler::getFieldTitle().
   *
   * Returns the title to use when displaying the field.
   */
  public function getFieldTitle() {
    return uc_get_field_name($this
      ->getFieldName());
  }

  /**
   * Implements UcAddressesFieldHandler::isFieldEnabled().
   */
  public function isFieldEnabled() {
    return uc_address_field_enabled($this
      ->getFieldName());
  }

  /**
   * Implements UcAddressesFieldHandler::isFieldRequired().
   */
  public function isFieldRequired() {
    if ($this
      ->getContext() == 'order_form') {
      return FALSE;
    }
    return uc_address_field_required($this
      ->getFieldName());
  }

}

Members

Name	Modifiers	Type	Description	Overrides
UcAddressesFieldHandler::$address	private	property	Address object.
UcAddressesFieldHandler::$context	private	property	The context in which this field is used.
UcAddressesFieldHandler::$definition	private	property	The declared field definition.
UcAddressesFieldHandler::$name	private	property	Name of this field.
UcAddressesFieldHandler::checkContext	public	function	Checks if the field passes the context.	1
UcAddressesFieldHandler::getAddress	final public	function	Returns the address attached to this field.
UcAddressesFieldHandler::getContext	final public	function	Returns the context in which this field is used.
UcAddressesFieldHandler::getDefaultValue	public	function	Returns a default value for this field.	3
UcAddressesFieldHandler::getFieldName	final public	function	Returns the field name.
UcAddressesFieldHandler::getFormField	abstract public	function	Returns the editable field.	10
UcAddressesFieldHandler::getOutputFormats	public	function	Returns an array of possible output formats the handler supports.	3
UcAddressesFieldHandler::getProperty	final public	function	Returns a property from the field definition.
UcAddressesFieldHandler::init	protected	function	Can be used by subclasses to do some initialization upon construction of the object.	2
UcAddressesFieldHandler::outputValue	public	function	Output a field's value.	3
UcAddressesFieldHandler::setValue	public	function	Sets value in the address object.
UcAddressesFieldHandler::validateValue	public	function	Check a fields' value.	2
UcAddressesFieldHandler::__construct	final public	function	UcAddressesFormField object constructor.
UcAddressesUcFieldHandler::getFieldTitle	public	function	Overrides UcAddressesFieldHandler::getFieldTitle(). Overrides UcAddressesFieldHandler::getFieldTitle
UcAddressesUcFieldHandler::isFieldEnabled	public	function	Implements UcAddressesFieldHandler::isFieldEnabled(). Overrides UcAddressesFieldHandler::isFieldEnabled
UcAddressesUcFieldHandler::isFieldRequired	public	function	Implements UcAddressesFieldHandler::isFieldRequired(). Overrides UcAddressesFieldHandler::isFieldRequired