display_edit.inc File Reference

(1.1.2.63 2008/08/03 04:34:01 sdboyer)

Go to the source code of this file.

Functions
	_panels_ajax_ct_preconfigure (&$cache, &$pane)
	_panels_edit ($display, $destination, $content_types)
	_panels_edit_layout ($display, $finish, $destination, $allowed_layouts)
	_panels_edit_layout_settings ($display, $finish, $destination, $title)
	_panels_js_files ()
	_panels_render_preview_pane_disabled ($pane, $context)
	panels_add_content ($cache, $panel_id)
	panels_ajax ($op=NULL, $did=NULL, $pid=NULL)
	panels_ajax_add_config ($did=NULL, $pane_info=NULL)
	panels_ajax_add_content ($did=NULL, $panel_id=NULL)
	panels_ajax_cache ($did=NULL, $pid=NULL)
	panels_ajax_cache_settings ($cache, $pid, $method=NULL)
	panels_ajax_configure ($did=NULL, $pid=NULL)
	panels_ajax_set_cache_data (&$display, $pid, $method, $settings=array())
	panels_ajax_toggle_shown ($did=NULL, $pid=NULL, $op=NULL)
	panels_change_layout (&$form, $display, $new_layout_id)
	panels_choose_layout ($display, $finish, $destination, $allowed_layouts)
	panels_choose_layout_submit ($form_id, $form_values)
	panels_common_style_settings_form ($did, $style, $style_settings)
	panels_common_style_settings_form_submit ($form_id, $form_values)
	panels_common_style_settings_form_validate ($form_id, $form_values, $form)
	panels_content_config_add_form_submit ($form_values, $cache, $pane)
	panels_content_config_edit_form_submit ($form_values, $cache, $pane)
	panels_content_config_form ($cache, $pane, $add=FALSE)
	panels_content_config_form_submit ($form_id, $form_values)
	panels_content_config_form_validate ($form_id, $form_values, $form)
	panels_edit_cache_method_form ($display, $pid)
	panels_edit_cache_method_form_submit ($form_id, $form_values)
	panels_edit_cache_settings_form ($display, $pid, $method, $settings_function)
	panels_edit_cache_settings_form_submit ($form_id, $form_values)
	panels_edit_cache_settings_form_validate ($form_id, $form_values, $form)
	panels_edit_display ($display, $destination)
	panels_edit_display_submit ($form_id, $form_values)
	panels_edit_layout_settings_form ($display, $finish, $destination, $title)
	panels_edit_layout_settings_form_submit ($form_id, $form_values)
	panels_edit_layout_settings_form_validate ($form_id, $form_values, $form)
	panels_edit_submit_subform ($display)
	panels_get_pane_edit_form ($pane, $contexts, $parents)
	panels_panel_settings ($display)
	panels_panel_settings_ajax ($did, $panel, $name)
	panels_panel_settings_submit ($form_id, $form_values)
	panels_panel_settings_validate ($form_id, $form_values, $form)
	panels_show_pane ($display, $pane, $left_buttons, $buttons, $skin=TRUE)
	theme_panels_dnd ($content)
	theme_panels_edit_display ($form)
	theme_panels_hidden ()
	theme_panels_pane_collapsible ($block)
	theme_panels_pane_dnd ($block, $id, $label, $left_buttons=NULL, $buttons=NULL)
	theme_panels_panel_dnd ($content, $region, $label, $footer)

---

Function Documentation

_panels_edit	(	$	display,
		$	destination,
		$	content_types
	)

Handle calling and processing of the form for editing display content.

Helper function for panels_edit().

See also:

panels_edit() for details on the various behaviors of this function.

Definition at line 19 of file display_edit.inc.

References panels_cache_clear(), panels_cache_get(), and panels_cache_set().

Referenced by panels_edit().

                                                              {
  $did = $display->did;
  if (!$did) {
    $display->did = $did = 'new';
  }

  // Load the display being edited from cache, if possible.
  if (!empty($_POST) && is_object($cache = panels_cache_get($did))) {
    $display = $cache->display;
  }
  else {
    panels_cache_clear($did);
    $cache = new stdClass();
    $cache->display = $display;
    $cache->content_types = $content_types;
    panels_cache_set($did, $cache);
  }

  // Break out the form pieces so we can return the new $display upon
  // successful submit.

  $form_id = 'panels_edit_display';
  $form = drupal_retrieve_form($form_id, $display, $destination);

  if ($result = drupal_process_form($form_id, $form)) {
    // successful submit
    return $result;
  }

  $output = drupal_render_form($form_id, $form);
  $output .= theme('panels_hidden');
  return $output;
}

Here is the call graph for this function:

Here is the caller graph for this function:

