You are here

Home » API reference » Panels 6.3 » panels_mini_ui.class.php

class panels_mini_ui in Panels 6.3

Same name and namespace in other branches
  1. 7.3 panels_mini/plugins/export_ui/panels_mini_ui.class.php \panels_mini_ui

Hierarchy

Expanded class hierarchy of panels_mini_ui

1 string reference to 'panels_mini_ui'
panels_mini.inc in panels_mini/plugins/export_ui/panels_mini.inc

File

panels_mini/plugins/export_ui/panels_mini_ui.class.php, line 3

View source 
class panels_mini_ui extends ctools_export_ui {
  function init($plugin) {
    parent::init($plugin);
    ctools_include('context');
  }
  function list_form(&$form, &$form_state) {
    ctools_include('plugins', 'panels');
    $this->layouts = panels_get_layouts();
    parent::list_form($form, $form_state);
    $categories = $layouts = array(
      'all' => t('- All -'),
    );
    foreach ($this->items as $item) {
      $categories[$item->category] = $item->category ? $item->category : t('Mini panels');
    }
    $form['top row']['category'] = array(
      '#type' => 'select',
      '#title' => t('Category'),
      '#options' => $categories,
      '#default_value' => 'all',
      '#weight' => -10,
    );
    foreach ($this->layouts as $name => $plugin) {
      $layouts[$name] = $plugin['title'];
    }
    $form['top row']['layout'] = array(
      '#type' => 'select',
      '#title' => t('Layout'),
      '#options' => $layouts,
      '#default_value' => 'all',
      '#weight' => -9,
    );
  }
  function list_filter($form_state, $item) {
    if ($form_state['values']['category'] != 'all' && $form_state['values']['category'] != $item->category) {
      return TRUE;
    }
    if ($form_state['values']['layout'] != 'all' && $form_state['values']['layout'] != $item->display->layout) {
      return TRUE;
    }
    return parent::list_filter($form_state, $item);
  }
  function list_sort_options() {
    return array(
      'disabled' => t('Enabled, title'),
      'title' => t('Title'),
      'name' => t('Name'),
      'category' => t('Category'),
      'storage' => t('Storage'),
      'layout' => t('Layout'),
    );
  }
  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 'category':
        $this->sorts[$item->name] = ($item->category ? $item->category : t('Mini panels')) . $item->admin_title;
        break;
      case 'layout':
        $this->sorts[$item->name] = $item->display->layout . $item->admin_title;
        break;
      case 'storage':
        $this->sorts[$item->name] = $item->type . $item->admin_title;
        break;
    }
    $layout = !empty($this->layouts[$item->display->layout]) ? $this->layouts[$item->display->layout]['title'] : t('Missing layout');
    $category = $item->category ? check_plain($item->category) : t('Mini panels');
    $this->rows[$item->name] = array(
      'data' => array(
        array(
          'data' => check_plain($item->admin_title),
          'class' => 'ctools-export-ui-title',
        ),
        array(
          'data' => check_plain($item->name),
          'class' => 'ctools-export-ui-name',
        ),
        array(
          'data' => $category,
          'class' => 'ctools-export-ui-category',
        ),
        array(
          'data' => $layout,
          'class' => 'ctools-export-ui-layout',
        ),
        array(
          'data' => $item->type,
          'class' => 'ctools-export-ui-storage',
        ),
        array(
          'data' => theme('links', $operations),
          'class' => 'ctools-export-ui-operations',
        ),
      ),
      'title' => !empty($item->admin_description) ? 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('Title'),
        'class' => 'ctools-export-ui-title',
      ),
      array(
        'data' => t('Name'),
        'class' => 'ctools-export-ui-name',
      ),
      array(
        'data' => t('Category'),
        'class' => 'ctools-export-ui-category',
      ),
      array(
        'data' => t('Layout'),
        'class' => 'ctools-export-ui-layout',
      ),
      array(
        'data' => t('Storage'),
        'class' => 'ctools-export-ui-storage',
      ),
      array(
        'data' => t('Operations'),
        'class' => 'ctools-export-ui-operations',
      ),
    );
  }
  function edit_form(&$form, &$form_state) {

    // Get the basic edit form
    parent::edit_form($form, $form_state);
    $form['category'] = array(
      '#type' => 'textfield',
      '#size' => 24,
      '#default_value' => $form_state['item']->category,
      '#title' => t('Category'),
      '#description' => t("The category that this mini-panel will be grouped into on the Add Content form. Only upper and lower-case alphanumeric characters are allowed. If left blank, defaults to 'Mini panels'."),
    );
    $form['title']['#title'] = t('Title');
    $form['title']['#description'] = t('The title for this mini panel. It can be overridden in the block configuration.');
  }

  /**
   * Validate submission of the mini panel edit form.
   */
  function edit_form_basic_validate($form, &$form_state) {
    parent::edit_form_validate($form, $form_state);
    if (preg_match("/[^A-Za-z0-9 ]/", $form_state['values']['category'])) {
      form_error($form['category'], t('Categories may contain only alphanumerics or spaces.'));
    }
  }
  function edit_form_submit(&$form, &$form_state) {
    parent::edit_form_submit($form, $form_state);
    $form_state['item']->category = $form_state['values']['category'];
  }
  function edit_form_context(&$form, &$form_state) {
    ctools_include('context-admin');
    ctools_context_admin_includes();
    ctools_add_css('ruleset');
    $form['right'] = array(
      '#prefix' => '<div class="ctools-right-container">',
      '#suffix' => '</div>',
    );
    $form['left'] = array(
      '#prefix' => '<div class="ctools-left-container clear-block">',
      '#suffix' => '</div>',
    );

    // Set this up and we can use CTools' Export UI's built in wizard caching,
    // which already has callbacks for the context cache under this name.
    $module = 'ctools_export_ui-' . $this->plugin['name'];
    $name = $this
      ->edit_cache_get_key($form_state['item'], $form_state['form type']);
    ctools_context_add_context_form($module, $form, $form_state, $form['right']['contexts_table'], $form_state['item'], $name);
    ctools_context_add_required_context_form($module, $form, $form_state, $form['left']['required_contexts_table'], $form_state['item'], $name);
    ctools_context_add_relationship_form($module, $form, $form_state, $form['right']['relationships_table'], $form_state['item'], $name);
  }
  function edit_form_context_submit(&$form, &$form_state) {

    // Prevent this from going to edit_form_submit();
  }
  function edit_form_layout(&$form, &$form_state) {
    ctools_include('common', 'panels');
    ctools_include('display-layout', 'panels');
    ctools_include('plugins', 'panels');

    // @todo -- figure out where/how to deal with this.
    $form_state['allowed_layouts'] = 'panels_mini';
    if ($form_state['op'] == 'add' && empty($form_state['item']->display)) {
      $form_state['item']->display = panels_new_display();
    }
    $form_state['display'] =& $form_state['item']->display;

    // Tell the Panels form not to display buttons.
    $form_state['no buttons'] = TRUE;

    // Change the #id of the form so the CSS applies properly.
    $form['#id'] = 'panels-choose-layout';
    $form = array_merge($form, panels_choose_layout($form_state));
    if ($form_state['op'] == 'edit') {
      $form['buttons']['next']['#value'] = t('Change');
    }
  }

  /**
   * Validate that a layout was chosen.
   */
  function edit_form_layout_validate(&$form, &$form_state) {
    $display =& $form_state['display'];
    if (empty($form_state['values']['layout'])) {
      form_error($form['layout'], t('You must select a layout.'));
    }
    if ($form_state['op'] == 'edit') {
      if ($form_state['values']['layout'] == $display->layout) {
        form_error($form['layout'], t('You must select a different layout if you wish to change layouts.'));
      }
    }
  }

  /**
   * A layout has been selected, set it up.
   */
  function edit_form_layout_submit(&$form, &$form_state) {
    $display =& $form_state['display'];
    if ($form_state['op'] == 'edit') {
      if ($form_state['values']['layout'] != $display->layout) {
        $form_state['item']->temp_layout = $form_state['values']['layout'];
        $form_state['clicked_button']['#next'] = 'move';
      }
    }
    else {
      $form_state['item']->display->layout = $form_state['values']['layout'];
    }
  }

  /**
   * When a layout is changed, the user is given the opportunity to move content.
   */
  function edit_form_move(&$form, &$form_state) {
    $form_state['display'] =& $form_state['item']->display;
    $form_state['layout'] = $form_state['item']->temp_layout;
    ctools_include('common', 'panels');
    ctools_include('display-layout', 'panels');
    ctools_include('plugins', 'panels');

    // Tell the Panels form not to display buttons.
    $form_state['no buttons'] = TRUE;

    // Change the #id of the form so the CSS applies properly.
    $form = array_merge($form, panels_change_layout($form_state));

    // This form is outside the normal wizard list, so we need to specify the
    // previous/next forms.
    $form['buttons']['previous']['#next'] = 'layout';
    $form['buttons']['next']['#next'] = 'content';
  }
  function edit_form_move_submit(&$form, &$form_state) {
    panels_change_layout_submit($form, $form_state);
  }
  function edit_form_content(&$form, &$form_state) {
    ctools_include('ajax');
    ctools_include('plugins', 'panels');
    ctools_include('display-edit', 'panels');
    ctools_include('context');

    // If we are cloning an item, we MUST have this cached for this to work,
    // so make sure:
    if ($form_state['form type'] == 'clone' && empty($form_state['item']->export_ui_item_is_cached)) {
      $this
        ->edit_cache_set($form_state['item'], 'clone');
    }
    $cache = panels_edit_cache_get('panels_mini:' . $this
      ->edit_cache_get_key($form_state['item'], $form_state['form type']));
    $form_state['renderer'] = panels_get_renderer_handler('editor', $cache->display);
    $form_state['renderer']->cache =& $cache;
    $form_state['display'] =& $cache->display;
    $form_state['content_types'] = $cache->content_types;

    // Tell the Panels form not to display buttons.
    $form_state['no buttons'] = TRUE;
    $form_state['display_title'] = !empty($cache->display_title);
    $form = array_merge($form, panels_edit_display_form($form_state));

    // Make sure the theme will work since our form id is different.
    $form['#theme'] = 'panels_edit_display_form';
  }
  function edit_form_content_submit(&$form, &$form_state) {
    panels_edit_display_form_submit($form, $form_state);
    $form_state['item']->display = $form_state['display'];
  }

}

