You are here

Home » API reference » Flexiform 7 » property.element.inc

class FlexiformElementEntityProperty in Flexiform 7

Class to add an element for entity properties.

Hierarchy

Expanded class hierarchy of FlexiformElementEntityProperty

1 string reference to 'FlexiformElementEntityProperty'
flexiform_flexiform_element_info in ./flexiform.flexiform.inc
Implements hook_flexiform_element_info().

File

includes/element/property.element.inc, line 10
Contains class for the entity property elements.

View source 
class FlexiformElementEntityProperty extends FlexiformElement {

  /**
   * @var string
   * Property Name.
   */
  protected $property;

  /**
   * @var array $propertyInfo
   * The property info.
   */
  protected $propertyInfo;

  /**
   * @var string $dataType
   * The data type of the info.
   */
  protected $dataType;

  /**
   * @var bool $isList
   * Is this property a list.
   */
  protected $isList = FALSE;

  /**
   * Overrides FlexiformElement::__construct().
   */
  public function __construct($flexiform, $settings, $element_namespace = '') {
    parent::__construct($flexiform, $settings, $element_namespace);
    $this->property = $this->element_info['property'];
    $this->propertyInfo = $this
      ->wrapper()
      ->getPropertyInfo($this->property);
    $this->dataType = $this->propertyInfo['type'];
    if ($list_type = entity_property_list_extract_type($this->dataType)) {
      $this->dataType = $list_type;
      $this->isList = TRUE;
    }
  }

  /**
   * Return the wrapper for the entity.
   */
  public function wrapper($entity = NULL) {
    return entity_metadata_wrapper($this->entity_type, $entity, array(
      'bundle' => $this->bundle,
    ));
  }

  /**
   * Return the property wrapper.
   */
  public function property($entity) {
    return entity_metadata_wrapper($this->entity_type, $entity)
      ->get($this->property);
  }

  /**
   * Return the form element for this FlexiformElement.
   */
  public function form($form, &$form_state, $entity, $language = LANGUAGE_NONE) {
    $parents = $form['#parents'];
    $parents[] = $this->property;

    // Get the value.
    $value = $this
      ->wrapper($entity)
      ->get($this->property)
      ->value();

    // If there is no value work out the default.
    if (empty($value)) {
      $value = '';
      if (isset($this->settings['default_value']['default_value'])) {
        $value = $this->settings['default_value']['default_value'];
      }
      if (!empty($this->settings['default_value']['use_tokens'])) {
        $value = $this
          ->replaceCtoolsSubstitutions($value, $form['#flexiform_entities']);
      }
    }
    else {
      if (entity_get_info($this->dataType)) {
        $value = entity_id($this->dataType, $value);
      }
    }
    $form[$this->element_namespace] = array(
      '#type' => 'textfield',
      '#parents' => $parents,
      '#title' => $this
        ->label(),
      '#required' => !empty($this->settings['required']),
      '#default_value' => $value,
      '#maxlength' => 255,
    );

    // If the property specifies an options list then use it.
    if ($options = $this
      ->property($entity)
      ->optionsList()) {

      // Pick the list widget.
      $widget = 'select';
      if (!empty($this->settings['options']['widget'])) {
        $widget = $this->settings['options']['widget'];
      }
      $form[$this->element_namespace]['#type'] = $widget;
      if ($widget == 'select') {
        $form[$this->element_namespace]['#empty_option'] = t('- Select -');
      }
      $form[$this->element_namespace]['#options'] = $options;
      unset($form[$this->element_namespace]['#maxlength']);
      if ($this->isList) {
        $form[$this->element_namespace]['#multiple'] = TRUE;
        if ($widget == 'radios') {
          $form[$this->element_namespace]['#type'] = 'checkboxes';
        }
      }
    }
    $form = parent::form($form, $form_state, $entity);
    return $form;
  }

  /**
   * Validate the form element.
   */
  public function formValidate($form, &$form_state, $entity, $language = LANGUAGE_NONE) {
    $value = $this
      ->formExtractValues($form, $form_state, $entity);
    if (!$this
      ->wrapper($entity)
      ->get($this->property)
      ->validate($value)) {
      form_error($form[$this->element_namespace], t('Invalid value given for !label', array(
        '!label' => $this
          ->label(),
      )));
    }
  }

  /**
   * Submit the form element.
   */
  public function formSubmit($form, &$form_state, $entity, $language = LANGUAGE_NONE) {
    $value = $this
      ->formExtractValues($form, $form_state, $entity);
    $this
      ->wrapper($entity)
      ->get($this->property)
      ->set($value);
  }

  /**
   * Extract the submitted values for this form element.
   */
  public function formExtractValues($form, &$form_state, $entity) {
    $parents = $form['#parents'];
    $parents[] = $this
      ->getEntityNamespace();
    $parents[] = $this->property;
    $value = drupal_array_get_nested_value($form_state['values'], $parents);
    return $value;
  }