_panels_edit_layout	(	$	display,
		$	finish,
		$	destination,
		$	allowed_layouts
	)

Handle calling and processing of the form for editing display layouts.

Helper function for panels_edit_layout().

See also:

panels_edit_layout() for details on the various behaviors of this function.

Definition at line 261 of file display_edit.inc.

References panels_load_include().

Referenced by panels_edit_layout().

                                                                                {
  panels_load_include('common');
  // module_name has been provided; the data was saved by the api_save() method.
  if (is_string($allowed_layouts)) {
    $allowed_layouts = unserialize(variable_get($allowed_layouts . "_allowed_layouts", serialize('')));
  }
  // if no parameter was provided, or the variable_get failed
  if (!$allowed_layouts) {
    // tries to load the common panels allowed layouts
    $allowed_layouts = unserialize(variable_get('panels_common_allowed_layouts', serialize('')));
    if (!$allowed_layouts) {
      // still no dice. simply creates a dummy version where all layouts are allowed.
      $allowed_layouts = new panels_allowed_layouts();
      $allowed_layouts->allow_new = TRUE;
    }
  }
  // sanitize allowed layout listing; this is redundant if the $allowed_layouts param was null, but the data is cached anyway
  $allowed_layouts->sync_with_available();
  // Break out the form pieces so we can return the new $display upon
  // successful submit.
  $form_id = 'panels_choose_layout';
  $form = drupal_retrieve_form($form_id, $display, $finish, $destination, array_filter($allowed_layouts->allowed_layout_settings));

  if ($result = drupal_process_form($form_id, $form)) {
    // successful submit
    return $result;
  }
  $output = drupal_render_form($form_id, $form);
  return $output;
}

Here is the call graph for this function:

Here is the caller graph for this function:

_panels_edit_layout_settings	(	$	display,
		$	finish,
		$	destination,
		$	title
	)

Handle calling and processing of the form for editing display layout settings.

Helper function for panels_edit_layout_settings().

See also:

panels_edit_layout_settings() for details on the various behaviors of this function.

Definition at line 472 of file display_edit.inc.

Referenced by panels_edit_layout_settings().

                                                                               {
  // Break out the form pieces so we can return the new $display upon
  // successful submit.
  $form_id = 'panels_edit_layout_settings_form';
  $form = drupal_retrieve_form($form_id, $display, $finish, $destination, $title);

  if ($result = drupal_process_form($form_id, $form)) {
    // successful submit
    return $result;
  }
  $output = drupal_render_form($form_id, $form);
  return $output;
}

Here is the caller graph for this function:

_panels_js_files

(

)

Includes required JavaScript libraries.

Definition at line 1665 of file display_edit.inc.

References panels_get_path().

Referenced by theme_panels_edit_display().

                            {
  // while we don't use this directly some of our forms do.
  drupal_add_js('misc/collapse.js');
  drupal_add_js('misc/autocomplete.js');

  drupal_add_js(panels_get_path('js/lib/dimensions.js'));
  drupal_add_js(panels_get_path('js/lib/mc.js'));
  drupal_add_js(panels_get_path('js/lib/form.js'));
  drupal_add_js(array('panelsAjaxURL' => url('panels/ajax', NULL, NULL, TRUE)), 'setting');
  drupal_add_js(panels_get_path('js/display_editor.js'));
  drupal_add_js(panels_get_path('js/checkboxes.js'));
  drupal_add_js(panels_get_path('js/modal_forms.js'));
  drupal_add_css(panels_get_path('css/panels_dnd.css'));
  drupal_add_css(panels_get_path('css/panels_admin.css'));
}

Here is the call graph for this function:

Here is the caller graph for this function:

_panels_render_preview_pane_disabled	(	$	pane,
		$	context
	)

Provide filler content for dynamic pane previews in the editor, as they're just a bad idea to have anyway, and can also cause infinite recursion loops that render the editor inaccessible in some cases.

Definition at line 660 of file display_edit.inc.

References panels_get_pane_title().

Referenced by panels_content_config_edit_form_submit(), and panels_show_pane().

                                                               {
  $block = new stdClass();
  $block->title   = panels_get_pane_title($pane, $context);
  $block->content = '<em>' . t("Dynamic content previews have been disabled to improve performance and stability for this editing screen.") . '</em>';
  return $block;
}

Here is the call graph for this function:

Here is the caller graph for this function:

panels_ajax	(	$	op = NULL,
		$	did = NULL,
		$	pid = NULL
	)

Entry point into all ajax operations.

Parameters:

	string	$op The name of the edit operation being performed.
	integer	$did The id of the $display object being edited (if any).
	integer	$pid The id of the pane object being edited (if any).

Definition at line 678 of file display_edit.inc.

