class UCXF_CustomField in Extra Fields Checkout Pane 6.2

Class for a Extra Fields Pane Custom field.

Custom fields are shown on checkout and on the order administration pages in the extra information pane.

Hierarchy

• class \UCXF_Field
  • class \UCXF_CustomField

File

class/UCXF_CustomField.class.php, line 13

Contains the UCXF_CustomField class.

class UCXF_CustomField extends UCXF_Field {

  // -----------------------------------------------------------------------------
  // CONSTRUCT
  // -----------------------------------------------------------------------------

  /**
   * UCXF_CustomField object constructor
   * @access public
   * @return void
   */
  public function __construct() {
    parent::__construct();
    $this->returnpath = 'admin/store/settings/checkout/edit/extrafields';
  }

}

Members

Name	Modifiers	Type	Description	Overrides
UCXF_CustomField::__construct	public	function	UCXF_CustomField object constructor @access public Overrides UCXF_Field::__construct
UCXF_Field::$display_settings	private	property	An array of page names on which the field may be displayed @access private
UCXF_Field::$pane_types	private	property	An array of pane types the field is in. @access private
UCXF_Field::delete	public	function	Delete the field from the database. @access public
UCXF_Field::edit_form	public	function	Get the edit form for the field. @access public	1
UCXF_Field::edit_form_submit	public	function	Submit the edit form for the item.	1
UCXF_Field::edit_form_validate	public	function	Validate the edit form for the item.
UCXF_Field::from_array		function	Load an existing item from an array. @access public
UCXF_Field::generate	public	function	generate() Generates a field array used in forms generated by uc_extra_fields_pane @access public
UCXF_Field::generate_value	public	function	Generates the value for use in fields. This value will be used as a default value for textfields and as an array of options for selection fields.
UCXF_Field::get_example	public static	function	Returns an example for the value section
UCXF_Field::get_value_type	public	function	Returns the "readable" value type, as a string.
UCXF_Field::in_pane	public	function	Returns if field is in given pane
UCXF_Field::may_display	public	function	Returns if the field's value may be displayed on te given page.
UCXF_Field::output	public	function	Output a value with filtering
UCXF_Field::output_value	public	function	Output a value based on the field type
UCXF_Field::save	public	function	save() Saves field in database @access public
UCXF_Field::to_array	public	function	Return as an array of values. @access public
UCXF_Field::UCXF_WIDGET_TYPE_CHECKBOX		constant
UCXF_Field::UCXF_WIDGET_TYPE_CONSTANT		constant
UCXF_Field::UCXF_WIDGET_TYPE_PHP		constant
UCXF_Field::UCXF_WIDGET_TYPE_PHP_SELECT		constant
UCXF_Field::UCXF_WIDGET_TYPE_SELECT		constant
UCXF_Field::UCXF_WIDGET_TYPE_TEXTFIELD		constant
UCXF_Field::__get	public	function	Getter
UCXF_Field::__set	public	function	Setter