class editableviews_handler_field_entity_metadata_property in Editable Views 7

Field handler for editing an entity metadata property.

This allows editing of Entity API metadata properties, as defined in hook_entity_property_info(). To qualify, an entity property must have its 'setter callback' info property defined.

Hierarchy

class \views_object
- class \views_handler
  - class \views_handler_field
    class \editableviews_handler_field_entity_metadata_property

Expanded class hierarchy of editableviews_handler_field_entity_metadata_property

1 string reference to 'editableviews_handler_field_entity_metadata_property'

editableviews_views_data_alter in ./editableviews.views.inc: Implements hook_views_data_alter().

File

handlers/editableviews_handler_field_entity_metadata_property.inc, line 10

View source

class editableviews_handler_field_entity_metadata_property extends views_handler_field {

  /**
   * Boolean to indicate to the style plugin that this field is editable.
   */
  public $editable = TRUE;
  function option_definition() {
    $options = parent::option_definition();
    $options['property'] = array(
      'default' => NULL,
    );
    $options['form_use_label'] = array(
      'default' => FALSE,
    );
    $options['reverse_boolean'] = array(
      'default' => FALSE,
    );
    return $options;
  }
  function options_form(&$form, &$form_state) {
    parent::options_form($form, $form_state);
    $table_data = views_fetch_data($this->table);
    $entity_info = entity_get_info($table_data['table']['entity type']);
    $entity_property_info = entity_get_property_info($table_data['table']['entity type']);

    // Create an array of grouped options.
    $options = array();

    // Common properties.
    $label_common = t('Common');
    $options[$label_common] = array();
    if (isset($entity_info['entity keys']['bundle'])) {

      // Entity API makes the bundle entity key settable, presumably for
      // creating new entities. That's really not going to fly here.
      // (No need to check it exists before we attempt to unset it.)
      unset($entity_property_info['properties'][$entity_info['entity keys']['bundle']]);
    }
    foreach ($entity_property_info['properties'] as $property_name => $property_info) {
      if (empty($property_info['setter callback'])) {

        // We can't do anything with a property that has no information about
        // how to set it.
        continue;
      }
      if (!empty($property_info['field'])) {

        // FieldAPI fields have their own handler that does a far better job
        // (with widgets, etc) than this can do.
        continue;
      }
      $options[$label_common][$property_name] = $property_info['label'];
    }

    // Bundle-specific properties.
    foreach ($entity_property_info['bundles'] as $bundle_name => $bundle_info) {
      $bundle_label = $entity_info['bundles'][$bundle_name]['label'];
      $options[$bundle_label] = array();
      foreach ($bundle_info['properties'] as $property_name => $property_info) {
        if (empty($property_info['setter callback'])) {

          // We can't do anything with a property that has no information about
          // how to set it.
          continue;
        }
        if (!empty($property_info['field'])) {

          // FieldAPI fields have their own handler that does a far better job
          // (with widgets, etc) than this can do.
          continue;
        }
        $options[$bundle_label][$property_name] = $property_info['label'];
      }
    }
    $form['property'] = array(
      '#type' => 'select',
      '#title' => t('Metadata property'),
      '#options' => $options,
      '#description' => t('Select the property to edit with this field. (Only properties that define how they may be set on an entity are available. Be sure to ensure the property applies to all entities the View will show.)'),
      '#default_value' => $this->options['property'],
      // Views AJAX magic which I don't pretend to understand, which allows a
      // dependent form element for 'reverse_boolean'.
      '#ajax' => array(
        'path' => views_ui_build_form_url($form_state),
      ),
      '#submit' => array(
        'views_ui_config_item_form_submit_temporary',
      ),
      '#executes_submit_callback' => TRUE,
    );
    $form['form_use_label'] = array(
      '#type' => 'checkbox',
      '#title' => t('Use handler label for form element'),
      '#description' => t('Use the label for this handler on the form element, rather than the label set in metadata properties which is not always suited to non-developer consumption.'),
      '#default_value' => $this->options['form_use_label'],
    );
    if ($this->options['property']) {
      $entity_all_property_info = entity_get_all_property_info($table_data['table']['entity type']);
      $selected_property_info = $entity_all_property_info[$this->options['property']];
      if ($selected_property_info['type'] == 'boolean') {
        $form['reverse_boolean'] = array(
          '#type' => 'checkbox',
          '#title' => t('Reverse checkbox value'),
          '#description' => t('Reverse the value of the boolean property in the checkbox. Use this for properties which make more sense to the user when inverted.'),
          '#default_value' => $this->options['reverse_boolean'],
        );
      }
    }
  }

