class panels_layouts_ui in Panels 7.3

@file Contains the administrative UI for reusable layouts.

Hierarchy

• class \ctools_export_ui
  • class \panels_layouts_ui

2 string references to 'panels_layouts_ui'

panels_layouts.inc in plugins/export_ui/panels_layouts.inc

panels_layouts_ui::edit_form in plugins/export_ui/panels_layouts_ui.class.php

Provide the actual editing form.

File

plugins/export_ui/panels_layouts_ui.class.php, line 7

Contains the administrative UI for reusable layouts.

class panels_layouts_ui extends ctools_export_ui {
  var $lipsum = "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nam egestas congue nibh, vel dictum ante posuere vitae. Cras gravida massa tempor metus eleifend sed elementum tortor scelerisque. Vivamus egestas, tortor quis luctus tristique, sem velit adipiscing risus, et tempus enim felis in massa. Morbi viverra, nisl quis rhoncus imperdiet, turpis massa vestibulum turpis, egestas faucibus nibh metus vel nunc. In hac habitasse platea dictumst. Nunc sit amet nisi quis ipsum tincidunt semper. Donec ac urna enim, et placerat arcu. Morbi eu laoreet justo. Nullam nec velit eu neque mattis pulvinar sed non libero. Sed sed vulputate erat. Fusce sit amet dui nibh.";
  function hook_menu(&$items) {

    // During updates, this can run before our schema is set up, so our
    // plugin can be empty.
    if (empty($this->plugin['menu']['items']['add'])) {
      return;
    }

    // Change the item to a tab on the Panels page.
    $this->plugin['menu']['items']['list callback']['type'] = MENU_LOCAL_TASK;

    // Establish a base for adding plugins.
    $base = $this->plugin['menu']['items']['add'];

    // Remove the default 'add' menu item.
    unset($this->plugin['menu']['items']['add']);
    ctools_include('plugins', 'panels');
    $this->builders = panels_get_layout_builders();
    asort($this->builders);
    foreach ($this->builders as $name => $builder) {

      // Create a new menu item for the builder.
      $item = $base;
      $item['title'] = !empty($builder['builder tab title']) ? $builder['builder tab title'] : 'Add ' . $builder['title'];
      $item['page arguments'][] = $name;
      $item['path'] = 'add-' . $name;
      $this->plugin['menu']['items']['add ' . $name] = $item;
    }
    parent::hook_menu($items);
  }
  function edit_form(&$form, &$form_state) {
    ctools_include('plugins', 'panels');

    // If the plugin is not set, then it should be provided as an argument:
    if (!isset($form_state['item']->plugin)) {
      $form_state['item']->plugin = $form_state['function args'][2];
    }
    parent::edit_form($form, $form_state);
    $form['category'] = array(
      '#type' => 'textfield',
      '#title' => t('Category'),
      '#description' => t('What category this layout should appear in. If left blank the category will be "Miscellaneous".'),
      '#default_value' => $form_state['item']->category,
    );
    ctools_include('context');
    ctools_include('display-edit', 'panels');
    ctools_include('content');

    // Provide actual layout admin UI here.
    // Create a display for editing:
    $cache_key = 'builder-' . $form_state['item']->name;

    // Load the display being edited from cache, if possible.
    if (!empty($_POST) && is_object($cache = panels_edit_cache_get($cache_key))) {
      $display =& $cache->display;
    }
    else {
      $content_types = ctools_content_get_available_types();
      panels_cache_clear('display', $cache_key);
      $cache = new stdClass();
      $display = panels_new_display();
      $display->did = $form_state['item']->name;
      $display->layout = $form_state['item']->plugin;
      $display->layout_settings = $form_state['item']->settings;
      $display->cache_key = $cache_key;
      $display->editing_layout = TRUE;
      $display->storage_type = 'panels_layouts_ui';
      $display->storage_id = 'panels_layouts_ui';
      $cache->display = $display;
      $cache->content_types = $content_types;
      $cache->display_title = FALSE;
      panels_edit_cache_set($cache);
    }

    // Set up lipsum content in all of the existing panel regions:
    $display->content = array();
    $display->panels = array();
    $custom = ctools_get_content_type('custom');
    $layout = panels_get_layout($display->layout);
    $regions = panels_get_regions($layout, $display);
    foreach ($regions as $id => $title) {
      $pane = panels_new_pane('custom', 'custom');
      $pane->pid = $id;
      $pane->panel = $id;
      $pane->configuration = ctools_content_get_defaults($custom, 'custom');
      $pane->configuration['title'] = 'Lorem Ipsum';
      $pane->configuration['body'] = $this->lipsum;
      $display->content[$id] = $pane;
      $display->panels[$id] = array(
        $id,
      );
    }
    $form_state['display'] =& $display;

    // Tell the Panels form not to display buttons.
    $form_state['no buttons'] = TRUE;
    $form_state['no display settings'] = TRUE;
    $form_state['cache_key'] = $cache_key;
    $form_state['content_types'] = $cache->content_types;
    $form_state['display_title'] = FALSE;
    $form_state['renderer'] = panels_get_renderer_handler('editor', $cache->display);
    $form_state['renderer']->cache =& $cache;
    $form = panels_edit_display_form($form, $form_state);

    // If we leave the standard submit handler, it'll try to reconcile
    // content from the input, but we've not exposed that to the user. This
    // makes previews work with the content we forced in.
    $form['preview']['button']['#submit'] = array(
      'panels_edit_display_form_preview',
    );
  }
  function edit_form_submit(&$form, &$form_state) {
    parent::edit_form_submit($form, $form_state);

    // While we short circuited the main submit hook, we need to keep this one.
    panels_edit_display_settings_form_submit($form, $form_state);
    $form_state['item']->settings = $form_state['display']->layout_settings;
  }
  function edit_form_validate(&$form, &$form_state) {
    parent::edit_form_validate($form, $form_state);

    // While we short circuited the main validate hook, we need to keep this one.
    panels_edit_display_settings_form_validate($form, $form_state);
  }
  function list_form(&$form, &$form_state) {
    ctools_include('plugins', 'panels');
    $this->builders = panels_get_layout_builders();
    parent::list_form($form, $form_state);
    $categories = $plugins = array(
      'all' => t('- All -'),
    );
    foreach ($this->items as $item) {
      $categories[$item->category] = $item->category ? $item->category : t('Miscellaneous');
    }
    $form['top row']['category'] = array(
      '#type' => 'select',
      '#title' => t('Category'),
      '#options' => $categories,
      '#default_value' => 'all',
      '#weight' => -10,
    );
    foreach ($this->builders as $name => $plugin) {
      $plugins[$name] = $plugin['title'];
    }
    $form['top row']['plugin'] = array(
      '#type' => 'select',
      '#title' => t('Type'),
      '#options' => $plugins,
      '#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']['plugin'] != 'all' && $form_state['values']['plugin'] != $item->plugin) {
      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'),
      'plugin' => t('Type'),
    );
  }
  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('Miscellaneous')) . $item->admin_title;
        break;
      case 'plugin':
        $this->sorts[$item->name] = $item->plugin;
        break;
      case 'storage':
        $this->sorts[$item->name] = $item->type . $item->admin_title;
        break;
    }
    $type = !empty($this->builders[$item->plugin]) ? $this->builders[$item->plugin]['title'] : t('Broken/missing plugin');
    $category = $item->category ? check_plain($item->category) : t('Miscellaneous');
    $ops = theme('links__ctools_dropbutton', array(
      'links' => $operations,
      'attributes' => array(
        'class' => array(
          'links',
          'inline',
        ),
      ),
    ));
    $this->rows[$item->name] = array(
      'data' => array(
        array(
          'data' => check_plain($type),
          'class' => array(
            'ctools-export-ui-type',
          ),
        ),
        array(
          'data' => check_plain($item->name),
          'class' => array(
            'ctools-export-ui-name',
          ),
        ),
        array(
          'data' => check_plain($item->admin_title),
          'class' => array(
            'ctools-export-ui-title',
          ),
        ),
        array(
          'data' => $category,
          'class' => array(
            'ctools-export-ui-category',
          ),
        ),
        array(
          'data' => $ops,
          'class' => array(
            'ctools-export-ui-operations',
          ),
        ),
      ),
      'title' => check_plain($item->admin_description),
      'class' => array(
        !empty($item->disabled) ? 'ctools-export-ui-disabled' : 'ctools-export-ui-enabled',
      ),
    );
  }
  function list_table_header() {
    return array(
      array(
        'data' => t('Type'),
        'class' => array(
          'ctools-export-ui-type',
        ),
      ),
      array(
        'data' => t('Name'),
        'class' => array(
          'ctools-export-ui-name',
        ),
      ),
      array(
        'data' => t('Title'),
        'class' => array(
          'ctools-export-ui-title',
        ),
      ),
      array(
        'data' => t('Category'),
        'class' => array(
          'ctools-export-ui-category',
        ),
      ),
      array(
        'data' => t('Operations'),
        'class' => array(
          'ctools-export-ui-operations',
        ),
      ),
    );
  }

}

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_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_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::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_footer	public	function	Render a footer to go after thie list.
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.
panels_layouts_ui::$lipsum		property
panels_layouts_ui::edit_form		function	Provide the actual editing form. Overrides ctools_export_ui::edit_form
panels_layouts_ui::edit_form_submit		function	Handle the submission of the edit form. Overrides ctools_export_ui::edit_form_submit
panels_layouts_ui::edit_form_validate		function	Validate callback for the edit form. Overrides ctools_export_ui::edit_form_validate
panels_layouts_ui::hook_menu		function	hook_menu() entry point. Overrides ctools_export_ui::hook_menu
panels_layouts_ui::list_build_row		function	Build a row based on the item. Overrides ctools_export_ui::list_build_row
panels_layouts_ui::list_filter		function	Determine if a row should be filtered out. Overrides ctools_export_ui::list_filter
panels_layouts_ui::list_form		function	Create the filter/sort form at the top of a list of exports. Overrides ctools_export_ui::list_form
panels_layouts_ui::list_sort_options		function	Provide a list of sort options. Overrides ctools_export_ui::list_sort_options
panels_layouts_ui::list_table_header		function	Provide the table header. Overrides ctools_export_ui::list_table_header