class editableviews_handler_field_field_edit in Editable Views 7

Field handler for toggling between rendered value and edit form element.

TODO: figure out a way to show the widget type in the admin summary??

Hierarchy

class \views_object
- class \views_handler
  - class \views_handler_field
    class \views_handler_field_field
    class \editableviews_handler_field_field_edit

Expanded class hierarchy of editableviews_handler_field_field_edit

1 string reference to 'editableviews_handler_field_field_edit'

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

File

handlers/editableviews_handler_field_field_edit.inc, line 8

View source

class editableviews_handler_field_field_edit extends views_handler_field_field {

  /**
   * Boolean to indicate to the style plugin that this field is editable.
   *
   * We do this here rather than just check the class parentage to allow field
   * handlers to provide form elements for non-FieldAPI entity properties.
   */
  public $editable = TRUE;
  function option_definition() {
    $options = parent::option_definition();

    // We can't realistically provide a default widget type, because there may
    // be entities of different bundles in the view result, and therefore
    // different field instances with different widgets.
    $options['widget_type'] = array(
      'default' => NULL,
    );
    $options['suppress_label'] = array(
      'default' => FALSE,
    );
    $options['suppress_description'] = array(
      'default' => FALSE,
    );
    return $options;
  }
  function options_form(&$form, &$form_state) {
    parent::options_form($form, $form_state);
    $field = field_info_field($this->definition['field_name']);
    module_load_include('inc', 'field_ui', 'field_ui.admin');
    $widget_options = array(
      // Banking on there being no widget type called '0', which is a reasonable
      // assumption to make!
      0 => t('Default'),
    );
    $widget_options += field_ui_widget_type_options($field['type']);
    $form['widget_type'] = array(
      '#type' => 'select',
      '#title' => t('Widget type'),
      '#options' => $widget_options,
      '#default_value' => $this->options['widget_type'],
      '#description' => t("The type of form element you would like to present to the user when editing this field." . ' ' . "'Default' will use the widget from field settings, and may result in different widgets showing if the entities are of different bundles."),
    );
    $form['suppress_label'] = array(
      '#type' => 'checkbox',
      '#title' => t('Hide widget label'),
      '#description' => t('If selected, the label on field widget is hidden. (If the field is required, the * will still show.)'),
      '#default_value' => $this->options['suppress_label'],
    );
    $form['suppress_description'] = array(
      '#type' => 'checkbox',
      '#title' => t('Hide field widget description'),
      '#description' => t('If selected, the description on field widgets is hidden.'),
      '#default_value' => $this->options['suppress_description'],
    );
  }

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

  /**
   * Add the form element for this handler's field to the form.
   *
   * We break this out into the handler to allow other handlers that work with
   * non-FieldAPI fields (eg node title) to also provide a form element.
   *
   * @param $entity_type
   *  The entity type.
   * @param $entity
   *  The entity.
   * @param &$element
   *  The partial form, at $form[ENTITY_ID]. This is passed by reference and
   *  should be altered in place.
   * @param &$form_state
   *  The form state.
   */
  function edit_form($entity_type, $entity, &$element, &$form_state) {
    list($entity_id, $vid, $bundle) = entity_extract_ids($entity_type, $entity);

    // TODO: this prevents this method being static. This would mean we could
    // store class names in the form rather than handler objects, which would
    // considerably save on form cache size!
    $field_name = $this->definition['field_name'];
    $field_instance = field_info_instance($entity_type, $field_name, $bundle);

    // Because a View result can show entities of different bundles, it is
    // essential that we check the field actually exists on the current entity.
    // ctools_field_invoke_field() does actually check for this too, but that
    // only works when it's passed a field name rather than a whole instance.
    if (empty($field_instance)) {
      return;
    }

    // TODO: Faffy to have to keep doing this for the entity in each handler!!!!
    if (isset($entity->language)) {
      $langcode = field_valid_language($entity->language);
    }
    else {
      $langcode = field_valid_language(NULL);
    }
    if (!empty($this->options['suppress_label'])) {
      $field_instance['label'] = '';
    }
    if (!empty($this->options['suppress_description'])) {
      $field_instance['description'] = '';
    }

    // Only doctor the widget type if the option is set; otherwise the widget
    // type set for the entity's bundle will be used.
    if (!empty($this->options['widget_type'])) {
      $field_instance['widget']['type'] = $this->options['widget_type'];

      // We also need to set the module for the widget, in case this differs
      // from the module for the original widget, because this is used to
      // determine which module's hook_field_widget_form() gets invoked.
      $widget_info = field_info_widget_types();
      $widget_info = $widget_info[$this->options['widget_type']];
      $field_instance['widget']['module'] = $widget_info['module'];
    }

    // On new entities, force this to not be required, to allow the user to not
    // create the new entity.
    // Obviously, problems arise when there are multiple editable fields on
    // this entity, since the title *is* required if actually creating an
    // entity!
    // TODO: consider this thorny problem.
    if (!empty($entity->is_new)) {
      $field_instance['required'] = FALSE;
    }

    // If no language is provided use the default site language.
    $field_invoke_options = array(
      'language' => $langcode,
      'default' => TRUE,
    );
    $element += (array) ctools_field_invoke_field($field_instance, 'form', $entity_type, $entity, $element, $form_state, $field_invoke_options);
  }

