beautytips_manager.admin.inc in BeautyTips 7.2
Administration pages and forms for beautytips manager.
File
beautytips_manager.admin.incView source
<?php
/**
* @file
* Administration pages and forms for beautytips manager.
*/
/**
* Listing of all beautytips available.
*/
function beautytips_manager_tips_manager_page() {
$rows = [];
$empty = '';
$header = [
t('Element'),
t('Style'),
t('Status'),
t('Visibility'),
t('Pages'),
t('operations'),
'',
];
$tips = beautytips_manager_get_custom_tips();
if (count($tips)) {
$visibility = [
t('Show on every page except the listed pages.'),
t('Show on only the listed pages.'),
];
foreach ($tips as $tip) {
$tip->pages = check_plain($tip->pages);
$pages = $tip->pages != substr($tip->pages, 0, 40) ? substr($tip->pages, 0, 40) . '...' : substr($tip->pages, 0, 40);
$rows[$tip->id]['element'] = check_plain($tip->element);
$rows[$tip->id]['style'] = $tip->style;
$rows[$tip->id]['enabled'] = $tip->enabled ? t('Enabled') : t('Disabled');
$rows[$tip->id]['visibility'] = $visibility[$tip->visibility];
$rows[$tip->id]['pages'] = $pages;
$rows[$tip->id]['edit'] = l(t('edit'), "admin/config/user-interface/beautytips/custom-tips/{$tip->id}/edit");
$rows[$tip->id]['delete'] = l(t('delete'), "admin/config/user-interface/beautytips/custom-tips/{$tip->id}/delete");
}
}
else {
$empty = t('There are no custom beautytips yet.');
}
return theme('table', [
'header' => $header,
'rows' => $rows,
]) . $empty;
}
/**
* Page callback for custom styles administration.
*/
function beautytips_manager_styles_manager_page() {
$rows = [];
$empty = '';
$header = [
t('Name'),
t('operations'),
'',
];
$styles = beautytips_manager_get_custom_styles();
if (count($styles)) {
$visibility = [
t('Show on every page except the listed pages.'),
t('Show on only the listed pages.'),
];
foreach ($styles as $style) {
$name = check_plain($style->name);
unset($style->name);
$rows[$style->id]['name'] = '<span class="bt-style-' . $name . '">' . $name . '</span>';
$rows[$style->id]['edit'] = l(t('edit'), "admin/config/user-interface/beautytips/custom-styles/{$style->id}/edit");
if ($name != variable_get('beautytips_default_style', 'plain')) {
$rows[$style->id]['delete'] = l(t('delete'), "admin/config/user-interface/beautytips/custom-styles/{$style->id}/delete");
}
else {
$rows[$style->id]['delete'] = t('Default style');
}
$options = [
'cssSelect' => 'td .bt-style-' . $name,
'text' => t('<h2>Default Text</h2><p>Nam magna enim, accumsan eu, blandit sed, blandit a, eros. Nam ante nulla, interdum vel, tristique ac, condimentum non, tellus.</p><p>Nulla facilisi. Nam magna enim, accumsan eu, blandit sed, blandit a, eros.</p>'),
'trigger' => 'hover',
'style' => $name,
];
beautytips_add_beautytips([
$name => $options,
]);
}
}
else {
$empty = t('There are no custom beautytip styles yet.');
}
return theme('table', [
'header' => $header,
'rows' => $rows,
]) . $empty;
}
/**
* Form for configuring custom beautytips.
*/
function beautytips_manager_custom_tips_form($form, &$form_state, $id = NULL) {
drupal_add_css(drupal_get_path('module', 'beautytips') . '/css/beautytips.css');
$tip = beautytips_manager_get_custom_tip($id);
if (!isset($tip->id)) {
$tip = NULL;
}
$form = [];
$form['tip'] = [
'#type' => 'markup',
'#value' => '',
'#tree' => TRUE,
];
$form['tip']['id'] = [
'#type' => 'value',
'#value' => is_object($tip) ? $tip->id : 0,
];
$form['tip']['element'] = [
'#type' => 'textfield',
'#title' => t('Element'),
'#required' => TRUE,
'#maxlength' => 255,
'#default_value' => is_object($tip) ? $tip->element : '',
];
$form['tip']['enabled'] = [
'#type' => 'checkbox',
'#title' => t('Enabled'),
'#default_value' => is_object($tip) ? $tip->enabled : TRUE,
];
$content_options = [
'attribute' => 'attribute',
'text' => 'text',
'ajax' => 'ajax',
];
$description = t('Content to display in the beautytip. The data entered here depends on the Content Type.');
$types = [];
$types[0] = t('attribute - Enter the attribute of the element that should be displayed. (If empty, the title will be selected.)');
$types[0] .= '<br />' . t('ex. "alt"');
$types[1] = t('text - Enter the text that should be displayed with in the beautytip.');
$types[1] .= '<br />' . t('ex. "This is my beautytip!"');
$types[2] = t('ajax - This will grab the page from the "href" attribute and display that page. Enter css selectors to narrow the down the content from that page.');
$types[2] .= '<br />' . t('ex. "#my-id .my-class"');
if (user_access('use Javascript for custom beautytip display')) {
$content_options['js'] = 'js';
$types[3] = 'js - Directly enter javascript to select the content.';
$types[3] .= '<br />' . t('ex. "$(this).next(\'.description\').html()"');
}
$form['tip']['content_type'] = [
'#type' => 'radios',
'#title' => t('Type of Content'),
'#description' => t('This helps determine from where to pull the content to be displayed.'),
'#options' => $content_options,
'#default_value' => is_object($tip) ? $tip->content_type : 0,
];
$form['tip']['content'] = [
'#type' => 'textarea',
'#title' => t('Content to Display'),
'#description' => theme('item_list', [
'items' => $types,
]),
'#default_value' => is_object($tip) ? $tip->content : '',
];
$triggers = beautytips_manager_get_triggers();
$form['tip']['trigger_on'] = [
'#type' => 'select',
'#title' => t('Trigger On'),
'#description' => t('Not all events are available for all elements. See jQuery <a href="@events">events documentation</a> for details.', [
'@events' => 'http://docs.jquery.com/Events',
]),
'#options' => $triggers,
'#default_value' => is_object($tip) ? $tip->trigger_on : 0,
'#prefix' => '<div class="beautytips-triggers">',
];
$form['tip']['trigger_off'] = [
'#type' => 'select',
'#title' => t('Trigger Off'),
'#options' => $triggers,
'#suffix' => '</div>',
'#default_value' => is_object($tip) ? $tip->trigger_off : 0,
];
$form['tip']['disable_link'] = [
'#type' => 'checkbox',
'#title' => t('Disable Link Click'),
'#description' => t('If you have chosen ajax as the type of content, and you would like to prevent the link from working, then check this box.'),
'#default_value' => is_object($tip) ? $tip->disable_link : 0,
];
$styles = beautytips_get_styles();
foreach ($styles as $key => $style) {
$style_options[$key] = $key;
}
$form['tip']['style'] = [
'#type' => 'select',
'#title' => t('Style'),
'#options' => $style_options,
'#default_value' => is_object($tip) ? $tip->style : 'default',
];
$form['tip']['shrink'] = [
'#type' => 'checkbox',
'#title' => t('Shrink to Fit'),
'#description' => t('Shrink the beautytip to the size of the content. This can sometimes help with sizing problems and is good for tips with just one line.'),
'#default_value' => is_object($tip) ? $tip->shrink : FALSE,
];
$positions = is_object($tip) ? explode(',', $tip->positions) : [];
$form['tip']['positions'] = [
'#type' => 'fieldset',
'#title' => t('Positions'),
'#description' => t("Optionally enter the order of positions in which you want the tip to appear. It will use first in order with available space. The last value will be used if others don't have enough space. If no entries, then the tip will be placed in the area with the most space. Only enter an order for those you wish to use"),
'#tree' => TRUE,
];
$positions_list = [
'top',
'bottom',
'left',
'right',
];
foreach ($positions_list as $position) {
$form['tip']['positions'][$position] = [
'#type' => 'textfield',
'#title' => t($position),
'#default_value' => array_search($position, $positions) !== FALSE ? array_search($position, $positions) : '',
'#size' => 1,
'#maxlength' => 1,
'#prefix' => '<div class="beautytips-positions">',
'#suffix' => '</div>',
];
}
$form['tip']['animation_on'] = [
'#type' => 'select',
'#title' => t('Animation (On)'),
'#options' => [
'' => '<none>',
'fadeIn' => 'fadeIn',
],
'#description' => t("These animations will be applied to the tip when it is turn on or off."),
'#default_value' => is_object($tip) ? $tip->animation_on : '',
'#prefix' => '<div class="beautytips-animations">',
];
$form['tip']['animation_off'] = [
'#type' => 'select',
'#title' => t('Animation (Off)'),
'#options' => [
'' => '<none>',
'fadeOut' => 'fadeOut',
'slideOut' => 'slideOut',
],
'#default_value' => is_object($tip) ? $tip->animation_off : '',
'#suffix' => '</div>',
];
$options = [
t('Show on every page except the listed pages.'),
t('Show on only the listed pages.'),
];
$description = t("Enter one page per line as Drupal paths. The '*' character is a wildcard. Example paths are %blog for the blog page and %blog-wildcard for every personal blog. %front is the front page.", [
'%blog' => 'blog',
'%blog-wildcard' => 'blog/*',
'%front' => '<front>',
]);
$form['tip']['visibility'] = [
'#type' => 'radios',
'#title' => t('Show beautytip on specific pages'),
'#options' => $options,
'#default_value' => is_object($tip) ? $tip->visibility : 0,
'#prefix' => '<div id="edit-tip-visibility-wrapper">',
'#suffix' => '</div>',
];
$form['tip']['pages'] = [
'#type' => 'textarea',
'#title' => t('Pages'),
'#default_value' => is_object($tip) ? $tip->pages : '',
'#description' => $description,
];
$form['save'] = [
'#type' => 'submit',
'#value' => t('Save configuration'),
];
$form['delete'] = [
'#type' => 'submit',
'#value' => t('Delete'),
];
$form['#submit'][] = 'beautytips_manager_custom_tips_form_submit';
return $form;
}
/**
* Validation callback for beautytips manager custom tips form.
*/
function beautytips_manager_custom_tips_form_validate($form, &$form_state) {
// TODO: Validate?
$positions = $form_state['values']['tip']['positions'];
foreach ($positions as $position => $order) {
if ($order !== '' && !is_numeric($order)) {
form_set_error("tip][positions][{$position}", t("You must enter a numeric value for position order (Or leave it blank)."));
}
}
}
/**
* Submission callback for beautytips manager custom tips form.
*/
function beautytips_manager_custom_tips_form_submit($form, &$form_state) {
$tip = $form_state['values']['tip'];
$positions = [];
foreach ($tip['positions'] as $position => $order) {
if ($order !== '') {
while (isset($positions[$order])) {
$order++;
}
$positions[$order] = $position;
}
}
ksort($positions);
$tip['positions'] = count($positions) ? implode(',', $positions) : '';
beautytips_manager_save_custom_tip($tip);
cache_clear_all('beautytips:beautytips-ui-custom-tips', 'cache');
$form_state['redirect'] = 'admin/config/user-interface/beautytips/custom-tips';
}
/**
* Form for editing a custom beautytip style.
*/
function beautytips_manager_custom_styles_form($form, &$form_state, $id = NULL) {
if (!is_null($id)) {
$style = beautytips_manager_get_custom_style($id);
$style_map = beautytips_manager_style_mapping();
$style_options = $style_map['options'];
$css_style_options = $style_map['css_options'];
}
$form = [];
$form['name'] = [
'#type' => 'textfield',
'#title' => t('Style Name'),
'#description' => t('It must contain only alphanumeric characters and underscores.'),
'#default_value' => isset($style->name) ? $style->name : '',
];
$form['style'] = [
'#type' => 'value',
'#value' => isset($style) ? $style : NULL,
];
// TODO: Add this into mapping
$style_info = [
'fill' => t('background color (string - html color)'),
'strokeWidth' => t('width of border (integer)'),
'strokeStyle' => t('color of border (string - html color)'),
'width' => t('width of popup (number with px or em)'),
'padding' => t('space between content and border (number with px em)'),
'cornerRadius' => t('Controls roundness of corners (integer)'),
'spikeGirth' => t('thickness of spike (integer)'),
'spikeLength' => t('length of spike (integer)'),
'shadowBlur' => t('Size of popup shadow (integer)'),
'shadowColor' => t('Color of popup shadow (string - html color)'),
];
$form['custom_styles'] = [
'#type' => 'fieldset',
'#title' => t('Custom Style Options'),
'#description' => t('<div id="beautytips-popup-changes"><div id="beauty-click-text"><p></p></div></div>'),
'#attributes' => [
'class' => [
'bt-custom-styles',
],
],
'#tree' => TRUE,
];
foreach ($style_info as $option => $description) {
$form['custom_styles'][$option] = [
'#title' => $option,
'#description' => $description,
'#type' => 'textfield',
'#default_value' => isset($style_options) && isset($style->{$style_options[$option]}) && !is_null($style->{$style_options[$option]}) ? $style->{$style_options[$option]} : '',
];
}
$form['custom_styles']['shadow'] = [
'#title' => 'shadow',
'#description' => t('Whether or not the popup has a shadow'),
'#type' => 'radios',
'#options' => [
'default' => t('Default'),
'shadow' => t('Shadow On'),
'no_shadow' => t('Shadow Off'),
],
'#attributes' => [
'class' => [
'beautytips-options-shadow',
],
],
'#default_value' => isset($style->shadow) ? $style->shadow : 'default',
];
$form['custom_styles']['cssClass'] = [
'#title' => 'cssClass',
'#description' => t('The class that will be applied to the box wrapper div (of the TIP)'),
'#type' => 'textfield',
'#default_value' => isset($style->css_class) ? $style->css_class : '',
];
$css_style_info = [
'color',
'fontFamily',
'fontWeight',
'fontSize',
];
$form['custom_styles']['css-styles'] = [
'#type' => 'fieldset',
'#title' => t('Font Styling'),
'#description' => t('Enter css options for changing the font style'),
'#attributes' => [
'class' => [
'beautytips-css-styling',
],
],
'#collapsible' => FALSE,
];
foreach ($css_style_info as $option) {
$form['custom_styles']['css-styles'][$option] = [
'#title' => $option,
'#type' => 'textfield',
'#default_value' => isset($css_style_options) && isset($style->{$css_style_options[$option]}) && !is_null($style->{$css_style_options[$option]}) ? $style->{$css_style_options[$option]} : '',
];
}
$path = drupal_get_path('module', 'beautytips');
// TODO: This could be in a library
drupal_add_js($path . '/other_libs/colorpicker/js/colorpicker.js');
drupal_add_css($path . '/other_libs/colorpicker/css/colorpicker.css');
beautytips_add_beautytips();
drupal_add_js($path . '/js/bt_custom_styles.js');
$form['save'] = [
'#type' => 'submit',
'#value' => t('Save'),
];
return $form;
}
/**
* Validation callback on beautytips_manager_custom_styles_form.
*/
function beautytips_manager_custom_styles_form_validate($form, &$form_state) {
$values = $form_state['values'];
if (empty($values['name'])) {
form_set_error('name', t('You must name this custom style.'));
}
if (preg_match('/[^a-zA-Z0-9_]/', $values['name'])) {
form_set_error('name', t('Style name must be alphanumeric or underscores only.'));
}
$integer_fields = [
'strokeWidth' => 'style',
'cornerRadius' => 'style',
'spikeGirth' => 'style',
'spikeLength' => 'style',
'shadowBlur' => 'style',
];
$pixel_fields = [
'width' => 'style',
'padding' => 'style',
'fontSize' => 'css',
];
// Validate fields that expect a number
foreach ($integer_fields as $name => $type) {
$value = $type == 'css' ? $values['custom_styles']['css-styles'][$name] : $values['custom_styles'][$name];
if ($value) {
if (!ctype_digit($value)) {
$error_element = $type == 'css' ? 'custom_styles][css-styles][' . $name : 'custom_styles][' . $name;
form_set_error($error_element, t('You need to enter an integer value for <em>@name</em>', [
'@name' => $name,
]));
}
}
}
// Validate fields that expect a number and unit
foreach ($pixel_fields as $name => $type) {
$value = $type == 'css' ? $values['custom_styles']['css-styles'][$name] : $values['custom_styles'][$name];
if ($value) {
$unit = substr($value, -2, 2);
$value = str_replace([
'px',
' ',
'em',
], '', $value);
if (!is_numeric($value) || !$value && $value != 0 || !in_array($unit, [
'px',
'em',
])) {
$error_element = $type == 'css' ? 'custom_styles][css-styles][' . $name : 'custom_styles][' . $name;
form_set_error($error_element, t('You need to enter a numeric value for <em>@name</em>, followed by <em>px</em> or <em>em</em>', [
'@name' => $name,
]));
}
}
}
}
/**
* Submission callback on beautytips_manager_custom_styles_form.
*/
function beautytips_manager_custom_styles_form_submit($form, &$form_state) {
$style = new stdClass();
$style->name = $form_state['values']['name'];
$mapping = beautytips_manager_style_mapping();
foreach ($form_state['values']['custom_styles'] as $custom_style => $value) {
if (!is_array($value)) {
$field = $custom_style;
if (isset($mapping['options'][$custom_style])) {
$style->{$mapping['options'][$custom_style]} = $value;
}
}
else {
if ($custom_style == 'css-styles') {
foreach ($value as $css_style => $css_value) {
if (isset($mapping['css_options'][$css_style])) {
$style->{$mapping['css_options'][$css_style]} = $css_value;
}
}
}
}
}
if (!is_null($form_state['values']['style'])) {
$style->id = $form_state['values']['style']->id;
}
beautytips_manager_save_custom_style($style);
cache_clear_all('beautytips:beautytips-styles', 'cache');
$form_state['redirect'] = 'admin/config/user-interface/beautytips/custom-styles';
}
/**
* Confirm form for deleting a custom beautytip.
*/
function beautytips_manager_delete_tip_confirm_form($form, &$form_state, $id) {
$tip = beautytips_manager_get_custom_tip($id);
$form['id'] = [
'#type' => 'value',
'#value' => $id,
];
$question = t('Are you sure you want to the beautytip applied to element %element?', [
'%element' => $tip->element,
]);
return confirm_form($form, $question, 'admin/config/user-interface/beautytips/custom-tips');
}
/**
* Submit callback for beautytips delete confirm form.
*/
function beautytips_manager_delete_tip_confirm_form_submit($form, &$form_state) {
beautytips_manager_delete_custom_tip($form_state['values']['id']);
cache_clear_all('beautytips:beautytips-ui-custom-tips', 'cache');
$form_state['redirect'] = 'admin/config/user-interface/beautytips/custom-tips';
}
/**
* Page callback for style deletion form.
*/
function beautytips_manager_delete_style_page($id) {
$style = beautytips_manager_get_custom_style($id);
if ($style->name == variable_get('beautytips_default_style', 'plain')) {
return t('You cannot delete this style because is set as the default style. You may change this <a href="@link">here</a>.', [
'@link' => '/admin/config/user-interface/beautytips',
]);
}
return drupal_get_form('beautytips_manager_delete_style_confirm_form', $id);
}
/**
* Confirm form for deleting a custom beautytip style.
*/
function beautytips_manager_delete_style_confirm_form($form, &$form_state, $id) {
$style = beautytips_manager_get_custom_style($id);
$form['id'] = [
'#type' => 'value',
'#value' => $id,
];
$question = t('Are you sure you want to the beautytip stlye %style?', [
'%style' => $style->name,
]);
return confirm_form($form, $question, 'admin/config/user-interface/beautytips/custom-styles');
}
/**
* Submit callback for beautytips delete confirm form.
*/
function beautytips_manager_delete_style_confirm_form_submit($form, &$form_state) {
beautytips_manager_delete_custom_style($form_state['values']['id']);
$form_state['redirect'] = 'admin/config/user-interface/beautytips/custom-styles';
}Functions
Name |
Description |
|---|---|
| beautytips_manager_custom_styles_form | Form for editing a custom beautytip style. |
| beautytips_manager_custom_styles_form_submit | Submission callback on beautytips_manager_custom_styles_form. |
| beautytips_manager_custom_styles_form_validate | Validation callback on beautytips_manager_custom_styles_form. |
| beautytips_manager_custom_tips_form | Form for configuring custom beautytips. |
| beautytips_manager_custom_tips_form_submit | Submission callback for beautytips manager custom tips form. |
| beautytips_manager_custom_tips_form_validate | Validation callback for beautytips manager custom tips form. |
| beautytips_manager_delete_style_confirm_form | Confirm form for deleting a custom beautytip style. |
| beautytips_manager_delete_style_confirm_form_submit | Submit callback for beautytips delete confirm form. |
| beautytips_manager_delete_style_page | Page callback for style deletion form. |
| beautytips_manager_delete_tip_confirm_form | Confirm form for deleting a custom beautytip. |
| beautytips_manager_delete_tip_confirm_form_submit | Submit callback for beautytips delete confirm form. |
| beautytips_manager_styles_manager_page | Page callback for custom styles administration. |
| beautytips_manager_tips_manager_page | Listing of all beautytips available. |