class services_client_ui in Services Client 7.2

Same name and namespace in other branches

7 plugins/export_ui/services_client_ui.class.php \services_client_ui

Hierarchy

class \ctools_export_ui
- class \services_client_ui

Expanded class hierarchy of services_client_ui

1 string reference to 'services_client_ui'

services_client.inc in plugins/export_ui/services_client.inc

File

plugins/export_ui/services_client_ui.class.php, line 3

View source

class services_client_ui extends ctools_export_ui {

  /**
   * Page callback; Basic configuration page.
   */
  function configure_page($js, $input, $item) {
    drupal_set_title($this
      ->get_page_title('configure', $item));
    $event = $this
      ->get_event_handler($item, TRUE);
    return drupal_get_form('services_client_event_config', $event);
  }

  /**
   * Page callback; Add new plugin.
   */
  function add_plugin_page($js, $input, $item, $type) {
    drupal_set_title($this
      ->get_page_title('add_plugin', $item));
    $event = $this
      ->get_event_handler($item, TRUE);
    if ($type == 'mapping') {
      $uuid = $event
        ->addPlugin('mapping', 'ServicesClientMappingPlugin');
      $event
        ->setObjectCache();
      drupal_goto($event
        ->getUrl('plugin/mapping/' . $uuid . '/edit'));
    }
    return drupal_get_form('services_client_plugin_add', $event, $type);
  }

  /**
   * Page callback; Configure plugin.
   */
  function configure_plugin_page($js, $input, $item, $type, $uuid) {
    $event = $this
      ->get_event_handler($item, TRUE);
    $plugin = $event
      ->getPlugin($type, $uuid);
    return drupal_get_form('services_client_plugin_edit', $event, $type, $uuid, $plugin);
  }

  /**
   * Page callback; Remove existing plugin.
   */
  function remove_plugin_page($js, $input, $item, $type, $uuid) {
    $event = $this
      ->get_event_handler($item, TRUE);

    // Check if valid token is provided as there is no confirmation form here.
    if (!isset($_GET['token']) || !drupal_valid_token($_GET['token'], $uuid)) {
      drupal_set_message(t('Invalid token'), 'error');
      return MENU_ACCESS_DENIED;
    }
    else {
      $event
        ->removePlugin($type, $uuid);
      $event
        ->setObjectCache();
      drupal_set_message(t('Plugin was removed.'));
    }

    // Redirect user back to configuration page.
    drupal_goto($event
      ->getUrl('configure'));
  }

  /**
   * Page callback; Break edit lock.
   */
  function break_lock_page($js, $input, $item) {
    drupal_set_title($this
      ->get_page_title('configure', $item));
    $event = $this
      ->get_event_handler($item, TRUE);
    return drupal_get_form('services_client_event_break_lock', $event);
  }

  /**
   * Retrieve event handler by event configuration.
   *
   * @param stdClass $item
   *   Export event object.
   *
   * @param boolean $object_cache
   *   TRUE if should be loaded from ctools object cache (for configuratin pages).
   *
   * @return EventHandler
   *   Instance of EventHandler.
   */
  function get_event_handler($item, $object_cache = FALSE) {
    $event = $item
      ->getHandler();
    if ($object_cache) {
      return $event
        ->objectCached();
    }
    return $event;
  }

  /**
   * Provide a list of sort options.
   *
   * Override this if you wish to provide more or change how these work.
   * The actual handling of the sorting will happen in build_row().
   */
  function list_sort_options() {
    if (!empty($this->plugin['export']['title'])) {
      $options = array(
        'disabled' => t('Enabled, title'),
        $this->plugin['export']['title'] => t('Title'),
      );
    }
    else {
      $options = array(
        'disabled' => t('Enabled, name'),
      );
    }
    $options += array(
      'name' => t('Name'),
      'storage' => t('Storage'),
      'connection' => t('Connection'),
    );
    return $options;
  }

