'theme',
'page arguments' => array('popup_save_dialog'),
'access callback' => TRUE,
'type' => MENU_CALLBACK,
);
// Admin Settings.
$items['admin/settings/popups'] = array(
'page callback' => 'drupal_get_form',
'page arguments' => array('popups_admin_settings'),
'title' => 'Popups',
'access arguments' => array('administer site configuration'),
'description' => 'Configure the page-in-a-dialog behavior.',
);
// Items for testing.
$items['popups/test'] = array(
'title' => 'Popup Test',
'page callback' => '_popups_test_popups',
'type' => MENU_CALLBACK,
'access callback' => TRUE,
);
$items['popups/test/response'] = array(
'page callback' => '_popups_test_response',
'type' => MENU_CALLBACK,
'access callback' => TRUE,
);
$items['popups/test/namechange'] = array(
'page callback' => 'drupal_get_form',
'page arguments' => array('_popups_test_namechange'),
'type' => MENU_CALLBACK,
'access callback' => TRUE,
);
return $items;
}
/**
* hook_init
*
* Look at the page path and see if popup behavior has been requested for any links in this page.
*/
function popups_init() {
$popups = popups_get_popups();
if (isset($popups[$_GET['q']]) || variable_get('popups_always_scan', 0)) {
popups_add_popups($popups[$_GET['q']]);
}
$render_mode = '';
if (isset($_SERVER['HTTP_X_DRUPAL_RENDER_MODE'])) {
$render_mode = $_SERVER['HTTP_X_DRUPAL_RENDER_MODE'];
}
// Check and see if the page_override param is in the URL.
// Note - the magic happens here.
// Need to cache the page_override flag in the session, so it will effect
// the results page that follows a form submission.
if ($render_mode == 'json/popups') {
$_SESSION['page_override'] = TRUE;
}
// Move the page_override flag back out of the session.
if (isset($_SESSION['page_override'])) {
// This call will not return on form submission.
$content = menu_execute_active_handler();
// The call did return, so it wasn't a form request,
// so we are returning a result, so clear the session flag.
$override = $_SESSION['page_override'];
unset($_SESSION['page_override']);
// Menu status constants are integers; page content is a string.
if (isset($content) && !is_int($content) && isset($override)) {
print popups_render_as_json($content);
exit; // Do not continue processing request in index.html.
}
}
}
/**
* hook_theme
*
*/
function popups_theme($existing, $type) {
return array(
'popups_popup' => array(
'template' => 'popups-popup',
),
'popups_save_dialog' => array(),
);
}
function popups_render_as_json($content) {
$path = $_GET['q']; // Get current path from params.
return drupal_json(array(
'title' => drupal_get_title(),
'messages' => theme('status_messages'),
'path' => $path,
'content' => $content,
));
}
/**
* hook_form_alter
*
* Look at the form_id and see if popup behavior has been requested for any links in this form.
*
* @param form_array $form
* @param array $form_state
* @param str $form_id:
*/
function popups_form_alter(&$form, $form_state, $form_id) {
// Add popup behavior to the form if requested.
$popups = popups_get_popups();
if (isset($popups[$form_id])) {
popups_add_popups($popups[$form_id]);
}
// Alter the theme configuration pages, to add a per-theme-content selector.
$theme = arg(4);
if ($form_id == 'system_theme_settings' && $theme) {
$form['popups'] = array(
'#type' => 'fieldset',
'#title' => t('Popup Settings'),
'#weight' => -2,
);
$form['popups']['popups_content_selector'] = array(
'#type' => 'textfield',
'#title' => t('Content Selector'),
'#default_value' => variable_get('popups_'. $theme .'_content_selector', 'div.left-corner > div.clear-block:last'),
'#description' => t("jQuery selector to define the page's content area on this theme."),
);
$form['popups']['popups_theme'] = array(
'#type' => 'hidden',
'#value' => $theme,
);
$form['#submit'][] = 'popups_theme_settings_form_submit';
}
}
function popups_theme_settings_form_submit($form, &$form_state) {
$theme = $form_state['values']['popups_theme'];
$content_selector = $form_state['values']['popups_content_selector'];
variable_set('popups_'. $theme .'_content_selector', $content_selector);
// drupal_set_message("setting selector to '$content_selector'' for theme: '$theme'");
}
// **************************************************************************
// UTILITY FUNCTIONS ******************************************************
// **************************************************************************
/**
* Build the list of popup rules from all modules that implement hook_popups.
*
* @todo - Add some caching so we don't rebuild everytime.
*/
function popups_get_popups() {
static $popups = NULL;
if (!isset($popups)) {
$popups = module_invoke_all('popups');
}
return $popups;
}
/**
* Attach the popup behavior to the page.
*
* The default behavoir of a popup is to open a form that will modify the original page. The popup submits
* the form and reloads the original page with the resulting new content. The popup then replaces
* the original page's content area with the new copy of that content area.
*
* @param array $rule: Array of rules to apply to the page or form, keyed by jQuery link selector.
* Options:
* noReload: Does the popup NOT modify the original page (Default: false).
* titleSelectors: jQuery selector to place the new page title (Default: do nothing).
* targetSelectors: Hash of jQuery selectors with areas to update (Default: use single theme-wide setting)
* forceReturn: url to force a stop to work flow (only use in conjunction with noReload).
* href: override the href in the a element, or attach an href to a non-link element.
* width: override the width specified in the css.
* additionalJavascript: Array of JavaScript files that must be included to correctly run the page in the popup.
* additionalCss: Array of CSS files that must be included to correctly style the page in the popup.
*
* Rule Format Example:
* 'admin/content/taxonomy' => array( // Act only on the links on this page.
* 'div#tabs-wrapper a:eq(1)', // No options, so use defaults. Note: Selectors must select element(s).
* 'table td:nth-child(2) a' => array(
* 'noReload' => TRUE, // Popup will not modify original page.
* ),
* )
*
*/
function popups_add_popups($rules=NULL) {
static $added = FALSE;
$settings = array('popups' => array());
if (is_array($rules)) {
$settings['popups']['links'] = array();
foreach ($rules as $popup_selector => $options) {
if (is_array($options)) {
$settings['popups']['links'][$popup_selector] = $options;
if (isset($options['additionalJavascript']) && is_array($options['additionalJavascript'])) {
foreach ($options['additionalJavascript'] as $file) {
drupal_add_js($file);
}
}
if (isset($options['additionalCss']) && is_array($options['additionalCss'])) {
foreach ($options['additionalCss'] as $file) {
drupal_add_css($file);
}
}
}
else {
$settings['popups']['links'][$options] = array();
}
}
if($added) {
drupal_add_js( $settings, 'setting' );
}
}
if (!$added) {
drupal_add_css(drupal_get_path('module', 'popups') .'/popups.css');
drupal_add_css(drupal_get_path('module', 'popups') .'/popups-skin.css');
drupal_add_js(drupal_get_path('module', 'popups') .'/popups.js');
drupal_add_js('misc/jquery.form.js');
// Determing if we are showing the default theme or a custom theme.
global $custom_theme;
$theme = $custom_theme;
if (!$theme) {
$theme = variable_get('theme_default','none');
}
$default_target_selector = variable_get('popups_'. $theme .'_content_selector', 'div.left-corner > div.clear-block:last');
$settings['popups']['defaultTargetSelector'] = $default_target_selector;
$settings['popups']['template'] = theme('popups_popup');
$settings['popups']['modulePath'] = drupal_get_path('module', 'popups');
$settings['popups']['popupFinalMessage'] = variable_get('popups_popup_final_message', 1);
drupal_add_js( $settings, 'setting' );
$added = TRUE;
}
}
/**
* hook_popups
*
* This implements hook_popups, defined in popups_get_popups.
* See the comments in popups_add_popups for explination of the options.
* Adding popup behavior to the core admin pages has been moved to popups_admin.
*
* @return: Array of link selectors to apply popup behavior to.
* Keyed by path or form_id.
*/
function popups_popups() {
return array(
'popups/test' => array( // test page.
'#test-popup' => array(
'additionalJavascript' => array('misc/collapse.js'),
'forceReturn' => 'node/add/story',
),
),
);
}
// **************************************************************************
// ADMIN SETTINGS *********************************************************
// **************************************************************************
function popups_admin_settings() {
drupal_set_title("Popups Settings");
$form = array();
$form['popups_always_scan'] = array(
'#type' => 'checkbox',
'#title' => t('Scan all pages for popup links.'),
'#default_value' => variable_get('popups_always_scan', 0),
);
$form['popups_popup_final_message'] = array(
'#type' => 'checkbox',
'#title' => t('Do NOT auto-close final message.'),
'#default_value' => variable_get('popups_popup_final_message', 1),
);
return system_settings_form($form);
}
// **************************************************************************
// TESTING ****************************************************************
// **************************************************************************
function _popups_test_popups() {
// drupal_set_message('Popup Test Page: If you edit your page.tpl.php to wrap the print $messages in a div with id="popit", this message will popup on page load');
popups_add_popups();
$output = '';
$output .= '- '. l("Pop up entire local page.", 'popups/test/response',
array('attributes' => array('class' => 'popups')));
$output .= "
- ". l("Pop with options (href override).", 'popups/test/',
array('attributes' => array('class' => 'popups', 'on-popups-options' => '{href: "test/response"}')));
$output .= "
- ". l("Pop with options (width=200px).", 'popups/test/response',
array('attributes' => array('class' => 'popups', 'on-popups-options' => '{width: "200px"}')));
$output .= "
";
$output .= '- '. l("Add Story (hook).", 'node/add/story',
array( 'attributes' => array('id' => 'test-popup')));
$output .= '
- '. l("Add Story (attribute).", 'node/add/story',
array( 'attributes' => array('class' => 'popups-form')));
$output .= '
- '. l("Change Settings and ajax reload content area: ",
'admin/settings/popups',
array( 'attributes' => array('class' => 'popups-form'),
'query' => array('destination' => 'popups/test'),
));
$output .= " (Auto Fade checkbox is: " . (variable_get('popups_popup_final_message', 1) ? 'on' : 'off') . ')';
$output .= '
- '. l("Change Settings and reload just target.", 'admin/settings/popups',
array( 'attributes' => array('id' => 'reload-target'),
'query' => array('destination' => 'popups/test'),
));
$output .= " (Auto Fade checkbox is: " . (variable_get('popups_popup_final_message', 1) ? 'on' : 'off') . ')';
popups_add_popups(array('#reload-target'=>array('targetSelectors'=>array('#response2'))));
$output .= '
- '. l("Change Settings and cold reload page.",
'admin/settings/popups',
array( 'attributes' => array('class' => 'popups-form-reload'),
'query' => array('destination' => 'popups/test'),
));
$output .= '
- '. l("Change Settings and cherry pick.", 'admin/settings/popups',
array( 'attributes' => array(
'id' => 'foo',
'class' => 'popups-form',
'on-popups-options' => '{targetSelectors: {"label": "#foo", "label:first": "#test-list li:first"}, forceReturn: "admin/settings/popups"}')));
$output .= '
- '. l("Pop up defined by popups_add_popups rule.", 'popups/test/response',
array('attributes' => array('id' => 'rule-test')));
popups_add_popups(array('#rule-test'=>array('width'=>'300px')));
$output .= '
- '. l("Change Page Title.", 'popups/test/namechange',
array('attributes' => array('id' => 'title-test')));
popups_add_popups(array('#title-test'=>array('titleSelectors'=>array('#page-title'), 'forceReturn'=>'popups/test/namechange')));
global $user;
$output .= "
- You are user number $user->uid
";
if ($user->uid == 0) {
$output .= '- '. l("Login and ajax refresh content area.", 'user',
array('attributes' => array('class' => 'popups-form'),
'query' => array('destination' => 'popups/test')));
$output .= '
- '. l("Login and reload entire page.", 'user',
array('attributes' => array('class' => 'popups-form-reload'),
'query' => array('destination' => 'popups/test')));
}
else {
$output .= '
- '. l("Logout (need to surpress warning b/c session is dumped)", 'logout',
array('attributes' => array('id' => 'logout')));
// 'query' => array('destination' => 'popups/test'))); // destination ignored after logout.
}
// Need to have the rule outside the else, or it won't get loaded on ajax reload.
popups_add_popups(array('#logout'=>array('noReload'=>TRUE, 'reloadOnError'=>TRUE)));
$output .= "
";
return $output;
}
function _popups_test_response() {
drupal_set_title("Popup Test Two");
return 'Hello World
';
}
function _popups_test_namechange() {
drupal_set_title("New Name for Test Page");
$form = array();
$form['popups_popup_final_message'] = array(
'#type' => 'submit',
'#value' => t('Test Name Change'),
);
return $form;
}