References panels_ajax_render(), panels_cache_get(), and panels_edit_submit_subform().

                                                           {
  switch ($op) {
    case 'submit-form':
      if ((is_numeric($did) || $did == 'new') && $cache = panels_cache_get($did)) {
        $output = panels_edit_submit_subform($cache->display);
      }
      break;

    default:
  }

  panels_ajax_render($output);
}

Here is the call graph for this function:

panels_change_layout	(	&$	form,
		$	display,
		$	new_layout_id
	)

Form definition for the display layout converter.

This form is only triggered if the user attempts to change the layout for a display that has already had content assigned to it. It allows the user to select where the panes located in to-be-deleted panels should be relocated to.

Parameters:

	array	$form A structured FAPI $form array.
	object	$display instanceof panels_display The panels_display object that was modified on the preceding display layout editing form.
	string	$new_layout_id A string containing the name of the layout the display is to be converted to. These strings correspond exactly to the filenames of the *.inc files in panels/layouts. So, if the new layout that's been selected is the 'Two Column bricks' layout, then $new_layout_id will be 'twocol_bricks', corresponding to panels/layouts/twocol_bricks.inc.

Definition at line 411 of file display_edit.inc.

References panels_get_layout(), panels_get_panels(), and panels_print_layout_icon().

Referenced by panels_choose_layout().

                                                                {
  $new_layout = panels_get_layout($new_layout_id);
  $new_layout_panels = panels_get_panels($new_layout, $display);

  $options = $new_layout_panels;
  $keys = array_keys($options);
  $default = $options[0];

  $old_layout = panels_get_layout($display->layout);

  $form['container'] = array(
    '#prefix' => '<div class="change-layout-display">',
    '#suffix' => '</div>',
  );

  $form['container']['old_layout'] = array(
    '#value' => panels_print_layout_icon($display->layout, $old_layout, check_plain($old_layout['title'])),
  );

  $form['container']['right_arrow'] = array(
    '#value' => theme('image', drupal_get_path('module', 'panels') . '/images/go-right.png'),
  );
  $form['container']['new_layout'] = array(
    '#value' => panels_print_layout_icon($new_layout_id, $new_layout, check_plain($new_layout['title'])),
  );

  $form['container-clearer'] = array(
    // TODO: FIx this ot use clear-block instead
    '#value' => '<div style="clear: both;"></div>',
  );

  $form['old'] = array(
    '#tree' => true,
    '#prefix' => '<div class="panels-layout-list">',
    '#suffix' => '</div>',
  );

  $old_layout_panels = panels_get_panels($old_layout, $display);
  foreach ($display->panels as $id => $content) {
    $form['old'][$id] = array(
      '#type' => 'select',
      '#title' => t('Move content in @layout to', array('@layout' => $old_layout_panels[$id])),
      '#options' => $options,
      '#default_value' => array_key_exists($id, $options) ? $id : $default,
    );
  }

  $form['back'] = array(
    '#type' => 'submit',
    '#value' => t('Back'),
  );
  return $form;
}

Here is the call graph for this function:

Here is the caller graph for this function:

panels_choose_layout	(	$	display,
		$	finish,
		$	destination,
		$	allowed_layouts
	)

Form definition for the display layout editor.

Definition at line 297 of file display_edit.inc.

References panels_change_layout(), panels_get_layouts(), panels_get_path(), and panels_print_layout_icon().

                                                                                 {
  $layouts = array();
  $available_layouts = panels_get_layouts();
  foreach ($available_layouts as $layout_key => $layout_settings) {
    if (!empty($allowed_layouts[$layout_key])) {
      $layouts[$layout_key] = $layout_settings;
    }
  }
  foreach ($layouts as $id => $layout) {
    $options[$id] = panels_print_layout_icon($id, $layout, check_plain($layout['title']));
  }

  drupal_add_js(panels_get_path('js/layout.js'));
  $form['layout'] = array(
    '#type' => 'radios',
    '#title' => t('Choose layout'),
    '#options' => $options,
    '#default_value' => in_array($display->layout, array_keys($layouts)) ? $display->layout : NULL,
    '#attributes' => array('class' => 'clear-block'),
  );

  $form['variables'] = array(
    '#type' => 'value',
    '#value' => array($display, $finish, $destination),
  );

  if (empty($destination)) {
    $form['#redirect'] = FALSE;
  }

  if ($_POST['op'] && $_POST['op'] != t('Back') && $display->content) {
    $form['#post'] = $_POST;
    $form = form_builder('panels_choose_layout', $form);
    unset($form['#post']);
    $form['layout']['#type'] = 'hidden';
    panels_change_layout($form, $display, $form['layout']['#value']);
  }

  if (($_POST['op'] && $_POST['op'] != t('Back')) || !$display->content) {
    $form['submit'] = array(
      '#type' => 'submit',
      '#value' => $finish,
    );
  }
  else {
    $form['submit'] = array(
      '#type' => 'submit',
      '#value' => t('Next'),
    );
  }

  // no token please
  $form['#token'] = FALSE;
  return $form;
}