  /**
   * Return the name of the entity property this handler controls.
   */
  function field_name() {
    return $this->options['property'];
  }

  /**
   * Render the field.
   *
   * Override this as otherwise we'd just output the entity ID all the time.
   *
   * @param $values
   *   The values retrieved from the database.
   */
  function render($values) {

    // Don't return anything. We don't know the entity we're on at this point.
    // TODO: split up insert_form_elements() to do all the joining up of data
    // before parent::render_fields() is called, and set the entity on the
    // handlers. This would allow us to output the value of the property here.
    return '';
  }

  /**
   * Add the edit form for the field.
   */
  function edit_form($entity_type, $entity, &$element, &$form_state) {

    // Something weird in Views admin UI causes us to come here (because the
    // style plugin gets rendered) without the options set on this handler. This
    // then causes an AJAX error because further down we access a metadata
    // wrapper with no property. I have no time to go chasing this right now, so
    // for now, just bail here if we're not properly set up. Doing this appears
    // to have no adverse or visible side effects.
    if (empty($this->options['property'])) {
      return;
    }
    $wrapper = entity_metadata_wrapper($entity_type, $entity);

    // Get the info for the property we are working with. We only need to get
    // this once.
    if (!isset($this->property_info)) {
      $this->property_info = $wrapper
        ->getPropertyInfo($this->options['property']);
    }
    if (isset($this->property_info['options list'])) {

      // Special case: if the property has an 'options list' defined, we can
      // show a select form element of options.
      $this
        ->edit_form_element_select($element, $form_state, $wrapper);
    }
    else {

      // The type of form element we add depends on the type of the property.
      // This is just a best guess.
      // TODO: add an option to override this?
      switch ($this->property_info['type']) {
        case 'boolean':
          $this
            ->edit_form_element_checkbox($element, $form_state, $wrapper);
          break;
        default:
          $this
            ->edit_form_element_textfield($element, $form_state, $wrapper);
          break;
      }
    }

    // Set the title property.
    if ($this->options['form_use_label']) {
      $element[$this->options['property']]['#title'] = $this->options['label'];
    }
    else {
      $element[$this->options['property']]['#title'] = check_plain($this->property_info['label']);
    }
  }

  /**
   * Create a textfield element.
   *
   * @param &$element
   *  The element to alter.
   * @param &$form_state
   *  The form state.
   * @param $wrapper
   *  The wrapper for the entity whose property is to be shown in the element.
   */
  function edit_form_element_textfield(&$element, &$form_state, $wrapper) {

    // Just do the same thing as node_content_form().
    $element[$this->options['property']] = array(
      '#type' => 'textfield',
      '#required' => !empty($this->property_info['required']),
      // The value might not be set in the case where we're on a non-required
      // relationship with empty data. TODO???
      '#default_value' => $wrapper->{$this->options['property']}
        ->raw(),
      //'#size' => $this->options['textfield_size'],
      '#maxlength' => 255,
    );
  }

  /**
   * Create a select element.
   *
   * @param &$element
   *  The element to alter.
   * @param &$form_state
   *  The form state.
   * @param $wrapper
   *  The wrapper for the entity whose property is to be shown in the element.
   */
  function edit_form_element_select(&$element, &$form_state, $wrapper) {

    // Just do the same thing as node_content_form().
    $element[$this->options['property']] = array(
      '#type' => 'select',
      '#required' => !empty($this->property_info['required']),
      '#options' => $wrapper->{$this->options['property']}
        ->optionsList(),
      // The value might not be set in the case where we're on a non-required
      // relationship with empty data. TODO???
      '#default_value' => $wrapper->{$this->options['property']}
        ->raw(),
    );
  }

