class stylizer_ui in Chaos Tool Suite (ctools) 6

Same name and namespace in other branches

7 stylizer/plugins/export_ui/stylizer_ui.class.php \stylizer_ui

UI class for Stylizer.

Hierarchy

class \ctools_export_ui
- class \stylizer_ui

Expanded class hierarchy of stylizer_ui

1 string reference to 'stylizer_ui'

stylizer.inc in stylizer/plugins/export_ui/stylizer.inc

File

stylizer/plugins/export_ui/stylizer_ui.class.php, line 6

View source

class stylizer_ui extends ctools_export_ui {
  function access($op, $item) {
    $access = parent::access($op, $item);
    if ($op == 'add' && $access && empty($this->base_types)) {

      // Make sure there are base styles defined.
      $access = FALSE;
    }
    return $access;
  }
  function list_form(&$form, &$form_state) {
    ctools_include('stylizer');
    parent::list_form($form, $form_state);
    $all = array(
      'all' => t('- All -'),
    );
    if (empty($this->base_types)) {

      // Give a warning about the missing base styles.
      drupal_set_message($this->plugin['strings']['message']['missing base type'], 'warning');
    }
    $types = $all;
    foreach ($this->base_types as $module => $info) {
      foreach ($info as $key => $base_type) {
        $types[$module . '-' . $key] = $base_type['title'];
      }
    }
    $form['top row']['type'] = array(
      '#type' => 'select',
      '#title' => t('Type'),
      '#options' => $types,
      '#default_value' => 'all',
      '#weight' => -10,
      '#attributes' => array(
        'class' => 'ctools-auto-submit',
      ),
    );
    $plugins = ctools_get_style_bases();
    $form_state['style_plugins'] = $plugins;
    $options = $all;

    // @todo base should use $module . '-' . $name
    foreach ($plugins as $name => $plugin) {
      $options[$name] = $plugin['title'];
    }
    $form['top row']['base'] = array(
      '#type' => 'select',
      '#title' => t('Base'),
      '#options' => $all + $options,
      '#default_value' => 'all',
      '#weight' => -9,
      '#attributes' => array(
        'class' => 'ctools-auto-submit',
      ),
    );
  }
  function list_sort_options() {
    return array(
      'disabled' => t('Enabled, title'),
      'title' => t('Title'),
      'name' => t('Name'),
      'base' => t('Base'),
      'type' => t('Type'),
      'storage' => t('Storage'),
    );
  }
  function list_filter($form_state, $item) {
    if (empty($form_state['style_plugins'][$item->settings['style_base']])) {
      $this->style_plugin = array(
        'name' => 'broken',
        'title' => t('Missing plugin'),
        'type' => t('Unknown'),
        'module' => '',
      );
    }
    else {
      $this->style_plugin = $form_state['style_plugins'][$item->settings['style_base']];
    }

    // This isn't really a field, but by setting this we can list it in the
    // filter fields and have the search box pick it up.
    $item->plugin_title = $this->style_plugin['title'];
    if ($form_state['values']['type'] != 'all') {
      list($module, $type) = explode('-', $form_state['values']['type']);
      if ($module != $this->style_plugin['module'] || $type != $this->style_plugin['type']) {
        return TRUE;
      }
    }
    if ($form_state['values']['base'] != 'all' && $form_state['values']['base'] != $this->style_plugin['name']) {
      return TRUE;
    }
    return parent::list_filter($form_state, $item);
  }
  function list_search_fields() {
    $fields = parent::list_search_fields();
    $fields[] = 'plugin_title';
    return $fields;
  }
  function list_build_row($item, &$form_state, $operations) {

    // Set up sorting
    switch ($form_state['values']['order']) {
      case 'disabled':
        $this->sorts[$item->name] = empty($item->disabled) . $item->admin_title;
        break;
      case 'title':
        $this->sorts[$item->name] = $item->admin_title;
        break;
      case 'name':
        $this->sorts[$item->name] = $item->name;
        break;
      case 'type':
        $this->sorts[$item->name] = $this->style_plugin['type'] . $item->admin_title;
        break;
      case 'base':
        $this->sorts[$item->name] = $this->style_plugin['title'] . $item->admin_title;
        break;
      case 'storage':
        $this->sorts[$item->name] = $item->type . $item->admin_title;
        break;
    }
    if (!empty($this->base_types[$this->style_plugin['module']][$this->style_plugin['type']])) {
      $type = $this->base_types[$this->style_plugin['module']][$this->style_plugin['type']]['title'];
    }
    else {
      $type = t('Unknown');
    }
    $this->rows[$item->name] = array(
      'data' => array(
        array(
          'data' => $type,
          'class' => 'ctools-export-ui-type',
        ),
        array(
          'data' => check_plain($item->name),
          'class' => 'ctools-export-ui-name',
        ),
        array(
          'data' => check_plain($item->admin_title),
          'class' => 'ctools-export-ui-title',
        ),
        array(
          'data' => check_plain($this->style_plugin['title']),
          'class' => 'ctools-export-ui-base',
        ),
        array(
          'data' => check_plain($item->type),
          'class' => 'ctools-export-ui-storage',
        ),
        array(
          'data' => theme('links', $operations),
          'class' => 'ctools-export-ui-operations',
        ),
      ),
      'title' => check_plain($item->admin_description),
      'class' => !empty($item->disabled) ? 'ctools-export-ui-disabled' : 'ctools-export-ui-enabled',
    );
  }
  function list_table_header() {
    return array(
      array(
        'data' => t('Type'),
        'class' => 'ctools-export-ui-type',
      ),
      array(
        'data' => t('Name'),
        'class' => 'ctools-export-ui-name',
      ),
      array(
        'data' => t('Title'),
        'class' => 'ctools-export-ui-title',
      ),
      array(
        'data' => t('Base'),
        'class' => 'ctools-export-ui-base',
      ),
      array(
        'data' => t('Storage'),
        'class' => 'ctools-export-ui-storage',
      ),
      array(
        'data' => t('Operations'),
        'class' => 'ctools-export-ui-operations',
      ),
    );
  }
  function init($plugin) {
    ctools_include('stylizer');
    $this->base_types = ctools_get_style_base_types();
    parent::init($plugin);
  }
  function get_wizard_info(&$form_state) {
    $form_info = parent::get_wizard_info($form_state);
    ctools_include('stylizer');

    // For add forms, we have temporarily set the 'form type' to include
    // the style type so the default wizard_info can find the path. If
    // we did that, we have to put it back.
    if (!empty($form_state['type'])) {
      $form_state['form type'] = 'add';
      $form_info['show back'] = TRUE;
    }

    // Ensure these do not get out of sync.
    $form_state['item']->settings['name'] = $form_state['item']->name;
    $form_state['settings'] = $form_state['item']->settings;

    // Figure out the base style plugin in use and make sure that is available.
    $plugin = NULL;
    if (!empty($form_state['item']->settings['style_base'])) {
      $plugin = ctools_get_style_base($form_state['item']->settings['style_base']);
      ctools_stylizer_add_plugin_forms($form_info, $plugin, $form_state['op']);
    }
    else {

      // This is here so the 'finish' button does not show up, and because
      // we don't have the selected style we don't know what the next form(s)
      // will be.
      $form_info['order']['next'] = t('Configure style');
    }

    // If available, make sure these are available for the 'choose' form.
    if (!empty($form_state['item']->style_module)) {
      $form_state['module'] = $form_state['item']->style_module;
      $form_state['type'] = $form_state['item']->style_type;
    }
    $form_state['plugin'] = $plugin;
    $form_state['settings'] = $form_state['item']->settings;
    return $form_info;
  }