Here is the call graph for this function:

panels_choose_layout_submit	(	$	form_id,
		$	form_values
	)

Handle form submission of the display layout editor.

The behavior of this function is fairly complex and irregular compared to most FAPI submit handlers. See the documentation on panels_edit_layout() for detailed discussion of this behavior.

Definition at line 360 of file display_edit.inc.

References panels_save_display().

                                                             {
  list($display, $finish, $destination) = $form_values['variables'];
  $new_layout_id = $form_values['layout'];

  if ($form_values['op'] == $finish) {
    if (!empty($form_values['old'])) {
      foreach ($form_values['old'] as $id => $new_id) {
        $content[$new_id] = array_merge((array) $content[$new_id], $display->panels[$id]);
        foreach ($content[$new_id] as $pid) {
          $display->content[$pid]->panel = $new_id;
        }
      }

      $display->panels = $content;
    }

    $display->layout = $new_layout_id;

    // save it back to our session.
    panels_save_display($display);
    if (empty($destination)) {
      return $display;
    }

    return $destination;
  }

  return FALSE;
}

Here is the call graph for this function:

panels_common_style_settings_form_submit	(	$	form_id,
		$	form_values
	)

Allows panel styles to validate their style settings.

Definition at line 1652 of file display_edit.inc.

                                                                          {
  $style = $form_values['style'];

  if (isset($style['settings form submit']) && function_exists($style['settings form submit'])) {
    $style['settings form submit']($form_values['style_settings']);
  }

  return $form_values['style_settings'];
}

panels_common_style_settings_form_validate	(	$	form_id,
		$	form_values,
		$	form
	)

Allows panel styles to validate their style settings.

Definition at line 1641 of file display_edit.inc.

                                                                                   {
  $style = $form_values['style'];

  if (isset($style['settings form validate']) && function_exists($style['settings form validate'])) {
    $style['settings form validate']($form, $form_values['style_settings']);
  }
}

panels_content_config_add_form_submit	(	$	form_values,
		$	cache,
		$	pane
	)

Definition at line 1141 of file display_edit.inc.

References panels_add_button(), panels_get_caches(), and panels_show_pane().

                                                                            {
  $ajax_vars = new stdClass();
  $ajax_vars->type   = 'add';
  $ajax_vars->region = $cache->content_config[$pane->pid]['panel_id'];

  $cache->display->panels[$cache->content_config[$pane->pid]['panel_id']][] = $pane->pid;
  $cache->display->content[$pane->pid]->shown = TRUE;

  // we need to fake the buttons a little.
  // new panes are shown by default
  $buttons['configure'] = panels_add_button('icon-configure.png', t('Configure'), t('Configure this pane'), 'pane-configure');
  $buttons['configure']['#parents'] = array('button', $pane->pid, 'configure');

  if (panels_get_caches() && user_access('use panels caching features')) {
    $buttons['cache'] = panels_add_button('icon-cache.png', t('Caching'), t('Control caching'), 'pane-cache');
    $buttons['cache']['#parents'] = array('button', $pane->pid, 'cache');
  }

  $buttons['show_hide'] = panels_add_button('icon-hidepane.png', t('Show/Hide Toggle'), t('Hide this pane'), 'pane-toggle-shown');
  $buttons['show_hide']['#parents'] = array('button', $pane->pid, 'show_hide');

  $buttons['delete'] = panels_add_button('icon-delete.png', t('Delete'), t('Remove this pane'), 'pane-delete');
  $buttons['delete']['#parents'] = array('button', $pane->pid, 'delete');

  $buttons = form_builder('dummy', $buttons);

  // Render the new pane for the javascript.
  $ajax_vars->output = panels_show_pane($cache->display, $cache->display->content[$pane->pid], NULL, drupal_render($buttons));
  return $ajax_vars;
}

Here is the call graph for this function:

panels_content_config_form_validate	(	$	form_id,
		$	form_values,
		$	form
	)

FAPI validator for panels_content_config_form().

Call any validation functions defined by the content type.

Definition at line 1084 of file display_edit.inc.

References panels_ct_pane_validate_form().

                                                                            {
  list($cache, $pane, $add, $op) = $form_values['vars'];
  panels_ct_pane_validate_form($pane->type, $form['configuration'], $form_values['configuration'], $op);
}

Here is the call graph for this function:

panels_edit_cache_settings_form_validate	(	$	form_id,
		$	form_values,
		$	form
	)

