interface PartyDataSetActionInterface in Party 7

The interface for action UI controllers.

Hierarchy

• interface \PartyDataSetActionInterface

See also

party_attached_entity_action_form()

File

includes/party.data_ui.inc, line 12

Provides default classes for UI actions on data sets.

interface PartyDataSetActionInterface {

  /**
   * Get the page title for the action form.
   *
   * @todo: consider moving this to the data set action definition, where the
   * local action label is already defined.
   *
   * @param $party
   *   A loaded party object.
   * @param $data_set
   *   A loaded data set.
   *   We don't actually need this loaded, but we need a menu loader to convert
   *   the path-style string to the machine name, and a menu loader that doesn't
   *   load would be weird too.
   * @param $eid
   *   The id of the entity, if relevant to this action.
   *
   * @return
   *  A localized string.
   */
  public function get_page_title($name, $var);

  /**
   * Provides the action form for adding a new entity.
   *
   * @param $party
   *   A loaded party object.
   * @param $data_set
   *   A loaded data set.
   *   We don't actually need this loaded, but we need a menu loader to convert
   *   the path-style string to the machine name, and a menu loader that doesn't
   *   load would be weird too.
   * @param $eid
   *   The id of the entity, if relevant to this action.
   *
   * @return
   *  A FormAPI array.
   */
  function action_form($form, &$form_state, $party, $data_set, $eid = NULL);

  /**
   * Form validation for the action form.
   */
  function action_form_validate($form, &$form_state);

  /**
   * Form submission for the action form.
   */
  function action_form_submit($form, &$form_state);

}

Members

Name	Modifiers	Type	Description	Overrides
PartyDataSetActionInterface::action_form		function	Provides the action form for adding a new entity.	2
PartyDataSetActionInterface::action_form_submit		function	Form submission for the action form.	2
PartyDataSetActionInterface::action_form_validate		function	Form validation for the action form.	2
PartyDataSetActionInterface::get_page_title	public	function	Get the page title for the action form.	2