  /**
   * Store the stylizer info in our settings.
   *
   * The stylizer wizard stores its stuff in slightly different places, so
   * we have to find it and move it to the right place.
   */
  function store_stylizer_info(&$form_state) {

    /*
    foreach (array('name', 'admin_title', 'admin_description') as $key) {
      if (!empty($form_state['values'][$key])) {
        $form_state['item']->{$key} = $form_state['values'][$key];
      }
    }
    */
    if ($form_state['step'] != 'import') {
      $form_state['item']->settings = $form_state['settings'];
    }

    // Do not let the 'name' accidentally get out of sync under any circumstances.
    $form_state['item']->settings['name'] = $form_state['item']->name;
  }
  function edit_wizard_next(&$form_state) {
    $this
      ->store_stylizer_info($form_state);
    parent::edit_wizard_next($form_state);
  }
  function edit_wizard_finish(&$form_state) {

    // These might be stored by the stylizer wizard, so we should clear them.
    if (isset($form_state['settings']['old_settings'])) {
      unset($form_state['settings']['old_settings']);
    }
    $this
      ->store_stylizer_info($form_state);
    parent::edit_wizard_finish($form_state);
  }
  function edit_form_type(&$form, &$form_state) {
    foreach ($this->base_types as $module => $info) {
      foreach ($info as $key => $base_type) {
        $types[$module . '-' . $key] = $base_type['title'];
      }
    }
    $form['type'] = array(
      '#type' => 'select',
      '#title' => t('Type'),
      '#options' => $types,
      '#default_value' => 'all',
      '#weight' => -10,
      '#attributes' => array(
        'class' => 'ctools-auto-submit',
      ),
    );
  }
  function edit_form_type_submit(&$form, &$form_state) {
    list($form_state['item']->style_module, $form_state['item']->style_type) = explode('-', $form_state['values']['type']);
  }

}