Validate cache settings.

Definition at line 1351 of file display_edit.inc.

References panels_plugin_get_function().

                                                                                 {
  if ($function = panels_plugin_get_function('cache', $form_values['method'], 'settings form validate')) {
    $function($form, $form_values['settings']);
  }
}

Here is the call graph for this function:

panels_edit_display	(	$	display,
		$	destination
	)

Form definition for the panels display editor

No validation function is necessary, as all 'validation' is handled either in the lead-up to form rendering (through the selection of specified content types) or by the validation functions specific to the ajax modals & content types.

See also:

panels_edit_display_submit()

Definition at line 64 of file display_edit.inc.

References panels_add_button(), panels_get_caches(), panels_get_layout(), panels_get_panels(), and panels_get_path().

                                                     {
  $form['did'] = array(
    '#type' => 'hidden',
    '#value' => $display->did,
    '#id' => 'panel-did',
  );

  $form['op'] = array(
    '#type' => 'hidden',
    '#id' => 'panel-op',
  );

  $form['panels_display'] = array(
    '#type' => 'value',
    '#value' => $display,
  );

  if (!empty($destination)) {
    $form['destination'] = array(
      '#type' => 'value',
      '#value' => $destination,
    );
  }
  else {
    $form['#redirect'] = FALSE;
  }

  $explanation_text = '<p>';
  $explanation_text .= t('Grab the title bar of any pane to drag-and-drop it into another panel. Click the add pane button (!addicon) in any panel to add more content. Click the configure (!configicon) button on any pane to re-configure that pane. Click the cache (!cacheicon) button to configure caching for that pane specifically. Click the show/hide (!showicon/!hideicon) toggle button to show or hide that pane. Panes hidden in this way will be hidden from <em>everyone</em> until the hidden status is toggled off.',
    array(
      '!addicon' => '<span class="inline-icon-help">' . theme('image', panels_get_path('images/icon-addcontent.png'), t('Add content to this panel'), t('Add content to this panel')) . '</span>',
      '!configicon' => '<span class="inline-icon-help">' . theme('image', panels_get_path('images/icon-configure.png'), t('Configure this pane'), t('Configure this pane')) . '</span>',
      '!cacheicon' => '<span class="inline-icon-help">' . theme('image', panels_get_path('images/icon-cache.png'), t('Control caching'), t('Control caching')) . '</span>',
      '!showicon' => '<span class="inline-icon-help">' . theme('image', panels_get_path('images/icon-showpane.png'), t('Show this pane'), t('Show this pane')) . '</span>',
      '!hideicon' => '<span class="inline-icon-help">' . theme('image', panels_get_path('images/icon-hidepane.png'), t('Hide this pane'), t('Hide this pane')) . '</span>',
    )
  );
  $explanation_text .= '</p>';

  $form['explanation'] = array(
    '#value' => $explanation_text,
  );

  $layout = panels_get_layout($display->layout);
  $layout_panels = panels_get_panels($layout, $display);

  $form['button']['#tree'] = TRUE;
  $caches = panels_get_caches();

  foreach ($display->content as $pid => $pane) {
    // This test ensures we don't put anything for panes that are in panels
    // that don't exist -- as can happen when flexible changes.
    if ($layout_panels[$pane->panel]) {
      $form['button'][$pid]['#tree'] = TRUE;
      if ($caches && user_access('use panels caching features')) {
        $form['button'][$pid]['cache'] = panels_add_button('icon-cache.png', t('Caching'), t('Control caching'), 'pane-cache');
      }
      $form['button'][$pid]['show_hide'] = panels_add_button($pane->shown ? 'icon-hidepane.png' : 'icon-showpane.png', t('Show/Hide Toggle'), $pane->shown ? t('Hide this pane') : t('Show this pane'), 'pane-toggle-shown');
      $form['button'][$pid]['configure'] = panels_add_button('icon-configure.png', t('Configure'), t('Configure this pane'), 'pane-configure');
      $form['button'][$pid]['delete'] = panels_add_button('icon-delete.png', t('Delete'), t('Remove this pane'), 'pane-delete');
    }
  }

  foreach ($layout_panels as $id => $name) {
    $form['panels'][$id]['add'] = panels_add_button('icon-addcontent.png', t('Add content'), t('Add content to this panel'), 'pane-add', "pane-add-$id");
  }

  $form['panel'] = array('#tree' => TRUE);
  $form['panel']['pane'] = array('#tree' => TRUE);

  foreach ($layout_panels as $panel_id => $title) {
    $form['panel']['pane'][$panel_id] = array(
      // Use 'hidden' instead of 'value' so the js can access it.
      '#type' => 'hidden',
      '#default_value' => implode(',', (array) $display->panels[$panel_id]),
    );
  }
  $form['submit'] = array(
    '#type' => 'submit',
    '#value' => t('Save'),
    '#id' => 'panels-dnd-save',
  );
  $form['cancel'] = array(
    '#type' => 'submit',
    '#value' => t('Cancel'),
  );

  $form['hide'] = array(
    '#prefix' => '<span id="panels-js-only">',
    '#suffix' => '</span>',
  );

  $form['hide']['hide-all'] = array(
    '#type' => 'submit',
    '#value' => t('Hide all'),
    '#id' => 'panels-hide-all',
  );

  $form['hide']['show-all'] = array(
    '#type' => 'submit',
    '#value' => t('Show all'),
    '#id' => 'panels-show-all',
  );

  $form['hide']['cache-settings'] = array(
    '#type' => 'submit',
    '#value' => t('Cache settings'),
    '#id' => 'panels-cache-settings',
  );

  return $form;
}