  /**
   * Create a checkbox element.
   *
   * @param &$element
   *  The element to alter.
   * @param &$form_state
   *  The form state.
   * @param $wrapper
   *  The wrapper for the entity whose property is to be shown in the element.
   */
  function edit_form_element_checkbox(&$element, &$form_state, $wrapper) {
    $default_value = $wrapper->{$this->options['property']}
      ->raw();
    if ($this->options['reverse_boolean']) {
      $default_value = !$default_value;
    }
    $element[$this->options['property']] = array(
      '#type' => 'checkbox',
      '#required' => !empty($this->property_info['required']),
      // The value might not be set in the case where we're on a non-required
      // relationship with empty data. TODO???
      '#default_value' => $default_value,
    );
  }

  /**
   * Helper to get the value out of the form element.
   */
  function get_element_value($element, $form_state) {

    // The element's '#parents' property gets us nearly all the way there.
    $parents = $element['#parents'];
    $parents[] = $this->options['property'];
    $value = drupal_array_get_nested_value($form_state['values'], $parents);
    return $value;
  }

  /**
   * Handle the form validation for this field's form element.
   */
  function edit_form_validate($entity_type, $entity, &$element, &$form_state) {

    // Wrappers don't have a way of testing the waters to validate, but we can
    // attempt to set the property and catch an exception.
    try {

      // Get the value out of the form state.
      $value = $this
        ->get_element_value($element, $form_state);
      if ($this->options['reverse_boolean']) {
        $value = !$value;
      }

      // Set it on the wrapper, and stand back!
      $wrapper = entity_metadata_wrapper($entity_type, $entity);
      $wrapper->{$this->options['property']}
        ->set($value);
    } catch (EntityMetadataWrapperException $e) {

      // TODO: the exception message from Entity API is not that end-user-friendly.
      form_error($element[$this->options['property']], $e
        ->getMessage());
    }
  }