Members

Name	Type	Description	Overrides
ctools_export_ui::$name	property
ctools_export_ui::$options	property
ctools_export_ui::$plugin	property
ctools_export_ui::add_page	function
ctools_export_ui::clone_page	function	Main entry point to clone an item.
ctools_export_ui::delete_page	function	Page callback to delete an exportable item.
ctools_export_ui::disable_page	function	Callback to disable a page.
ctools_export_ui::edit_cache_clear	function	Clear the object cache for the currently edited item.
ctools_export_ui::edit_cache_get	function	Retrieve the item currently being edited from the object cache.
ctools_export_ui::edit_cache_get_key	function	Figure out what the cache key is for this object.
ctools_export_ui::edit_cache_set	function	Cache the item currently currently being edited.
ctools_export_ui::edit_cache_set_key	function
ctools_export_ui::edit_execute_form	function	Execute the form.
ctools_export_ui::edit_execute_form_standard	function	Execute the standard form for editing.
ctools_export_ui::edit_execute_form_wizard	function	Execute the wizard for editing.
ctools_export_ui::edit_finish_validate	function	Perform a final validation check before allowing the form to be finished.
ctools_export_ui::edit_form	function	Provide the actual editing form.	1
ctools_export_ui::edit_form_import	function	Import form. Provides simple helptext instructions and textarea for pasting a export definition.
ctools_export_ui::edit_form_import_submit	function	Submit callback for import form.
ctools_export_ui::edit_form_import_validate	function	Import form validate handler.
ctools_export_ui::edit_form_submit	function	Handle the submission of the edit form.	2
ctools_export_ui::edit_form_validate	function	Validate callback for the edit form.
ctools_export_ui::edit_page	function	Main entry point to edit an item.
ctools_export_ui::edit_save_form	function	Called to save the final product from the edit form.
ctools_export_ui::edit_wizard_back	function	Wizard 'back' callback when using a wizard to edit an item.
ctools_export_ui::edit_wizard_cancel	function	Wizard 'cancel' callback when using a wizard to edit an item.
ctools_export_ui::enable_page	function	Callback to enable a page.
ctools_export_ui::export_page	function	Page callback to display export information for an exportable item.
ctools_export_ui::get_page_title	function	Get a page title for the current page from our plugin strings.
ctools_export_ui::help_area	function	Add text on the top of the page.
ctools_export_ui::hook_menu	function	hook_menu() entry point.
ctools_export_ui::import_page	function	Page callback to import information for an exportable item.
ctools_export_ui::list_css	function	Add listing CSS to the page.
ctools_export_ui::list_footer	function	Render a footer to go after thie list.
ctools_export_ui::list_form_submit	function	Submit the filter/sort form.
ctools_export_ui::list_form_validate	function	Validate the filter/sort form.
ctools_export_ui::list_header	function	Render a header to go before the list.
ctools_export_ui::list_page	function	Master entry point for handling a list.
ctools_export_ui::list_render	function	Render all of the rows together.
ctools_export_ui::set_item_state	function	Set an item's state to enabled or disabled and output to user.
stylizer_ui::access	function	Menu callback to determine if an operation is accessible. Overrides ctools_export_ui::access
stylizer_ui::edit_form_type	function
stylizer_ui::edit_form_type_submit	function
stylizer_ui::edit_wizard_finish	function	Wizard 'cancel' callback when using a wizard to edit an item. Overrides ctools_export_ui::edit_wizard_finish
stylizer_ui::edit_wizard_next	function	Wizard 'next' callback when using a wizard to edit an item. Overrides ctools_export_ui::edit_wizard_next
stylizer_ui::get_wizard_info	function	Get the form info for the wizard. Overrides ctools_export_ui::get_wizard_info
stylizer_ui::init	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. Overrides ctools_export_ui::init
stylizer_ui::list_build_row	function	Build a row based on the item. Overrides ctools_export_ui::list_build_row
stylizer_ui::list_filter	function	Determine if a row should be filtered out. Overrides ctools_export_ui::list_filter
stylizer_ui::list_form	function	Create the filter/sort form at the top of a list of exports. Overrides ctools_export_ui::list_form
stylizer_ui::list_search_fields	function	Provide a list of fields to test against for the default "search" widget. Overrides ctools_export_ui::list_search_fields
stylizer_ui::list_sort_options	function	Provide a list of sort options. Overrides ctools_export_ui::list_sort_options
stylizer_ui::list_table_header	function	Provide the table header. Overrides ctools_export_ui::list_table_header
stylizer_ui::store_stylizer_info	function	Store the stylizer info in our settings.

You are here

class stylizer_ui in Chaos Tool Suite (ctools) 6

Hierarchy

File

Members

API Navigation