Members

Namesort descending Modifiers Type Description Overrides
ctools_export_ui::$name property
ctools_export_ui::$options property
ctools_export_ui::$plugin property
ctools_export_ui::access function Menu callback to determine if an operation is accessible. 1
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_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_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::edit_wizard_finish function Wizard 'cancel' callback when using a wizard to edit an item. 1
ctools_export_ui::edit_wizard_next function Wizard 'next' callback when using a wizard to edit an item. 1
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::get_wizard_info function Get the form info for the wizard. 1
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::list_search_fields function Provide a list of fields to test against for the default "search" widget. 1
ctools_export_ui::set_item_state function Set an item's state to enabled or disabled and output to user.
panels_mini_ui::edit_form function Provide the actual editing form. Overrides ctools_export_ui::edit_form
panels_mini_ui::edit_form_basic_validate function Validate submission of the mini panel edit form.
panels_mini_ui::edit_form_content function
panels_mini_ui::edit_form_content_submit function
panels_mini_ui::edit_form_context function
panels_mini_ui::edit_form_context_submit function
panels_mini_ui::edit_form_layout function
panels_mini_ui::edit_form_layout_submit function A layout has been selected, set it up.
panels_mini_ui::edit_form_layout_validate function Validate that a layout was chosen.
panels_mini_ui::edit_form_move function When a layout is changed, the user is given the opportunity to move content.
panels_mini_ui::edit_form_move_submit function
panels_mini_ui::edit_form_submit function Handle the submission of the edit form. Overrides ctools_export_ui::edit_form_submit
panels_mini_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
panels_mini_ui::list_build_row function Build a row based on the item. Overrides ctools_export_ui::list_build_row
panels_mini_ui::list_filter function Determine if a row should be filtered out. Overrides ctools_export_ui::list_filter
panels_mini_ui::list_form function Create the filter/sort form at the top of a list of exports. Overrides ctools_export_ui::list_form
panels_mini_ui::list_sort_options function Provide a list of sort options. Overrides ctools_export_ui::list_sort_options
panels_mini_ui::list_table_header function Provide the table header. Overrides ctools_export_ui::list_table_header