TRUE, 'views' => TRUE, 'other' => TRUE);
$skip = TRUE;
}
foreach ($content_types as $id => $info) {
if (empty($info['single'])) {
$default_options[$id] = t('New @s', array('@s' => $info['title']));
}
}
$default_options['other'] = t('New content of other types');
$form['panels_common_default'] = array(
'#type' => 'checkboxes',
'#title' => t('New content behavior'),
'#description' => t('Select the default behavior of new content added to the system. If checked, new content will automatically be immediately available to be added to Panels pages. If not checked, new content will not be available until specifically allowed here.'),
'#options' => $default_options,
'#default_value' => array_keys(array_filter($default_types)),
);
if ($skip) {
$form['markup'] = array('#value' => t('Click Submit to be presented with a complete list of available content types set to the defaults you selected.
'));
$form['skip'] = array('#type' => 'value', '#value' => TRUE);
}
else {
// Rebuild the entire list, setting appropriately from defaults. Give
// each type its own checkboxes set unless it's 'single' in which
// case it can go into our fake other set.
$available_content_types = panels_get_all_content_types();
$allowed_content_types = variable_get($module_name . '_allowed_types', array());
foreach ($available_content_types as $id => $types) {
foreach ($types as $type => $info) {
$key = $id . '-' . $type;
$checkboxes = empty($content_types[$id]['single']) ? $id : 'other';
$options[$checkboxes][$key] = $info['title'];
if (!isset($allowed_content_types[$key])) {
$allowed[$checkboxes][$key] = isset($default_types[$id]) ? $default_types[$id] : $default_types['other'];
}
else {
$allowed[$checkboxes][$key] = $allowed_content_types[$key];
}
}
}
$form['content_types'] = array('#tree' => TRUE);
// cheat a bit
$content_types['other'] = array('title' => t('Other'), 'weight' => 10);
foreach ($content_types as $id => $info) {
if (isset($allowed[$id])) {
$form['content_types'][$id] = array(
'#prefix' => '',
'#suffix' => '
',
'#type' => 'checkboxes',
'#title' => t('Allowed @s content', array('@s' => $info['title'])),
'#options' => $options[$id],
'#default_value' => array_keys(array_filter($allowed[$id])),
);
}
}
}
$form['module_name'] = array(
'#type' => 'value',
'#value' => $module_name,
);
$form['submit'] = array(
'#type' => 'submit',
'#value' => t('Submit'),
);
drupal_add_css(panels_get_path('css/panels_page.css'));
return $form;
}
/**
* Submit hook for panels_common_settings
*/
function panels_common_settings_submit($form_id, $form_values) {
$module_name = $form_values['module_name'];
variable_set($module_name . '_default', $form_values['panels_common_default']);
if (!$form_values['skip']) {
// merge the broken apart array neatly back together
variable_set($module_name . '_allowed_types', call_user_func_array('array_merge', $form_values['content_types']));
}
drupal_set_message(t('Your changes have been saved.'));
}
/**
* Based upon the settings, get the allowed types for this node.
*/
function panels_common_get_allowed_types($module, $contexts = array(), $has_content = FALSE, $default_defaults = array(), $default_allowed_types = array()) {
// Get a list of all types that are available
$default_types = variable_get($module . '_defaults', $default_defaults);
$allowed_types = variable_get($module .'_allowed_types', $default_allowed_types);
// By default, if they haven't gone and done the initial setup here,
// let all 'other' types (which will be all types) be available.
if (!isset($default_types['other'])) {
$default_types['other'] = TRUE;
}
panels_load_include('plugins');
$content_types = panels_get_available_content_types($contexts, $has_content, $allowed_types, $default_types);
return $content_types;
}
/**
* The layout information fieldset displayed at admin/edit/panel-%implementation%/add/%layout%.
*/
function panels_common_get_layout_information($panel_implementation, $contexts = array()) {
$form = array();
panels_load_include('plugins');
$layout = panels_get_layout($panel_implementation->display->layout);
$form = array(
'#type' => 'fieldset',
'#title' => t('Layout'),
);
$form['layout-icon'] = array(
'#value' => panels_print_layout_icon($panel_implementation->display->layout, $layout),
);
$form['layout-display'] = array(
'#value' => check_plain($layout['title']),
);
$content = '';
foreach (panels_get_panels($layout, $panel_implementation->display) as $panel_id => $title) {
$content .= "- $title
- ";
if ($panel_implementation->display->panels[$panel_id]) {
$content .= '
';
foreach ($panel_implementation->display->panels[$panel_id] as $pid) {
$content .= '- '. panels_get_pane_title($panel_implementation->display->content[$pid], $contexts) .'
';
}
$content .= '
';
}
else {
$content .= t('Empty');
}
$content .= ' ';
}
$content .= '
';
$form['layout-content'] = array(
'#value' => $content,
);
return $form;
}
// ---------------------------------------------------------------------------
// Context, argument, relationship tools
// ---------------------------------------------------------------------------
// contexts -- highly resemble arguments.
function panels_common_context_info($type = NULL) {
static $info = NULL;
// static doesn't work with functions like t().
if (empty($info)) {
$info = array(
'argument' => array(
'title' => t('Arguments'),
'singular title' => t('argument'),
'description' => t("Arguments are parsed from the URL and translated into contexts that may be added to the display via the 'content' tab. These arguments are parsed in the order received, and you may use % in your URL to hold the place of an object; the rest of the arguments will come after the URL. For example, if the URL is node/%/panel and your user visits node/1/panel/foo, the first argument will be 1, and the second argument will be foo."),
'add button' => t('Add argument'),
'context function' => 'panels_get_argument',
'sortable' => TRUE,
),
'relationship' => array(
'title' => t('Relationships'),
'singular title' => t('relationship'),
'description' => t('Relationships are contexts that are created from already existing contexts; the add relationship button will only appear once there is another context available. Relationships can load objects based upon how they are related to each other; for example, the author of a node, or a taxonomy term attached to a node, or the vocabulary of a taxonomy term.'),
'add button' => t('Add relationship'),
'context function' => 'panels_get_relationship',
'sortable' => FALSE,
),
'context' => array(
'title' => t('Contexts'),
'singular title' => t('context'),
'description' => t('Contexts are embedded directly into the panel; you generally must select an object in the panel. For example, you could select node 5, or the term "animals" or the user "administrator"'),
'add button' => t('Add context'),
'context function' => 'panels_get_context',
'sortable' => FALSE,
),
'requiredcontext' => array(
'title' => t('Required contexts'),
'singular title' => t('required context'),
'description' => t('Required contexts are passed in from some external source, such as a containing panel. If a mini panel has required contexts, it can only appear when that context is available, and therefore will not show up as a standard Drupal block.'),
'add button' => t('Add required context'),
'context function' => 'panels_get_context',
'sortable' => TRUE,
),
);
}
if ($type === NULL) {
return $info;
}
return $info[$type];
}
function panels_common_context_data($type, $name) {
$info = panels_common_context_info($type);
if (function_exists($info['context function'])) {
return $info['context function']($name);
}
}
/**
* Add the argument table plus gadget plus javascript to the form.
*/
function panels_common_add_argument_form($module, &$form, &$form_location, $object) {
$form_location = array(
'#theme' => 'panels_common_context_item_form',
'#panel_name' => $object->name,
'#panels_context_type' => 'argument',
'#panels_context_module' => $module,
);
$form['arguments'] = array(
'#type' => 'value',
'#value' => $object->arguments,
);
// Store the order the choices are in so javascript can manipulate it.
$form['argument_order'] = array(
'#type' => 'hidden',
'#id' => 'argument-order',
'#default_value' => $object->arguments ? implode(',', array_keys($object->arguments)) : '',
);
$args = panels_get_arguments();
$choices = array();
foreach ($args as $name => $arg) {
$choices[$name] = $arg['title'];
}
asort($choices);
if (!empty($choices) || !empty($object->arguments)) {
panels_common_add_item_table('argument', $form_location, $choices, $object->arguments);
}
return _panels_common_context_js($object->name, $module, 'argument');
}
function panels_common_add_context_form($module, &$form, &$form_location, $object) {
$form['contexts'] = array(
'#type' => 'value',
'#value' => $object->contexts,
);
$form_location = array(
'#prefix' => '',
'#suffix' => '
',
'#theme' => 'panels_common_context_item_form',
'#panel_name' => $object->name,
'#panels_context_type' => 'context',
'#panels_context_module' => $module,
);
// Store the order the choices are in so javascript can manipulate it.
$form_location['markup'] = array(
'#value' => ' '
);
$form['context_order'] = array(
'#type' => 'hidden',
'#id' => 'context-order',
'#default_value' => $object->contexts ? implode(',', array_keys($object->contexts)) : '',
);
$choices = array();
foreach (panels_get_contexts() as $name => $arg) {
if (empty($arg['no ui'])) {
$choices[$name] = $arg['title'];
}
}
asort($choices);
if (!empty($choices) || !empty($object->contexts)) {
panels_common_add_item_table('context', $form_location, $choices, $object->contexts);
}
return _panels_common_context_js($object->name, $module, 'context');
}
function panels_common_add_required_context_form($module, &$form, &$form_location, $object) {
$form['requiredcontexts'] = array(
'#type' => 'value',
'#value' => $object->requiredcontexts,
);
$form_location = array(
'#prefix' => '',
'#suffix' => '
',
'#theme' => 'panels_common_context_item_form',
'#panel_name' => $object->name,
'#panels_context_type' => 'requiredcontext',
'#panels_context_module' => $module,
);
// Store the order the choices are in so javascript can manipulate it.
$form_location['markup'] = array(
'#value' => ' '
);
$form['requiredcontext_order'] = array(
'#type' => 'hidden',
'#id' => 'requiredcontext-order',
'#default_value' => $object->requiredcontexts ? implode(',', array_keys($object->requiredcontexts)) : '',
);
$choices = array();
foreach (panels_get_contexts() as $name => $arg) {
$choices[$name] = $arg['title'];
}
asort($choices);
if (!empty($choices) || !empty($object->contexts)) {
panels_common_add_item_table('requiredcontext', $form_location, $choices, $object->requiredcontexts);
}
return _panels_common_context_js($object->name, $module, 'requiredcontext');
}
function panels_common_add_relationship_form($module, &$form, &$form_location, $object) {
$form['relationships'] = array(
'#type' => 'value',
'#value' => $object->relationships,
);
$form_location = array(
'#prefix' => '',
'#suffix' => '
',
'#theme' => 'panels_common_context_item_form',
'#panel_name' => $object->name,
'#panels_context_type' => 'relationship',
'#panels_context_module' => $module,
);
// Store the order the choices are in so javascript can manipulate it.
$form_location['markup'] = array(
'#value' => ' '
);
$form['relationship_order'] = array(
'#type' => 'hidden',
'#id' => 'relationship-order',
'#default_value' => $object->relationships ? implode(',', array_keys($object->relationships)) : '',
);
$available_relationships = panels_get_relevant_relationships(panels_context_load_contexts($object));
// if (!empty($available_relationships) || !empty($object->relationships)) {
panels_common_add_item_table('relationship', $form_location, $available_relationships, $object->relationships);
// }
return _panels_common_context_js($object->name, $module, 'relationship');
}
function _panels_common_context_js($name, $module, $type) {
return array($type . '-table' => array(
// The buttons that do stuff.
'remove' => "input.$type-remove",
// The gadget that stores our the order of items.
'order' => "input#$type-order",
'up' => "input.$type-up",
'down' => "input.$type-down",
'top' => "input.$type-top",
'bottom' => "input.$type-bottom",
'configure' => "input.$type-settings",
'configure_path' => url("panels/common/ajax/edit/$module/$type/$name", NULL, NULL, TRUE),
// The button that adds an item
'add' => "input#edit-buttons-$type-add",
// Path for ajax on adding an item
'path' => url("panels/common/ajax/add/$module/$type/$name", NULL, NULL, TRUE),
// Which items to post when adding
'post' => array("#edit-buttons-$type-item", "input#edit-buttons-$type-add"),
// Where to get the id of an item
'tr' => $type . '-row-',
'row_class' => "tr.$type-row",
// Additional HTML to replace on add.
'replace' => array('div#panels-relationships-table div.buttons' => 'relationships_table'),
));
}
function panels_common_add_context_js($base) {
$settings = array(
'list' => $base,
'panels' => array(
'closeText' => t('Close Window'),
'closeImage' => theme('image', panels_get_path('images/close.gif'), t('Close window'), t('Close window')),
'throbber' => theme('image', panels_get_path('images/throbber.gif'), t('Loading...'), t('Loading')),
),
);
drupal_add_js($settings, 'setting');
drupal_add_js(panels_get_path('js/list.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(panels_get_path('js/modal_forms.js'));
drupal_add_css(panels_get_path('css/panels_dnd.css'));
// while we don't use this directly some of our forms do.
drupal_add_js('misc/collapse.js');
drupal_add_js('misc/autocomplete.js');
}
/**
* Add the context table to the page.
*/
function panels_common_add_item_table($type, &$form, $available_contexts, $items) {
$form[$type] = array(
'#tree' => TRUE,
);
if (isset($items) && is_array($items)) {
foreach ($items as $position => $context) {
panels_common_add_item_to_form($type, $form[$type][$position], $position, $context);
}
}
$type_info = panels_common_context_info($type);
$form['description'] = array(
'#prefix' => '',
'#suffix' => '
',
'#value' => $type_info['description'],
);
panels_common_add_item_table_buttons($type, $form, $available_contexts);
}
function panels_common_add_item_table_buttons($type, &$form, $available_contexts) {
$form['buttons'] = array(
'#tree' => TRUE,
);
if (!empty($available_contexts)) {
$form['buttons'][$type]['item'] = array(
'#type' => 'select',
'#options' => $available_contexts,
);
$type_info = panels_common_context_info($type);
$form['buttons'][$type]['add'] = array(
'#type' => 'submit',
'#attributes' => array('class' => $type . '-add'),
'#value' => $type_info['add button'],
);
}
}
/**
* Add a row to the form. Used both in the main form and by
* the ajax to add an item.
*/
function panels_common_add_item_to_form($type, &$form, $position, $item) {
// This is the single function way to load any plugin by variable type.
$info = panels_common_context_data($type, $item['name']);
$form['title'] = array(
'#value' => check_plain($item['identifier']),
);
// Relationships not sortable.
$type_info = panels_common_context_info($type);
if (!empty($type_info['sortable'])) {
$form['top'] = panels_add_button('go-top.png', t('Top'),
t('Move this item to the top of the list'),
$type . '-top',
$type . '-top-' . $position
);
$form['up'] = panels_add_button('go-up.png', t('Up'),
t('Move this item up'),
$type . '-up',
$type . '-up-' . $position
);
$form['down'] = panels_add_button('go-down.png', t('Down'),
t('Move this item down'),
$type . '-down',
$type . '-down-' . $position
);
$form['bottom'] = panels_add_button('go-bottom.png', t('Bottom'),
t('Move this item to the bottom of the list'),
$type . '-bottom',
$type . '-bottom-' . $position
);
}
$form['remove'] = panels_add_button('delete.png', t('Remove'),
t('Remove this item'),
$type . '-remove',
$type . '-remove-' . $position
);
$form['settings'] = panels_add_button('configure.gif', t('Configure'),
t('Configure this item'),
$type . '-settings',
$type . '-settings-' . $position
);
}
/**
* Theme the form item for the context entry.
*/
function theme_panels_common_context_item_row($type, $form, $position, $count, $with_tr = TRUE) {
$output = ' ' . drupal_render($form['title']) . ' | ';
$arrows = '';
$type_info = panels_common_context_info($type);
if (!empty($type_info['sortable'])) {
$arrows = drupal_render($form['up']) .
drupal_render($form['down']) .
drupal_render($form['top']) .
drupal_render($form['bottom']);
}
$output .= '' . drupal_render($form['settings']) .
$arrows . drupal_render($form['remove']) .
' | ';
if ($with_tr) {
$output = '' . $output . '
';
}
return $output;
}
/**
* Add the contexts form to panel page settings
*/
function theme_panels_common_context_item_form($form) {
$output = '';
$type = $form['#panels_context_type'];
$module = $form['#panels_context_module'];
$name = $form['#panel_name'];
$type_info = panels_common_context_info($type);
if (!empty($form[$type]) && empty($form['#only_buttons'])) {
$output .= '';
$output .= '';
$output .= '';
$output .= '| ' . $type_info['title'] . ' | ';
$output .= '' . t('Operation') . ' | ';
$output .= '
';
$output .= '';
$count = 0;
foreach (array_keys($form[$type]) as $id) {
if (!is_numeric($id)) {
continue;
}
$output .= theme('panels_common_context_item_row', $type, $form[$type][$id], $id, $count++);
}
$output .= '';
$output .= '
';
}
if (!empty($form['buttons'])) {
// Display the add context item.
$row = array();
$row[] = array('data' => drupal_render($form['buttons'][$type]['item']), 'class' => 'title');
$row[] = array('data' => drupal_render($form['buttons'][$type]['add']), 'class' => 'add', 'width' => "60%");
$output .= '';
$output .= theme('table', array(), array($row), array('id' => $type . '-add-table'));
$output .= '
';
}
if (!empty($form['description'])) {
$output .= drupal_render($form['description']);
}
return $output;
}
/**
* Ajax entry point to add an context
*/
function panels_common_ajax_context_item_add($module, $type, $panel_name) {
$object = panels_common_cache_get("panel_object:$module", $panel_name);
if (!$object || !$type) {
panels_ajax_render();
}
// Figure out which context we're adding
if (isset($_POST['buttons'][$type]['item'])) {
$name = $_POST['buttons'][$type]['item'];
// Unset $_POST so fapi doesn't get confused and try to process this
// as a form.
unset($_POST);
}
else if (isset($_POST[$type]['name'])) {
$name = $_POST[$type]['name'];
}
if (empty($name)) {
panels_ajax_render();
}
$info = panels_common_context_data($type, $name);
if (empty($info)) {
panels_ajax_render();
}
// Create a reference to the place our context lives.
$keyword = $type . 's';
$ref = &$object->$keyword;
// Give this argument an id, which is really just the nth version
// of this particular context.
$id = panels_common_get_arg_id($ref, $name) + 1;
// Figure out the position for our new context.
$position = empty($ref) ? 0 : max(array_keys($ref)) + 1;
// Create the basis for our new context.
$ref[$position] = array(
'identifier' => $info['title'] . ($id > 1 ? ' ' . $id : ''),
'keyword' => panels_common_get_keyword($object, $info['keyword']),
'id' => $id,
);
$contexts = panels_context_load_contexts($object);
$form_id = 'panels_common_edit_' . $type . '_form';
$form = drupal_retrieve_form($form_id, $object, $info, $position, $contexts);
if ($_POST && $_POST['form_id'] == $form_id) {
$form['#redirect'] = FALSE;
}
$retval = drupal_process_form($form_id, $form);
if ($retval) {
// successful submit
// Save changes
$ref[$position] = $retval;
panels_common_cache_set("panel_object:$module", $panel_name, $object);
// Build a chunk of the form to merge into the displayed form
$arg_form[$type] = array(
'#tree' => TRUE,
);
panels_common_add_item_to_form($type, $arg_form[$type], $position, $retval);
$arg_form = form_builder($form_id, $arg_form);
// Build the relationships table so we can ajax it in.
// This is an additional thing that goes in here.
$rel_form = array(
'#theme' => 'panels_common_context_item_form',
'#panel_name' => $panel_name,
'#panels_context_type' => 'relationship',
'#panels_context_module' => $module,
'#only_buttons' => TRUE,
);
$rel_form['relationship'] = array(
'#tree' => TRUE,
);
$available_relationships = panels_get_relevant_relationships(panels_context_load_contexts($object));
$output = new stdClass();
if (!empty($available_relationships)) {
panels_common_add_item_table_buttons('relationship', $rel_form, $available_relationships);
$rel_form = form_builder('dummy_form_id', $rel_form);
$output->relationships_table = drupal_render($rel_form);
}
$output->type = 'add';
$output->output = theme('panels_common_context_item_row', $type, $arg_form[$type], $position, $position);
$output->position = $position;
panels_ajax_render($output);
}
else {
$type_info = panels_common_context_info($type);
$title = t('Add @type "@context"', array('@type' => $type_info['singular title'], '@context' => $info['title']));
$output = theme('status_messages');
$output .= drupal_render_form($form_id, $form);
panels_ajax_render($output, $title, url($_GET['q'], NULL, NULL, TRUE));
}
}
/**
* Ajax entry point to edit an item
*/
function panels_common_ajax_context_item_edit($module, $type, $panel_name) {
$object = panels_common_cache_get("panel_object:$module", $panel_name);
if (!$object) {
panels_ajax_render();
}
// Figure out which context we're adding
if (isset($_POST['position'])) {
$position = $_POST['position'];
}
if (!isset($_POST['form_id'])) {
// Unset $_POST so fapi doesn't get confused and try to process this
// as a form.
unset($_POST);
}
// Create a reference to the place our context lives.
$keyword = $type . 's';
$ref = &$object->$keyword;
$name = $ref[$position]['name'];
if (empty($name)) {
panels_ajax_render();
}
// load the context
$info = panels_common_context_data($type, $name);
if (empty($info)) {
panels_ajax_render();
}
$type_info = panels_common_context_info($type);
$title = t('Edit @type "@context"', array('@type' => $type_info['singular title'], '@context' => $info['title']));
$contexts = panels_context_load_contexts($object);
// Remove this context, because we can't really allow circular contexts.
// TODO: FIX THIS!!!
unset($contexts[panels_context_context_id($ref[$position])]);
$form_id = 'panels_common_edit_' . $type . '_form';
$form = drupal_retrieve_form($form_id, $object, $info, $position, $contexts);
if ($_POST && $_POST['form_id'] == $form_id) {
// TODO: Make sure the form does this.
$form['#redirect'] = FALSE;
}
$retval = drupal_process_form($form_id, $form);
if ($retval) {
// successful submit
// Save changes
$ref[$position] = $retval;
panels_common_cache_set("panel_object:$module", $panel_name, $object);
$output->type = $output->output = 'dismiss';
// Build a chunk of the form to merge into the displayed form
$arg_form[$type] = array(
'#tree' => TRUE,
);
panels_common_add_item_to_form($type, $arg_form[$type], $position, $retval);
$arg_form = form_builder($form_id, $arg_form);
$output->replace = theme('panels_common_context_item_row', $type, $arg_form[$type], $position, $position, FALSE);
$output->replace_id = '#' . $type . '-row-' . $position;
panels_ajax_render($output);
}
else {
$output = theme('status_messages');
$output .= drupal_render_form($form_id, $form);
panels_ajax_render($output, $title, url($_GET['q'], NULL, NULL, TRUE));
}
}
/**
* Form (for ajax use) to add a context
*/
function panels_common_edit_context_form($object, $context, $position, $contexts) {
$ctext = $object->contexts[$position];
$form['position'] = array(
'#type' => 'hidden',
'#value' => $position,
);
$form['start_form'] = array('#value' => '');
$form['next'] = array(
'#type' => 'submit',
'#value' => t('Save'),
);
return $form;
}
/**
* validate a context edited/added via ajax
*/
function panels_common_edit_context_form_validate($form_id, $form_values, $form) {
$context = $form_values['context_info'];
if (isset($context['settings form validate']) && function_exists($context['settings form validate'])) {
$context['settings form validate']($form['context']['context_settings'], $form_values['context']['context_settings']);
}
}
/**
* Updates an context edited/added via ajax
*/
function panels_common_edit_context_form_submit($form_id, $form_values) {
$context = $form_values['context'];
$info = $form_values['context_info'];
if (isset($info['settings form submit']) && function_exists($info['settings form submit'])) {
$info['settings form submit']($form_values['context_settings']);
}
return $context;
}
/**
* Form (for ajax use) to add a context
*/
function panels_common_edit_requiredcontext_form($object, $context, $position, $contexts) {
$ctext = $object->requiredcontexts[$position];
$form['position'] = array(
'#type' => 'hidden',
'#value' => $position,
);
$form['start_form'] = array('#value' => '');
$form['next'] = array(
'#type' => 'submit',
'#value' => t('Save'),
);
return $form;
}
/**
* Updates a required context edited/added via ajax
*/
function panels_common_edit_requiredcontext_form_submit($form_id, $form_values) {
$context = $form_values['requiredcontext'];
return $context;
}
/**
* Form (for ajax use) to add a relationship
*/
function panels_common_edit_relationship_form($panel_page, $relationship, $position, $contexts) {
$rel = $panel_page->relationships[$position];
$form['position'] = array(
'#type' => 'hidden',
'#value' => $position,
);
$form['start_form'] = array('#value' => '');
$form['next'] = array(
'#type' => 'submit',
'#value' => t('Save'),
);
return $form;
}
/**
* validate an relationship edited/added via ajax
*/
function panels_common_edit_relationship_form_validate($form_id, $form_values, $form) {
$relationship = $form_values['relationship_info'];
if (isset($relationship['settings form validate']) && function_exists($relationship['settings form validate'])) {
$relationship['settings form validate']($form['relationship']['relationship_settings'], $form_values['relationship']['relationship_settings']);
}
}
/**
* Updates an relationship edited/added via ajax
*/
function panels_common_edit_relationship_form_submit($form_id, $form_values) {
$relationship = $form_values['relationship'];
if (isset($relationship['settings form submit']) && function_exists($relationship['settings form submit'])) {
$relationship['settings form submit']($form_values['relationship_settings']);
}
return $relationship;
}
/**
* Form (for ajax use) to add an argument
*/
function panels_common_edit_argument_form($panel_page, $argument, $position) {
// Basic values required to orient ourselves
$arg = $panel_page->arguments[$position];
$form['position'] = array(
'#type' => 'hidden',
'#value' => $position,
);
$form['start_form'] = array('#value' => '');
$form['next'] = array(
'#type' => 'submit',
'#value' => t('Save'),
);
return $form;
}
/**
* validate an argument edited/added via ajax
*/
function panels_common_edit_argument_form_validate($form_id, $form_values, $form) {
$argument = $form_values['arg'];
if (isset($argument['settings form validate']) && function_exists($argument['settings form validate'])) {
$argument['settings form validate']($form['argument']['argument_settings'], $form_values['argument']['argument_settings']);
}
}
/**
* Updates an argument edited/added via ajax
*/
function panels_common_edit_argument_form_submit($form_id, $form_values) {
$argument = $form_values['arg'];
$position = $form_values['position'];
if (isset($argument['settings form submit']) && function_exists($argument['settings form submit'])) {
$argument['settings form submit']($form_values['argument']['argument_settings']);
}
// Because we're being all ajaxy, our caller will save this for us.
return $form_values['argument'];
}
// --- End of contexts
function panels_common_save_context($type, &$ref, $form_values) {
// Organize arguments
$ref = array();
if (isset($form_values[$type . '_order']) && $form_values[$type . '_order'] !== '') {
foreach (explode(',', $form_values[$type . '_order']) as $position) {
// We retain the original position here because we need argument IDs.
$ref[$position] = $form_values[$type . 's'][$position];
}
}
}
// ---------------------------------------------------------------------------
// Ajax tools
/**
* Incoming menu function for ajax calls. This routes to the proper 'module'
* -- we really only need this because common.inc relies on panels.module for
* its menu hook, and this way the code stays together.
*/
function panels_common_ajax($module = NULL, $data = NULL, $info = NULL, $info2 = NULL) {
switch ($module) {
case 'edit':
return panels_common_ajax_context_item_edit($data, $info, $info2);
case 'add':
return panels_common_ajax_context_item_add($data, $info, $info2);
case 'panel_settings':
return panels_common_panel_settings_ajax($data, $info);
default:
panels_ajax_render(t('An error occurred'), t('Error'));
}
}
// TODO: Move this somewhere more appropriate
function panels_common_get_arg_id($arguments, $name) {
// Figure out which instance of this argument we're creating
$id = 0;
foreach ($arguments as $arg) {
if ($arg['name'] == $name) {
if ($arg['id'] > $id) {
$id = $arg['id'];
}
}
}
return $id;
}
function panels_common_get_keyword($page, $word) {
// Create a complete set of keywords
$keywords = array();
foreach (array('arguments', 'relationships', 'contexts', 'requiredcontexts') as $type) {
if (!empty($page->$type) && is_array($page->$type)) {
foreach ($page->$type as $info) {
$keywords[$info['keyword']] = TRUE;
}
}
}
$keyword = $word;
$count = 0;
while ($keywords[$keyword]) {
$keyword = $word . '_' . ++$count;
}
return $keyword;
}
/**
* Create a visible list of content in a display.
* Note that the contexts must be pre-loaded.
*/
function theme_panels_common_content_list($display) {
$layout = panels_get_layout($display->layout);
$content = '';
foreach (panels_get_panels($layout, $display) as $panel_id => $title) {
$content .= "- $title
- ";
if ($display->panels[$panel_id]) {
$content .= '
';
foreach ($display->panels[$panel_id] as $pid) {
$content .= '- ' . panels_get_pane_title($display->content[$pid], $display->context) . '
';
}
$content .= '
';
}
else {
$content .= t('Empty');
}
$content .= ' ';
}
$content .= '
';
return $content;
}
/**
* Create a visible list of all the contexts available on an object.
* Assumes arguments, relationships and context objects.
*
* Contexts must be preloaded.
*/
function theme_panels_common_context_list($object) {
$titles = array();
$output = '';
$count = 1;
// First, make a list of arguments. Arguments are pretty simple.
if (!empty($object->arguments)) {
foreach ($object->arguments as $argument) {
$output .= '';
$output .= '| ' . t('Argument @count', array('@count' => $count)) . ' | ';
$output .= '' . check_plain($argument['identifier']) . ' | ';
$output .= '
';
$titles[panels_argument_context_id($argument)] = $argument['identifier'];
$count++;
}
}
$count = 1;
// Then, make a nice list of contexts.
if (!empty($object->contexts)) {
foreach ($object->contexts as $context) {
$output .= '';
$output .= '| ' . t('Context @count', array('@count' => $count)) . ' | ';
$output .= '' . check_plain($context['identifier']) . ' | ';
$output .= '
';
$titles[panels_context_context_id($context)] = $context['identifier'];
$count++;
}
}
// And relationships
if (!empty($object->relationships)) {
foreach ($object->relationships as $relationship) {
$output .= '';
$output .= '| ' . t('From @title', array('@title' => $titles[$relationship['context']])) . ' | ';
$output .= '' . check_plain($relationship['identifier']) . ' | ';
$output .= '
';
$titles[panels_relationship_context_id($relationship)] = $relationship['identifier'];
$count++;
}
}
if ($output) {
return "\n";
}
}