Here is the call graph for this function:

panels_edit_display_submit	(	$	form_id,
		$	form_values
	)

Handle form submission of the display content editor.

The behavior of this function is fairly complex and irregular compared to most FAPI submit handlers. See the documentation on panels_edit() for a detailed discussion of this behavior.

Definition at line 224 of file display_edit.inc.

References panels_cache_clear(), and panels_save_display().

                                                            {
  $display = $form_values['panels_display'];
  if ($form_values['op'] == t('Save')) {
    $old_content = $display->content;
    $display->content = array();

    foreach ($form_values['panel']['pane'] as $panel_id => $panes) {
      $display->panels[$panel_id] = array();
      if ($panes) {
        $pids = explode(',', $panes);
        // need to filter the array, b/c passing it in a hidden field can generate trash
        foreach (array_filter($pids) as $pid) {
          if ($old_content[$pid]) {
            $display->panels[$panel_id][] = $pid;
            $old_content[$pid]->panel = $panel_id;
            $display->content[$pid] = $old_content[$pid];
          }
        }
      }
    }
    drupal_set_message(t('Panel content has been updated.'));
    panels_save_display($display);
  }

  panels_cache_clear($display->did);
  if (empty($form_values['destination'])) {
    return $display;
  }
}

Here is the call graph for this function:

panels_edit_layout_settings_form	(	$	display,
		$	finish,
		$	destination,
		$	title
	)

Form definition for the display layout settings editor.

See also:

panels_edit_layout_settings_form_validate()

panels_edit_layout_settings_form_submit()

Definition at line 493 of file display_edit.inc.

References panels_get_layout(), and panels_panel_settings().

                                                                                   {
  $layout = panels_get_layout($display->layout);
  $form = array();
  if (!empty($layout['settings form']) && function_exists($layout['settings form'])) { // TODO doc the ability to do this as part of the API
    $form['layout_settings'] = $layout['settings form']($display, $layout, $display->layout_settings);
    $form['layout_settings']['#tree'] = TRUE;
  }

  if ($title) {
    $form['display_title'] = array (
      '#type' => 'fieldset',
      '#title' => t('Panel Title'),
      '#tree' => TRUE,
    );

    $form['display_title']['title'] = array(
      '#type' => 'textfield',
      '#size' => 35,
      '#default_value' => $display->title,
      '#title' => t('Title'),
      '#description' => t('The title of this panel. Your theme will render this text as the main page title when a user views this panel. Note that there are some circumstances in which this title can be overridden elsewhere.'),
    );

    $form['display_title']['hide_title'] = array(
      '#type' => 'checkbox',
      '#title' => t('Hide Title?'),
      '#default_value' => $display->hide_title,
      '#description' => t('Check this box to hide the main page title for this panel.'),
    );

    if (is_string($title)) {
      $form['display_title']['title']['#description'] .= t(" If you leave this field blank, then the default title, '@title', will be used instead.", array('@title' => $title));
    }
  }

  $form += panels_panel_settings($display);

  $form['variables'] = array(
    '#type' => 'value',
    '#value' => array($display, $finish, $destination, $title),
  );

  if (empty($destination)) {
    $form['#redirect'] = FALSE;
  }

  $form['layout'] = array(
    '#type' => 'value',
    '#value' => $layout,
  );

  // Always show a Save button even if they sent in a Next or something similar
  // button.
  if ($finish !== t('Save')) {
    $form['save'] = array(
      '#type' => 'submit',
      '#value' => t('Save'),
    );
  }

  $form['submit'] = array(
    '#type' => 'submit',
    '#value' => $finish,
  );


  return $form;
}

Here is the call graph for this function:

panels_edit_layout_settings_form_submit	(	$	form_id,
		$	form_values
	)

Definition at line 571 of file display_edit.inc.

