class UcAddressesTestTextFieldHandler in Ubercart Addresses 6.2

Handler for a text field used by the uc_addresses_test module.

This handler extends the handler for a simple text field and adds a check for the field's address type.

Hierarchy

• class \UcAddressesFieldHandler
  • class \UcAddressesTextFieldHandler
    • class \UcAddressesTestTextFieldHandler

2 string references to 'UcAddressesTestTextFieldHandler'

uc_addresses_test_uc_addresses_fields in tests/uc_addresses_test.module

Implements hook_uc_addresses_fields().

uc_addresses_test_uc_addresses_field_handlers in tests/uc_addresses_test.module

Implements hook_uc_addresses_field_handlers().

File

tests/handlers/uc_addresses.handlers.inc, line 14

Contains UcAddressesTextFieldHandler class.

class UcAddressesTestTextFieldHandler extends UcAddressesTextFieldHandler {

  /**
   * Checks if field passes the context.
   *
   * @access public
   * @return boolean
   *   TRUE if the field may be used in the given context.
   *   FALSE otherwise.
   */
  public function checkContext() {
    if (parent::checkContext()) {
      $address = $this
        ->getAddress();
      if (!empty($address->address_type) && $address->address_type != $this
        ->getProperty('address_type')) {
        return FALSE;
      }
      return TRUE;
    }
    return FALSE;
  }

}

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::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::getFieldTitle	public	function	Returns the title to use when displaying a field.	1
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.
UcAddressesTestTextFieldHandler::checkContext	public	function	Checks if field passes the context. Overrides UcAddressesFieldHandler::checkContext
UcAddressesTextFieldHandler::getFormField	public	function	Implements UcAddressesFieldHandler::getFormField(). Overrides UcAddressesFieldHandler::getFormField
UcAddressesTextFieldHandler::isFieldEnabled	public	function	Implements UcAddressesFieldHandler::isFieldEnabled(). Overrides UcAddressesFieldHandler::isFieldEnabled
UcAddressesTextFieldHandler::isFieldRequired	public	function	Implements UcAddressesFieldHandler::isFieldRequired(). Overrides UcAddressesFieldHandler::isFieldRequired