  /**
   * Build a row based on the item.
   *
   * By default all of the rows are placed into a table by the render
   * method, so this is building up a row suitable for theme('table').
   * This doesn't have to be true if you override both.
   */
  function list_build_row($item, &$form_state, $operations) {

    // Set up sorting
    $name = $item->{$this->plugin['export']['key']};
    $schema = ctools_export_get_schema($this->plugin['schema']);

    // Note: $item->{$schema['export']['export type string']} should have already been set up by export.inc so
    // we can use it safely.
    switch ($form_state['values']['order']) {
      case 'disabled':
        $this->sorts[$name] = empty($item->disabled) . $name;
        break;
      case 'title':
        $this->sorts[$name] = $item->{$this->plugin['export']['title']};
        break;
      case 'name':
        $this->sorts[$name] = $name;
        break;
      case 'connection':
        $this->sorts[$name] = $item->connection;
        break;
      case 'storage':
        $this->sorts[$name] = $item->{$schema['export']['export type string']} . $name;
        break;
    }
    $this->rows[$name]['data'] = array();
    $this->rows[$name]['class'] = !empty($item->disabled) ? array(
      'ctools-export-ui-disabled',
    ) : array(
      'ctools-export-ui-enabled',
    );

    // If we have an admin title, make it the first row.
    $connection = services_client_connection_load($item->connection);
    $this->rows[$name]['data'][] = array(
      'data' => check_plain($item->title),
      'class' => array(
        'ctools-export-ui-title',
      ),
    );
    $this->rows[$name]['data'][] = array(
      'data' => check_plain($name),
      'class' => array(
        'ctools-export-ui-name',
      ),
    );
    $this->rows[$name]['data'][] = array(
      'data' => l($connection->admin_title, 'admin/structure/services_client/connection/list/' . $item->connection . '/edit', array(
        'query' => drupal_get_destination(),
      )),
      'class' => array(
        'ctools-export-ui-connection',
      ),
    );
    $this->rows[$name]['data'][] = array(
      'data' => check_plain($item->entity_type),
      'class' => array(
        'ctools-export-ui-entity-type',
      ),
    );
    $this->rows[$name]['data'][] = array(
      'data' => check_plain($item->event),
      'class' => array(
        'ctools-export-ui-event',
      ),
    );
    $this->rows[$name]['data'][] = array(
      'data' => check_plain($item->plugin),
      'class' => array(
        'ctools-export-ui-handler',
      ),
    );
    $this->rows[$name]['data'][] = array(
      'data' => check_plain($item->{$schema['export']['export type string']}),
      'class' => array(
        'ctools-export-ui-storage',
      ),
    );
    $ops = theme('links', array(
      'links' => $operations,
      'attributes' => array(
        'class' => array(
          'links',
          'inline',
        ),
      ),
    ));
    $this->rows[$name]['data'][] = array(
      'data' => $ops,
      'class' => array(
        'ctools-export-ui-operations',
      ),
    );

    // Add an automatic mouseover of the description if one exists.
    if (!empty($this->plugin['export']['admin_description'])) {
      $this->rows[$name]['title'] = $item->{$this->plugin['export']['admin_description']};
    }
  }