References panels_panel_settings_submit(), and panels_save_display().

                                                                         {
  list($display, $finish, $destination, $title) = $form_values['variables'];
  panels_panel_settings_submit($form_id, $form_values);

  $layout = $form_values['layout'];
  if (!empty($layout['settings submit']) && function_exists($layout['settings submit'])) {
    $layout['settings submit']($form_values['layout_settings'], $display, $layout, $display->layout_settings);
  }

  if (isset($form_values['display_title']['title'])) {
    $display->title = $form_values['display_title']['title'];
    $display->hide_title = $form_values['display_title']['hide_title'];
  }

  if ($form_values['op'] == $finish || $form_values['op'] == t('Save')) {
    $display->layout_settings = $form_values['layout_settings'];
    $display->panel_settings = $form_values['panel_settings'];

    panels_save_display($display);
    drupal_set_message("Your layout settings have been saved.");
    if ($form_values['op'] != $finish) {
      // This forces us to come back here if they hit Save.
      $_REQUEST['destination'] = $_GET['q'];
    }
    if (empty($destination)) {
      return $display;
    }
    return $destination;
  }
}

Here is the call graph for this function:

panels_edit_layout_settings_form_validate	(	$	form_id,
		$	form_values,
		$	form
	)

Definition at line 562 of file display_edit.inc.

References panels_panel_settings_validate().

                                                                                  {
  list($display, $finish, $destination) = $form_values['variables'];
  panels_panel_settings_validate($form_id, $form_values, $form);
  $layout = $form_values['layout'];
  if (!empty($layout['settings validate']) && function_exists($layout['settings validate'])) {
    $layout['settings validate']($form_values['layout_settings'], $form['layout_settings'], $display, $layout, $display->layout_settings);
  }
}

Here is the call graph for this function:

panels_get_pane_edit_form	(	$	pane,
		$	contexts,
		$	parents
	)

Display the edit form for a pane.

Parameters:

	$pane	The pane to edit.
	$parents	The form api parents array that this subform will live in.

Definition at line 610 of file display_edit.inc.

                                                               {
  return panels_ct_get_edit_form($pane->type, $pane->subtype, $contexts, $pane->configuration, $parents);
}

panels_panel_settings_submit	(	$	form_id,
		$	form_values
	)

Definition at line 1562 of file display_edit.inc.

References panels_common_cache_clear().

Referenced by panels_edit_layout_settings_form_submit().

                                                              {
  panels_common_cache_clear('style_settings', $form_values['panel_settings']['did']);
}

Here is the call graph for this function:

Here is the caller graph for this function:

panels_panel_settings_validate	(	$	form_id,
		$	form_values,
		$	form
	)

ends PanelsAjax group

Definition at line 1557 of file display_edit.inc.

References panels_common_cache_get().

Referenced by panels_edit_layout_settings_form_validate().

                                                                       {
  $settings = panels_common_cache_get('style_settings', $form_values['panel_settings']['did']);
  form_set_value($form['panel_settings']['style_settings'], $settings);
}

Here is the call graph for this function:

Here is the caller graph for this function:

panels_show_pane	(	$	display,
		$	pane,
		$	left_buttons,
		$	buttons,
		$	skin = TRUE
	)

Render a single pane in the edit environment.

Parameters:

	$pane	The pane to render.
	$left_buttons	Buttons that go on the left side of the pane.
	$buttons	Buttons that go on the right side of the pane.
	$skin	If true, provide the outside div. Used to provide an easy way to get just the innards for ajax replacement

Definition at line 628 of file display_edit.inc.

References _panels_render_preview_pane_disabled(), panels_get_content_type(), and panels_get_pane_title().

Referenced by panels_content_config_add_form_submit(), and theme_panels_edit_display().

                                                                                  {
  $content_type = panels_get_content_type($pane->type);
  $block = new stdClass();
  if (empty($content_type)) {
    $block->title = '<em>' . t('Missing content type') . '</em>';
    $block->content = t('This pane\'s content type is either missing or has been deleted. This pane will not render.');
  }
  elseif (function_exists($content_type['editor render callback'])) {
    $block = $content_type['editor render callback']($display, $pane);
  }
  else {
    $block = _panels_render_preview_pane_disabled($pane, $display->context);
  }

  // This is just used for the title bar of the pane, not the content itself.
  // If we know the content type, use the appropriate title for that type,
  // otherwise, set the title using the content itself.
  $title = !empty($content_type) ? panels_get_pane_title($pane, $display->context) : $block->title;
  $output = theme('panels_pane_dnd', $block, $pane->pid, $title, $left_buttons, $buttons);
  if ($skin) {
    $class = 'panel-pane' . ($pane->shown ? '' : ' hidden-pane');
    $output = '<div class="' . $class . '" id="panel-pane-' . $pane->pid . '">' . $output . '</div>';
  }
  return $output;
}