  /**
   * Handle the form submission for this field's form element.
   */
  function edit_form_submit($entity_type, $entity, &$element, &$form_state) {

    // Get the value out of the form state.
    $value = $this
      ->get_element_value($element, $form_state);
    if ($this->options['reverse_boolean']) {
      $value = !$value;
    }

    // We can set this on the wrapper with inpunity, as the validate step
    // already caught any exception this might throw.
    $wrapper = entity_metadata_wrapper($entity_type, $entity);
    $wrapper->{$this->options['property']}
      ->set($value);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
editableviews_handler_field_entity_metadata_property::$editable	public	property	Boolean to indicate to the style plugin that this field is editable.
editableviews_handler_field_entity_metadata_property::edit_form		function	Add the edit form for the field.
editableviews_handler_field_entity_metadata_property::edit_form_element_checkbox		function	Create a checkbox element.
editableviews_handler_field_entity_metadata_property::edit_form_element_select		function	Create a select element.
editableviews_handler_field_entity_metadata_property::edit_form_element_textfield		function	Create a textfield element.
editableviews_handler_field_entity_metadata_property::edit_form_submit		function	Handle the form submission for this field's form element.
editableviews_handler_field_entity_metadata_property::edit_form_validate		function	Handle the form validation for this field's form element.
editableviews_handler_field_entity_metadata_property::field_name		function	Return the name of the entity property this handler controls.
editableviews_handler_field_entity_metadata_property::get_element_value		function	Helper to get the value out of the form element.
editableviews_handler_field_entity_metadata_property::options_form		function	Default options form provides the label widget that all fields should have. Overrides views_handler_field::options_form
editableviews_handler_field_entity_metadata_property::option_definition		function	Information about options for all kinds of purposes will be held here. Overrides views_handler_field::option_definition
editableviews_handler_field_entity_metadata_property::render		function	Render the field. Overrides views_handler_field::render
views_handler::$handler_type	public	property	The type of the handler, for example filter/footer/field.
views_handler::$query	public	property	Where the $query object will reside:.	1
views_handler::$real_field	public	property	The actual field in the database table, maybe different on other kind of query plugins/special handlers.
views_handler::$relationship	public	property	The relationship used for this field.
views_handler::$table_alias	public	property	The alias of the table of this handler which is used in the query.
views_handler::$view	public	property	The top object of a view. Overrides views_object::$view
views_handler::accept_exposed_input	public	function	Take input from exposed handlers and assign to this handler, if necessary.	1
views_handler::access	public	function	Check whether current user has access to this handler.	10
views_handler::broken	public	function	Determine if the handler is considered 'broken'.	6
views_handler::can_expose	public	function	Determine if a handler can be exposed.	2
views_handler::case_transform	public	function	Transform a string by a certain method.
views_handler::ensure_my_table	public	function	Ensure the main table for this handler is in the query. This is used a lot.	8
views_handler::exposed_form	public	function	Render our chunk of the exposed handler form when selecting.	1
views_handler::exposed_info	public	function	Get information about the exposed form for the form renderer.	1
views_handler::exposed_submit	public	function	Submit the exposed handler form.
views_handler::exposed_validate	public	function	Validate the exposed handler form.	4
views_handler::expose_form	public	function	Form for exposed handler options.	2
views_handler::expose_options	public	function	Set new exposed option defaults when exposed setting is flipped on.	2
views_handler::expose_submit	public	function	Perform any necessary changes to the form exposes prior to storage. There is no need for this function to actually store the data.
views_handler::expose_validate	public	function	Validate the options form.	1
views_handler::extra_options	public	function	Provide defaults for the handler.
views_handler::extra_options_form	public	function	Provide a form for setting options.	1
views_handler::extra_options_submit	public	function	Perform any necessary changes to the form values prior to storage. There is no need for this function to actually store the data.
views_handler::extra_options_validate	public	function	Validate the options form.
views_handler::get_field	public	function	Shortcut to get a handler's raw field value.
views_handler::get_join	public	function	Get the join object that should be used for this handler.
views_handler::groupby_form	public	function	Provide a form for aggregation settings.	1
views_handler::groupby_form_submit	public	function	Perform any necessary changes to the form values prior to storage. There is no need for this function to actually store the data.	1
views_handler::has_extra_options	public	function	If a handler has 'extra options' it will get a little settings widget and another form called extra_options.	1
views_handler::is_a_group	public	function	Returns TRUE if the exposed filter works like a grouped filter.	1
views_handler::is_exposed	public	function	Determine if this item is 'exposed', meaning it provides form elements to let users modify the view.
views_handler::multiple_exposed_input	public	function	Define if the exposed input has to be submitted multiple times. This is TRUE when exposed filters grouped are using checkboxes as widgets.	1
views_handler::needs_style_plugin	public	function	Determine if the argument needs a style plugin.	1
views_handler::options_validate	public	function	Validate the options form.	4
views_handler::placeholder	public	function	Provides a unique placeholders for handlers.
views_handler::post_execute	public	function	Run after the view is executed, before the result is cached.	1
views_handler::pre_query	public	function	Run before the view is built.	1
views_handler::sanitize_value	public	function	Sanitize the value for output.
views_handler::set_relationship	public	function	Called just prior to query(), this lets a handler set up any relationship it needs.
views_handler::show_expose_button	public	function	Shortcut to display the expose/hide button.	2
views_handler::show_expose_form	public	function	Shortcut to display the exposed options form.
views_handler::store_exposed_input	public	function	If set to remember exposed input in the session, store it there.	1
views_handler::use_group_by	public	function	Provides the handler some groupby.	2
views_handler::validate	public	function	Validates the handler against the complete View.	1
views_handler_field::$additional_fields	public	property	Stores additional fields which get added to the query. The generated aliases are stored in $aliases.
views_handler_field::$aliases	public	property
views_handler_field::$field_alias	public	property
views_handler_field::$last_render_index	protected	property	Keeps track of the last render index.
views_handler_field::$original_value	public	property	The field value prior to any rewriting.
views_handler_field::add_additional_fields	public	function	Add 'additional' fields to the query.
views_handler_field::add_self_tokens	public	function	Add any special tokens this field might use for itself.	4
views_handler_field::admin_summary	public	function	Provide extra data to the administration form Overrides views_handler::admin_summary
views_handler_field::advanced_render	public	function	Render a field using advanced settings.
views_handler_field::allow_advanced_render	public	function	Determine if this field can allow advanced rendering.	1
views_handler_field::click_sort	public	function	Called to determine what to tell the clicksorter.	1
views_handler_field::click_sortable	public	function	Determine if this field is click sortable.	1
views_handler_field::construct	public	function	Construct a new field handler. Overrides views_object::construct	17
views_handler_field::document_self_tokens	public	function	Document any special tokens this field might use for itself.	4
views_handler_field::element_classes	public	function	Return the class of the field.
views_handler_field::element_label_classes	public	function	Return the class of the field's label.
views_handler_field::element_label_type	public	function	Return an HTML element for the label based upon the field's element type.
views_handler_field::element_type	public	function	Return an HTML element based upon the field's element type.	2
views_handler_field::element_wrapper_classes	public	function	Return the class of the field's wrapper.
views_handler_field::element_wrapper_type	public	function	Return an HTML element for the wrapper based upon the field's element type.
views_handler_field::get_elements	public	function	Provide a list of elements valid for field HTML.
views_handler_field::get_render_tokens	public	function	Get the 'render' tokens to use for advanced rendering.
views_handler_field::get_token_values_recursive	public	function	Recursive function to add replacements for nested query string parameters.
views_handler_field::get_value	public	function	Get the value that's supposed to be rendered.	3
views_handler_field::init	public	function	Init the handler with necessary data. Overrides views_handler::init	11
views_handler_field::is_value_empty	public	function	Checks if a field value is empty.
views_handler_field::label	public	function	Get this field's label.
views_handler_field::options_submit	public	function	Performs some cleanup tasks on the options array before saving it. Overrides views_handler::options_submit	1
views_handler_field::pre_render	public	function	Run before any fields are rendered.	8
views_handler_field::query	public	function	Called to add the field to a query.	22
views_handler_field::render_altered	public	function	Render this field as altered text, from a fieldset set by the user.
views_handler_field::render_as_link	public	function	Render this field as a link, with info from a fieldset set by the user.
views_handler_field::render_text	public	function	Perform an advanced text render for the item.
views_handler_field::render_trim_text	public	function	Trim the field down to the specified length.
views_handler_field::theme	public	function	Call out to the theme() function.
views_handler_field::theme_functions	public	function	Build a list of suitable theme functions for this view.
views_handler_field::tokenize_value	public	function	Replace a value with tokens from the last field.
views_handler_field::ui_name	public	function	Return a string representing this handler's name in the UI. Overrides views_handler::ui_name	1
views_handler_field::use_string_group_by	public	function	Determines if this field will be available as an option to group the result by in the style settings.
views_object::$definition	public	property	Handler's definition.
views_object::$options	public	property	Except for displays, options for the object will be held here.	1
views_object::altered_option_definition		function	Collect this handler's option definition and alter them, ready for use.
views_object::destroy	public	function	Destructor.	2
views_object::export_option	public	function		1
views_object::export_options	public	function
views_object::export_option_always	public	function	Always exports the option, regardless of the default value.
views_object::options Deprecated	public	function	Set default options on this object.	1
views_object::set_default_options	public	function	Set default options.
views_object::set_definition	public	function	Let the handler know what its full definition is.
views_object::unpack_options	public	function	Unpack options over our existing defaults, drilling down into arrays so that defaults don't get totally blown away.
views_object::unpack_translatable	public	function	Unpack a single option definition.
views_object::unpack_translatables	public	function	Unpacks each handler to store translatable texts.
views_object::_set_option_defaults	public	function

You are here

class editableviews_handler_field_entity_metadata_property in Editable Views 7

Hierarchy

File

Members

API Navigation