  /**
   * Provide the table header.
   *
   * If you've added columns via list_build_row() but are still using a
   * table, override this method to set up the table header.
   */
  function list_table_header() {
    $header = array();
    $header[] = array(
      'data' => t('Title'),
      'class' => array(
        'ctools-export-ui-title',
      ),
    );
    $header[] = array(
      'data' => t('Name'),
      'class' => array(
        'ctools-export-ui-name',
      ),
    );
    $header[] = array(
      'data' => t('Connection'),
      'class' => array(
        'ctools-export-ui-connection',
      ),
    );
    $header[] = array(
      'data' => t('Entity Type'),
      'class' => array(
        'ctools-export-ui-entity-type',
      ),
    );
    $header[] = array(
      'data' => t('Event'),
      'class' => array(
        'ctools-export-ui-event',
      ),
    );
    $header[] = array(
      'data' => t('Handler'),
      'class' => array(
        'ctools-export-ui-handler',
      ),
    );
    $header[] = array(
      'data' => t('Storage'),
      'class' => array(
        'ctools-export-ui-storage',
      ),
    );
    $header[] = array(
      'data' => t('Operations'),
      'class' => array(
        'ctools-export-ui-operations',
      ),
    );
    return $header;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ctools_export_ui::$name		property
ctools_export_ui::$options		property
ctools_export_ui::$plugin		property
ctools_export_ui::access	public	function	Menu callback to determine if an operation is accessible.	1
ctools_export_ui::add_page	public	function
ctools_export_ui::build_operations	public	function	Builds the operation links for a specific exportable item.
ctools_export_ui::clone_page	public	function	Main entry point to clone an item.
ctools_export_ui::delete_form_submit	public	function	Deletes exportable items from the database.
ctools_export_ui::delete_page	public	function	Page callback to delete an exportable item.
ctools_export_ui::disable_page	public	function	Callback to disable a page.
ctools_export_ui::edit_cache_clear	public	function	Clear the object cache for the currently edited item.
ctools_export_ui::edit_cache_get	public	function	Retrieve the item currently being edited from the object cache.
ctools_export_ui::edit_cache_get_key	public	function	Figure out what the cache key is for this object.
ctools_export_ui::edit_cache_set	public	function	Cache the item currently currently being edited.
ctools_export_ui::edit_cache_set_key	public	function
ctools_export_ui::edit_execute_form	public	function	Execute the form.
ctools_export_ui::edit_execute_form_standard	public	function	Execute the standard form for editing.
ctools_export_ui::edit_execute_form_wizard	public	function	Execute the wizard for editing.
ctools_export_ui::edit_finish_validate	public	function	Perform a final validation check before allowing the form to be finished.
ctools_export_ui::edit_form	public	function	Provide the actual editing form.	1
ctools_export_ui::edit_form_import	public	function	Import form. Provides simple helptext instructions and textarea for pasting a export definition.
ctools_export_ui::edit_form_import_submit	public	function	Submit callback for import form.
ctools_export_ui::edit_form_import_validate	public	function	Import form validate handler.
ctools_export_ui::edit_form_submit	public	function	Handle the submission of the edit form.	2
ctools_export_ui::edit_form_validate	public	function	Validate callback for the edit form.
ctools_export_ui::edit_page	public	function	Main entry point to edit an item.
ctools_export_ui::edit_save_form	public	function	Called to save the final product from the edit form.
ctools_export_ui::edit_wizard_back	public	function	Wizard 'back' callback when using a wizard to edit an item.
ctools_export_ui::edit_wizard_cancel	public	function	Wizard 'cancel' callback when using a wizard to edit an item.
ctools_export_ui::edit_wizard_finish	public	function	Wizard 'cancel' callback when using a wizard to edit an item.	1
ctools_export_ui::edit_wizard_next	public	function	Wizard 'next' callback when using a wizard to edit an item.	1
ctools_export_ui::enable_page	public	function	Callback to enable a page.
ctools_export_ui::export_page	public	function	Page callback to display export information for an exportable item.
ctools_export_ui::get_page_title	public	function	Get a page title for the current page from our plugin strings.
ctools_export_ui::get_wizard_info	public	function	Get the form info for the wizard.	1
ctools_export_ui::hook_menu	public	function	hook_menu() entry point.
ctools_export_ui::import_page	public	function	Page callback to import information for an exportable item.
ctools_export_ui::init	public	function	Fake constructor -- this is easier to deal with than the real constructor because we are retaining PHP4 compatibility, which would require all child classes to implement their own constructor.	1
ctools_export_ui::list_css	public	function	Add listing CSS to the page.
ctools_export_ui::list_filter	public	function	Determine if a row should be filtered out.	2
ctools_export_ui::list_footer	public	function	Render a footer to go after thie list.
ctools_export_ui::list_form	public	function	Create the filter/sort form at the top of a list of exports.	2
ctools_export_ui::list_form_submit	public	function	Submit the filter/sort form.
ctools_export_ui::list_form_validate	public	function	Validate the filter/sort form.
ctools_export_ui::list_header	public	function	Render a header to go before the list.
ctools_export_ui::list_page	public	function	Master entry point for handling a list.
ctools_export_ui::list_render	public	function	Render all of the rows together.
ctools_export_ui::list_search_fields	public	function	Provide a list of fields to test against for the default "search" widget.	1
ctools_export_ui::load_item	public	function	Called by ctools_export_ui_load to load the item.
ctools_export_ui::redirect	public	function	Perform a drupal_goto() to the location provided by the plugin for the operation.
ctools_export_ui::set_item_state	public	function	Set an item's state to enabled or disabled and output to user.
services_client_ui::add_plugin_page		function	Page callback; Add new plugin.
services_client_ui::break_lock_page		function	Page callback; Break edit lock.
services_client_ui::configure_page		function	Page callback; Basic configuration page.
services_client_ui::configure_plugin_page		function	Page callback; Configure plugin.
services_client_ui::get_event_handler		function	Retrieve event handler by event configuration.
services_client_ui::list_build_row		function	Build a row based on the item. Overrides ctools_export_ui::list_build_row
services_client_ui::list_sort_options		function	Provide a list of sort options. Overrides ctools_export_ui::list_sort_options
services_client_ui::list_table_header		function	Provide the table header. Overrides ctools_export_ui::list_table_header
services_client_ui::remove_plugin_page		function	Page callback; Remove existing plugin.

You are here

class services_client_ui in Services Client 7.2

Hierarchy

File

Members

API Navigation