  /**
   * {@inheritdoc}
   */
  public function configureForm($form, &$form_state, $flexiform) {
    $form = parent::configureForm($form, $form_state, $flexiform);
    $form['required'] = array(
      '#type' => 'checkbox',
      '#title' => t('Required'),
      '#default_value' => !empty($this->settings['required']),
      '#weight' => -6,
    );
    $form['default_value'] = array(
      '#tree' => TRUE,
      '#type' => 'fieldset',
      '#title' => t('Default Value'),
      '#weight' => -5,
    );
    $form['default_value']['default_value'] = array(
      '#type' => 'textfield',
      '#title' => $this
        ->label() ? $this
        ->label() : t('Default'),
      '#default_value' => isset($this->settings['default_value']['default_value']) ? $this->settings['default_value']['default_value'] : '',
      '#maxlength' => 255,
    );
    $form['default_value']['use_tokens'] = array(
      '#type' => 'checkbox',
      '#title' => t('Use Tokens in Default Value'),
      '#default_value' => !empty($this->settings['default_value']['use_tokens']),
    );
    $form['default_value']['contexts'] = array(
      '#title' => t('Substitutions'),
      '#type' => 'fieldset',
      '#collapsible' => TRUE,
      '#collapsed' => TRUE,
    );
    $form['default_value']['contexts']['contexts'] = $this
      ->getCtoolsSubstitutionsList();

    // Options for handling options.
    if (!empty($this->propertyInfo['options list'])) {
      $form['options'] = array(
        '#tree' => TRUE,
        '#type' => 'fieldset',
        '#title' => t('Value Selection'),
      );
      $form['options']['widget'] = array(
        '#type' => 'select',
        '#title' => t('Widget'),
        '#description' => t('What sort of widget to you want to use?'),
        '#options' => array(
          'select' => t('Select'),
          'radios' => t('Radios/Checkboxes'),
        ),
        '#default_value' => !empty($this->settings['options']['widget']) ? $this->settings['options']['widget'] : 'select',
      );
    }
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function configureFormSubmit($form, &$form_state, $flexiform) {
    $this->settings['required'] = !empty($form_state['values']['required']);
    $this->settings['default_value']['default_value'] = $form_state['values']['default_value']['default_value'];
    $this->settings['default_value']['use_tokens'] = $form_state['values']['default_value']['use_tokens'];
    if (!empty($form_state['values']['options'])) {
      $this->settings['options']['widget'] = $form_state['values']['options']['widget'];
    }
    parent::configureFormSubmit($form, $form_state, $flexiform);
  }

}

Members

Namesort descending Modifiers Type Description Overrides
FlexiformElement::$bundle protected property The bundle this is on.
FlexiformElement::$element_namespace protected property The namespace of this element.
FlexiformElement::$entity_namespace protected property The entity namespace of the entity this element is acting on.
FlexiformElement::$entity_type protected property The entity type this field is on.
FlexiformElement::$flexiform protected property The flexiform entity this element is one.
FlexiformElement::$settings protected property The settings for this element.
FlexiformElement::$weight protected property The weight of this element.
FlexiformElement::configureFormValidate public function Validate the configure form for the element. 3
FlexiformElement::createElement public static function Create an element object.
FlexiformElement::formIsEmpty public function Work out if the submitted value constitutes empty. 1
FlexiformElement::getCtoolsContexts public function Get an array of ctools context for the flexiform.
FlexiformElement::getCtoolsSubstitutionsList public function Build a list of possible ctools substitutions.
FlexiformElement::getElement public static function Get an element object.
FlexiformElement::getElementNamespace public function Get the element namespace for this form element.
FlexiformElement::getEntityNamespace public function Get the entity namespace for this form element.
FlexiformElement::getEntityType public function Get the entity type for this element.
FlexiformElement::getSettings public function Get the settings.
FlexiformElement::getWeight public function Get the weight of this form element.
FlexiformElement::label public function Get the label for this form element. 2
FlexiformElement::makeElementNamespace public function Make namespace for the element. 1
FlexiformElement::name public function Get the name for this form element.
FlexiformElement::removeForm public function Build the remove form for the element.
FlexiformElement::removeFormSubmit public function Submit the remove form for the element.
FlexiformElement::removeFormValidate public function Validate the remove form for the element.
FlexiformElement::replaceCtoolsSubstitutions public function Replace ctools substitutions with their values.
FlexiformElement::setLabel public function Set the label for this form element. 1
FlexiformElement::setWeight public function Set the weight of this form element. 1
FlexiformElement::toSettingsArray public function Convert this object into a settings array. 5
FlexiformElement::type public function Get the type of this form element. 3
FlexiformElementEntityProperty::$dataType protected property The data type of the info.
FlexiformElementEntityProperty::$isList protected property Is this property a list.
FlexiformElementEntityProperty::$property protected property Property Name.
FlexiformElementEntityProperty::$propertyInfo protected property The property info.
FlexiformElementEntityProperty::configureForm public function Build the configure form for the element. Overrides FlexiformElement::configureForm
FlexiformElementEntityProperty::configureFormSubmit public function Submit the configure form for the element. Overrides FlexiformElement::configureFormSubmit
FlexiformElementEntityProperty::form public function Return the form element for this FlexiformElement. Overrides FlexiformElement::form 1
FlexiformElementEntityProperty::formExtractValues public function Extract the submitted values for this form element. Overrides FlexiformElement::formExtractValues 1
FlexiformElementEntityProperty::formSubmit public function Submit the form element. Overrides FlexiformElement::formSubmit
FlexiformElementEntityProperty::formValidate public function Validate the form element. Overrides FlexiformElement::formValidate
FlexiformElementEntityProperty::property public function Return the property wrapper.
FlexiformElementEntityProperty::wrapper public function Return the wrapper for the entity.
FlexiformElementEntityProperty::__construct public function Overrides FlexiformElement::__construct(). Overrides FlexiformElement::__construct