  /**
   * Handle the form validation for this field's form element.
   *
   * @param $entity_type
   *  The entity type.
   * @param $entity
   *  The entity.
   * @param &$element
   *  The partial form, at $form[ENTITY_ID].
   * @param &$form_state
   *  The form state.
   * @param &$errors
   *  An array of errors, in the same format as expected by
   *  hook_field_attach_validate().
   */
  function edit_form_validate($entity_type, $entity, &$element, &$form_state, &$errors) {
    list($entity_id, $vid, $bundle) = entity_extract_ids($entity_type, $entity);
    $field_name = $this->definition['field_name'];
    $field_instance = field_info_instance($entity_type, $field_name, $bundle);

    // Because a View result can show entities of different bundles, it is
    // essential that we check the field actually exists on the current entity.
    // ctools_field_invoke_field() does actually check for this too, but that
    // only works when it's passed a field name rather than a whole instance.
    if (empty($field_instance)) {
      return;
    }

    // Extract field values from submitted values.
    // We pass a partial $form array to the Field API hook. This contains at
    // its base the #parents array, which tells Field API where to look for
    // the values in $form_state.
    ctools_field_invoke_field_default($field_instance, 'extract_form_values', $entity_type, $entity, $element, $form_state);

    // Check generic, field-type-agnostic errors first.
    ctools_field_invoke_field_default($field_instance, 'validate', $entity_type, $entity, $errors);

    // Check field-type specific errors.
    ctools_field_invoke_field($field_instance, 'validate', $entity_type, $entity, $errors);
  }

  /**
   * Set form validation errors for this field's form element.
   *
   * @param $entity_type
   *  The entity type.
   * @param $entity
   *  The entity.
   * @param &$element
   *  The partial form, at $form[ENTITY_ID].
   * @param &$form_state
   *  The form state.
   * @param &$errors
   *  An array of errors, in the same format as expected by
   *  hook_field_attach_validate().
   */
  function edit_form_validate_errors($entity_type, $entity, &$element, &$form_state, &$errors) {
    list($entity_id, $vid, $bundle) = entity_extract_ids($entity_type, $entity);
    $field_name = $this->definition['field_name'];
    $field_instance = field_info_instance($entity_type, $field_name, $bundle);

    // Pass field-level validation errors back to widgets for accurate error
    // flagging.
    foreach ($errors as $field_errors) {
      foreach ($field_errors as $langcode => $errors) {
        $field_state = field_form_get_state($element['#parents'], $field_name, $langcode, $form_state);
        $field_state['errors'] = $errors;
        field_form_set_state($element['#parents'], $field_name, $langcode, $form_state, $field_state);
      }
    }
    ctools_field_invoke_field_default($field_instance, 'form_errors', $entity_type, $entity, $element, $form_state);
  }