Here is the call graph for this function:

Here is the caller graph for this function:

theme_panels_dnd

(

$

content

)

Definition at line 1685 of file display_edit.inc.

                                    {
  $output = "<div class=\"panels-dnd\" id=\"panels-dnd-main\">$content</div>";
  return $output;
}

theme_panels_edit_display

(

$

form

)

Theme the form for editing display content.

Parameters:

array

$form A structured FAPI $form array.

Returns:

string $output HTML ready to be rendered. Note that the html produced here should be printed, not returned, as it bypasses block rendering. Block rendering must be bypassed because sidebars created using negative margins break ajax drag-and-drop.

Definition at line 190 of file display_edit.inc.

References _panels_js_files(), panels_get_layout(), panels_get_panels(), panels_render_layout(), and panels_show_pane().

                                          {
  _panels_js_files();
  $display = $form['panels_display']['#value'];
  $layout = panels_get_layout($display->layout);
  $layout_panels = panels_get_panels($layout, $display);
  $save_buttons = drupal_render($form['submit']) . drupal_render($form['cancel']);

  foreach ($layout_panels as $panel_id => $title) {
    foreach ((array) $display->panels[$panel_id] as $pid) {
      $pane = $display->content[$pid];
      $left_buttons = NULL;
      $buttons = drupal_render($form['button'][$pid]['configure']);
      if (!empty($form['button'][$pid]['cache'])) {
        $buttons .= drupal_render($form['button'][$pid]['cache']);
      }
      $buttons .= drupal_render($form['button'][$pid]['show_hide']);
      $buttons .= drupal_render($form['button'][$pid]['delete']);
      $content[$pane->panel] .= panels_show_pane($display, $pane, $left_buttons, $buttons);
    }
    $content[$panel_id] = theme('panels_panel_dnd', $content[$panel_id], $panel_id, $title, drupal_render($form['panels'][$panel_id]['add']));
  }
  $output .= drupal_render($form);
  $output .= theme('panels_dnd', panels_render_layout($layout, $content, '', $display->layout_settings));
  $output .= $save_buttons;
  return $output;
}

Here is the call graph for this function:

theme_panels_hidden

(

)

This is separate because it must be outside the <form> to work, and everything in the form theme is inside the form.

Definition at line 1727 of file display_edit.inc.

References panels_get_path().

                               {
  $close_text     = t('Close Window');
  $close_image    = theme('image', panels_get_path('images/icon-delete.png'), t('Close window'), t('Close window'));
  $throbber_image = theme('image', panels_get_path('images/throbber.gif'), t('Loading...'), t('Loading'));
  $output         = <<<EOF
<div class="panels-hidden">\n
  <div id="panels-modal">\n
    <div class="panels-modal-content">\n
       <div class="modal-header">\n
         <a class="close" href="#">$close_text $close_image</a>\n
         <span class="modal-title">&nbsp;</span>\n
       </div>\n
       <div class="modal-content">\n
       </div>\n
    </div>\n
  </div>\n
  <div id="panels-throbber">\n
    <div class="panels-throbber-wrapper">
      $throbber_image\n
    </div>
  </div>\n
</div>\n
EOF;

  return $output;
}

Here is the call graph for this function:

theme_panels_pane_collapsible

(

$

block

)

Definition at line 1716 of file display_edit.inc.

                                               {
  $output .= '<h2 class="title">' . $block->title . '</h2>';
  $output .= '<div class="content">' . filter_xss_admin($block->content) . '</div>';
  return $output;
}

theme_panels_pane_dnd	(	$	block,
		$	id,
		$	label,
		$	left_buttons = NULL,
		$	buttons = NULL
	)

Definition at line 1696 of file display_edit.inc.

                                                                                           {
  if (!$block->title) {
    $block->title = t('No title');
  }
  static $count = 0;
  $output .= "<div class=\"grabber\">";
  if ($buttons) {
    $output .= "<span class='buttons'>$buttons</span>";
  }
  if ($left_buttons) {
    $output .= "<span class='left_buttons'>$left_buttons</span>";
  }
  $output .= "<span class=\"text\">$label</span></div>";
  $output .= '<div class="panel-pane-collapsible">';
  $output .= theme('panels_pane_collapsible', $block);
  $output .= '</div>';
  return $output;
}

theme_panels_panel_dnd	(	$	content,
		$	region,
		$	label,
		$	footer
	)

Definition at line 1691 of file display_edit.inc.

                                                                    {
  return "<div class=\"panels-display\" id=\"panel-pane-$region\">$footer<h2 class=\"label\">$label</h2>$content</div>";
}