  /**
   * Handle the form submission for this field's form element.
   */
  function edit_form_submit($entity_type, $entity, &$element, &$form_state) {
    list($entity_id, $vid, $bundle) = entity_extract_ids($entity_type, $entity);
    $field_name = $this->definition['field_name'];
    $field_instance = field_info_instance($entity_type, $field_name, $bundle);

    // Because a View result can show entities of different bundles, it is
    // essential that we check the field actually exists on the current entity.
    // ctools_field_invoke_field() does actually check for this too, but that
    // only works when it's passed a field name rather than a whole instance.
    if (empty($field_instance)) {
      return;
    }

    // Extract field values from submitted values.
    // We pass the partial $form array to the Field API hook. This contains at
    // its base the #parents array, which tells Field API where to look for
    // the values in $form_state.
    ctools_field_invoke_field_default($field_instance, 'extract_form_values', $entity_type, $entity, $element, $form_state);
    ctools_field_invoke_field_default($field_instance, 'submit', $entity_type, $entity, $element, $form_state);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
editableviews_handler_field_field_edit::$editable	public	property	Boolean to indicate to the style plugin that this field is editable.
editableviews_handler_field_field_edit::edit_form		function	Add the form element for this handler's field to the form.
editableviews_handler_field_field_edit::edit_form_submit		function	Handle the form submission for this field's form element.
editableviews_handler_field_field_edit::edit_form_validate		function	Handle the form validation for this field's form element.
editableviews_handler_field_field_edit::edit_form_validate_errors		function	Set form validation errors for this field's form element.
editableviews_handler_field_field_edit::field_name		function	Return the name of the entity property this handler controls.
editableviews_handler_field_field_edit::options_form		function	Default options form provides the label widget that all fields should have. Overrides views_handler_field_field::options_form
editableviews_handler_field_field_edit::option_definition		function	Information about options for all kinds of purposes will be held here. Overrides views_handler_field_field::option_definition
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::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::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::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::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::construct	public	function	Construct a new field handler. Overrides views_object::construct	17
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::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::render	public	function	Render the field.	42
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_handler_field_field::$base_table	public	property	A shortcut for $view->base_table.
views_handler_field_field::$field_info	public	property	Store the field information.
views_handler_field_field::$instance	public	property	Store the field instance.
views_handler_field_field::$items	public	property	An array to store field renderable arrays for use by render_items.
views_handler_field_field::$limit_values	public	property	Does the rendered fields get limited.
views_handler_field_field::$multiple	public	property	Does the field supports multiple field values.
views_handler_field_field::access	public	function	Check whether current user has access to this handler. Overrides views_handler::access
views_handler_field_field::add_field_table	public	function	Determine if the field table should be added to the query.
views_handler_field_field::add_self_tokens	public	function	Add any special tokens this field might use for itself. Overrides views_handler_field::add_self_tokens
views_handler_field_field::click_sort	public	function	Called to determine what to tell the clicksorter. Overrides views_handler_field::click_sort
views_handler_field_field::click_sortable	public	function	Determine if this field is click sortable. Overrides views_handler_field::click_sortable
views_handler_field_field::document_self_tokens	public	function	Document any special tokens this field might use for itself. Overrides views_handler_field::document_self_tokens
views_handler_field_field::field_language	public	function	Return the language code of the language the field should be displayed in, according to the settings.
views_handler_field_field::get_base_table	public	function	Set the base_table and base_table_alias.
views_handler_field_field::get_items	public	function
views_handler_field_field::get_value	public	function	Get the value that's supposed to be rendered. Overrides views_handler_field::get_value
views_handler_field_field::groupby_form	public	function	Extend the groupby form with group columns. Overrides views_handler::groupby_form
views_handler_field_field::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. Overrides views_handler::groupby_form_submit
views_handler_field_field::init	public	function	Init the handler with necessary data. Overrides views_handler_field::init
views_handler_field_field::multiple_options_form	public	function	Provide options for multiple value fields.
views_handler_field_field::post_execute	public	function	Load the entities for all fields that are about to be displayed. Overrides views_handler::post_execute
views_handler_field_field::query	public	function	Called to add the field to a query. Overrides views_handler_field::query
views_handler_field_field::render_item	public	function
views_handler_field_field::render_items	public	function	Render all items in this field together.
views_handler_field_field::set_items	public	function	Return an array of items for the field.
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_field_edit in Editable Views 7

Hierarchy

File

Members

API Navigation