class SlickUi in Slick Carousel 7.2
CTools Export UI class handler for Slick UI.
Hierarchy
- class \ctools_export_ui
- class \SlickUi
Expanded class hierarchy of SlickUi
1 string reference to 'SlickUi'
- slick_ui.inc in slick_ui/
plugins/ export_ui/ slick_ui.inc - Export interface plugin.
File
- slick_ui/
plugins/ export_ui/ SlickUi.class.php, line 11 - Contains the CTools export UI integration code.
View source
class SlickUi extends ctools_export_ui {
/**
* Overrides the actual editing form.
*/
public function edit_form(&$form, &$form_state) {
parent::edit_form($form, $form_state);
ctools_form_include($form_state, 'slick.admin', 'slick');
ctools_form_include($form_state, 'slick.theme', 'slick', 'templates');
$module_path = drupal_get_path('module', 'slick');
$optionset = $form_state['item'];
$options = $optionset->options;
if (variable_get('slick_admin_css', TRUE)) {
$form['#attached']['library'][] = array(
'slick_ui',
'slick.ui',
);
$form['#attached']['css'][] = $module_path . '/css/admin/slick.admin--vertical-tabs.css';
}
$form['#attributes']['class'][] = 'form--slick';
$form['#attributes']['class'][] = 'form--compact';
$form['#attributes']['class'][] = 'form--optionset';
$form['#attributes']['class'][] = 'has-tooltip clearfix';
$form['info']['name']['#attributes']['class'][] = 'is-tooltip';
$form['info']['label']['#attributes']['class'][] = 'is-tooltip';
$form['info']['label']['#prefix'] = '<div class="form--slick__header has-tooltip clearfix">';
// Skins. We don't provide skin_thumbnail as each optionset may be deployed
// as main display, or thumbnail navigation.
$skins_main = slick_get_skins_by_group('main', TRUE);
$skins_thumbnail = slick_get_skins_by_group('thumbnail', TRUE);
$skins = array_merge($skins_main, $skins_thumbnail);
$form['skin'] = array(
'#type' => 'select',
'#title' => t('Skin'),
'#options' => $skins,
'#default_value' => $optionset->skin,
'#empty_option' => t('- None -'),
'#description' => t('Skins allow swappable layouts like next/prev links, split image and caption, etc. Be sure to provide a dedicated slide layout per field. However a combination of skins and options may lead to unpredictable layouts, get dirty yourself. See main <a href="@skin">README</a> for details on Skins. Keep it simple for thumbnail navigation skin.', array(
'@skin' => url($module_path . '/README.txt'),
)),
'#attributes' => array(
'class' => array(
'is-tooltip',
),
),
);
$form['breakpoints'] = array(
'#title' => t('Breakpoints'),
'#type' => 'textfield',
'#description' => t('The number of breakpoints added to Responsive display, max 9. This is not Breakpoint Width (480px, etc).'),
'#default_value' => isset($form_state['values']['breakpoints']) ? $form_state['values']['breakpoints'] : $optionset->breakpoints,
'#suffix' => '</div>',
'#ajax' => array(
'callback' => 'slick_ui_add_breakpoints',
'wrapper' => 'breakpoints-ajax-wrapper',
'event' => 'blur',
),
'#attributes' => array(
'class' => array(
'is-tooltip',
),
),
'#maxlength' => 1,
);
// Options.
$form['options'] = array(
'#type' => 'vertical_tabs',
'#tree' => TRUE,
);
$is_optimized = $optionset->name == 'default' ? 0 : 1;
$form['options']['optimized'] = array(
'#type' => 'checkbox',
'#title' => t('Optimized'),
'#attributes' => array(
'class' => array(
'is-tooltip',
),
),
'#default_value' => isset($options['optimized']) ? $options['optimized'] : $is_optimized,
'#description' => t('Check to optimize the stored options. Anything similar to defaults will be excluded, except those required by sub-modules and theme_slick(). Like you hand-code/ cherry-pick the needed options, and frees up memory. The rest are taken care of by JS. Uncheck only if theme_slick() can not satisfy the needs, and more hand-coded preprocess is needed which is less likely in most cases.'),
'#access' => $optionset->name != 'default',
);
// Image styles.
$image_styles = function_exists('image_style_options') ? image_style_options(FALSE) : array();
$form['options']['general'] = array(
'#type' => 'fieldset',
'#title' => t('General'),
'#attributes' => array(
'class' => array(
'has-tooltip',
'fieldset--no-checkboxes-label',
),
),
);
$form['options']['general']['normal'] = array(
'#type' => 'select',
'#title' => t('Image style'),
'#description' => t('Image style for the main/background image, overriden by field formatter. Useful for custom work.'),
'#empty_option' => t('None (original image)'),
'#options' => $image_styles,
'#default_value' => isset($options['general']['normal']) ? $options['general']['normal'] : '',
'#attributes' => array(
'class' => array(
'is-tooltip',
),
),
);
// More useful for custom work, overriden by sub-modules.
$form['options']['general']['thumbnail'] = array(
'#type' => 'select',
'#title' => t('Thumbnail style'),
'#description' => t('Image style for the thumbnail image if using asNavFor, overriden by field formatter. Useful for custom work.'),
'#empty_option' => t('None (original image)'),
'#options' => $image_styles,
'#default_value' => isset($options['general']['thumbnail']) ? $options['general']['thumbnail'] : '',
'#attributes' => array(
'class' => array(
'is-tooltip',
),
),
);
$form['options']['general']['template_class'] = array(
'#type' => 'textfield',
'#title' => t('Wrapper class'),
'#description' => t('Additional template wrapper classes separated by spaces. No need to prefix it with a dot (.).'),
'#default_value' => isset($options['general']['template_class']) ? $options['general']['template_class'] : '',
'#attributes' => array(
'class' => array(
'is-tooltip',
),
),
);
$form['options']['general']['goodies'] = array(
'#type' => 'checkboxes',
'#title' => t('Goodies'),
'#default_value' => !empty($options['general']['goodies']) ? array_values((array) $options['general']['goodies']) : array(),
'#options' => array(
'arrow-down' => t('Use arrow down'),
'pattern' => t('Use pattern overlay'),
'random' => t('Randomize'),
),
'#description' => t('Applies to main display, not thumbnail pager. <ol><li>Pattern overlay is background image with pattern placed over the main stage.</li><li>Arrow down to scroll down into a certain page section, make sure to provide target selector.</li><li>Randomize the slide display, useful to manipulate cached blocks.</li></ol>'),
'#attributes' => array(
'class' => array(
'is-tooltip',
),
),
);
$form['options']['general']['arrow_down_target'] = array(
'#type' => 'textfield',
'#title' => t('Arrow down target'),
'#description' => t('Valid CSS selector to scroll to, e.g.: #main, or #content.'),
'#default_value' => isset($options['general']['arrow_down_target']) ? $options['general']['arrow_down_target'] : '',
'#states' => array(
'visible' => array(
':input[name*=arrow-down]' => array(
'checked' => TRUE,
),
),
),
'#attributes' => array(
'class' => array(
'is-tooltip',
),
),
);
$form['options']['general']['arrow_down_offset'] = array(
'#type' => 'textfield',
'#title' => t('Arrow down offset'),
'#description' => t('Offset when scrolled down from the top.'),
'#default_value' => isset($options['general']['arrow_down_offset']) ? $options['general']['arrow_down_offset'] : '',
'#states' => array(
'visible' => array(
':input[name*=arrow-down]' => array(
'checked' => TRUE,
),
),
),
'#attributes' => array(
'class' => array(
'is-tooltip',
),
),
);
// Add empty suffix to style checkboxes like iOS.
if (variable_get('slick_admin_css', TRUE)) {
foreach ($form['options']['general']['goodies']['#options'] as $key => $value) {
$form['options']['general']['goodies'][$key]['#field_suffix'] = '';
$form['options']['general']['goodies'][$key]['#title_display'] = 'before';
}
}
// Main options.
$slick_elements = $this
->getSlickElements();
$form['options']['settings'] = array(
'#title' => t('Settings'),
'#type' => 'fieldset',
'#collapsible' => FALSE,
'#tree' => TRUE,
'#attributes' => array(
'class' => array(
'fieldset--settings',
'has-tooltip',
),
),
);
foreach ($slick_elements as $name => $element) {
$element['default'] = isset($element['default']) ? $element['default'] : '';
$default_value = isset($options['settings'][$name]) ? $options['settings'][$name] : $element['default'];
$form['options']['settings'][$name] = array(
'#title' => isset($element['title']) ? $element['title'] : '',
'#description' => isset($element['description']) ? $element['description'] : '',
'#default_value' => $default_value,
'#attributes' => array(
'class' => array(
'is-tooltip',
),
),
);
if (isset($element['type'])) {
$form['options']['settings'][$name]['#type'] = $element['type'];
if ($element['type'] == 'textfield') {
$form['options']['settings'][$name]['#size'] = 20;
$form['options']['settings'][$name]['#maxlength'] = 255;
}
if ($element['type'] == 'hidden' && isset($element['states'])) {
unset($element['states']);
}
}
if (isset($element['field_suffix'])) {
$form['options']['settings'][$name]['#field_suffix'] = $element['field_suffix'];
}
if (variable_get('slick_admin_css', TRUE)) {
if (!isset($element['field_suffix']) && is_bool($element['default'])) {
$form['options']['settings'][$name]['#field_suffix'] = '';
$form['options']['settings'][$name]['#title_display'] = 'before';
}
}
if (is_int($element['default'])) {
$form['options']['settings'][$name]['#maxlength'] = 60;
$form['options']['settings'][$name]['#attributes']['class'][] = 'form-text--int';
}
if (isset($element['states'])) {
$form['options']['settings'][$name]['#states'] = $element['states'];
}
if (isset($element['options'])) {
$form['options']['settings'][$name]['#options'] = $element['options'];
}
if (isset($element['empty_option'])) {
$form['options']['settings'][$name]['#empty_option'] = $element['empty_option'];
}
// Expand textfield for easy edit.
if (in_array($name, array(
'prevArrow',
'nextArrow',
))) {
$form['options']['settings'][$name]['#default_value'] = trim(strip_tags($default_value));
}
}
// Responsive options.
$form['options']['responsives'] = array(
'#title' => t('Responsive display'),
'#type' => 'fieldset',
'#description' => t('Containing breakpoints and settings objects. Settings set at a given breakpoint/screen width is self-contained and does not inherit the main settings, but defaults. Be sure to set Breakpoints option above.'),
'#collapsible' => FALSE,
'#tree' => TRUE,
);
$form['options']['responsives']['responsive'] = array(
'#title' => t('Responsive'),
'#type' => 'fieldset',
'#collapsible' => FALSE,
'#attributes' => array(
'class' => array(
'has-tooltip',
'fieldset--responsive--ajax',
),
),
'#prefix' => '<div id="breakpoints-ajax-wrapper">',
'#suffix' => '</div>',
);
$breakpoints_count = isset($form_state['values']['breakpoints']) ? $form_state['values']['breakpoints'] : $optionset->breakpoints;
$form_state['breakpoints_count'] = $breakpoints_count;
if ($form_state['breakpoints_count'] > 0) {
$slick_responsive_elements = $this
->getSlickResponsiveElements($form_state['breakpoints_count']);
foreach ($slick_responsive_elements as $i => $responsives) {
// Individual breakpoint fieldset.
$fieldset_class = drupal_clean_css_identifier(drupal_strtolower($responsives['title']));
$form['options']['responsives']['responsive'][$i] = array(
'#title' => $responsives['title'],
'#type' => $responsives['type'],
'#description' => isset($responsives['description']) ? $responsives['description'] : '',
'#collapsible' => TRUE,
'#collapsed' => TRUE,
'#attributes' => array(
'class' => array(
'fieldset--responsive',
'fieldset--' . $fieldset_class,
'has-tooltip',
),
),
);
foreach ($responsives as $key => $responsive) {
switch ($key) {
case 'breakpoint':
case 'unslick':
$form['options']['responsives']['responsive'][$i][$key] = array(
'#title' => $responsive['title'],
'#description' => $responsive['description'],
'#type' => $responsive['type'],
'#default_value' => isset($options['responsives']['responsive'][$i][$key]) ? $options['responsives']['responsive'][$i][$key] : $responsive['default'],
'#attributes' => array(
'class' => array(
'is-tooltip',
),
),
);
if ($responsive['type'] == 'textfield') {
$form['options']['responsives']['responsive'][$i][$key]['#size'] = 20;
$form['options']['responsives']['responsive'][$i][$key]['#maxlength'] = 255;
}
if (is_int($responsive['default'])) {
$form['options']['responsives']['responsive'][$i][$key]['#maxlength'] = 60;
}
if (isset($responsive['states'])) {
$form['options']['responsives']['responsive'][$i][$key]['#states'] = $responsive['states'];
}
if (isset($responsive['options'])) {
$form['options']['responsives']['responsive'][$i][$key]['#options'] = $responsive['options'];
}
if (isset($responsive['field_suffix'])) {
$form['options']['responsives']['responsive'][$i][$key]['#field_suffix'] = $responsive['field_suffix'];
}
if (variable_get('slick_admin_css', TRUE)) {
if (!isset($responsive['field_suffix']) && $responsive['type'] == 'checkbox') {
$form['options']['responsives']['responsive'][$i][$key]['#field_suffix'] = '';
$form['options']['responsives']['responsive'][$i][$key]['#title_display'] = 'before';
}
}
break;
case 'settings':
$form['options']['responsives']['responsive'][$i][$key] = array(
'#title' => t('Settings'),
'#title_display' => 'invisible',
'#type' => 'fieldset',
'#collapsible' => FALSE,
'#collapsed' => FALSE,
'#attributes' => array(
'class' => array(
'fieldset--settings',
'fieldset--' . $fieldset_class,
'has-tooltip',
),
),
'#states' => array(
'visible' => array(
':input[name*="[responsive][' . $i . '][unslick]"]' => array(
'checked' => FALSE,
),
),
),
);
unset($responsive['title'], $responsive['type']);
if (!is_array($responsive)) {
break;
}
foreach ($responsive as $k => $item) {
if ($item && !is_array($item)) {
continue;
}
$item['default'] = isset($item['default']) ? $item['default'] : '';
$form['options']['responsives']['responsive'][$i][$key][$k] = array(
'#title' => isset($item['title']) ? $item['title'] : '',
'#description' => isset($item['description']) ? $item['description'] : '',
'#attributes' => array(
'class' => array(
'is-tooltip',
),
),
'#default_value' => isset($options['responsives']['responsive'][$i][$key][$k]) ? $options['responsives']['responsive'][$i][$key][$k] : $item['default'],
);
if (isset($item['type'])) {
$form['options']['responsives']['responsive'][$i][$key][$k]['#type'] = $item['type'];
}
// Specify proper states for the breakpoint elements.
if (isset($item['states'])) {
$states = '';
switch ($k) {
case 'pauseOnHover':
case 'pauseOnDotsHover':
case 'autoplaySpeed':
$states = array(
'visible' => array(
':input[name*="[' . $i . '][settings][autoplay]"]' => array(
'checked' => TRUE,
),
),
);
break;
case 'centerPadding':
$states = array(
'visible' => array(
':input[name*="[' . $i . '][settings][centerMode]"]' => array(
'checked' => TRUE,
),
),
);
break;
case 'touchThreshold':
$states = array(
'visible' => array(
':input[name*="[' . $i . '][settings][touchMove]"]' => array(
'checked' => TRUE,
),
),
);
break;
case 'swipeToSlide':
$states = array(
'visible' => array(
':input[name*="[' . $i . '][settings][swipe]"]' => array(
'checked' => TRUE,
),
),
);
break;
case 'cssEase':
case 'cssEaseOverride':
$states = array(
'visible' => array(
':input[name*="[' . $i . '][settings][useCSS]"]' => array(
'checked' => TRUE,
),
),
);
break;
case 'verticalSwiping':
$states = array(
'visible' => array(
':input[name*="[' . $i . '][settings][vertical]"]' => array(
'checked' => TRUE,
),
),
);
break;
}
if ($states) {
$form['options']['responsives']['responsive'][$i][$key][$k]['#states'] = $states;
}
}
if (isset($item['options'])) {
$form['options']['responsives']['responsive'][$i][$key][$k]['#options'] = $item['options'];
}
if (isset($item['empty_option'])) {
$form['options']['responsives']['responsive'][$i][$key][$k]['#empty_option'] = $item['empty_option'];
}
if (isset($item['field_suffix'])) {
$form['options']['responsives']['responsive'][$i][$key][$k]['#field_suffix'] = $item['field_suffix'];
}
if (variable_get('slick_admin_css', TRUE)) {
if (!isset($item['field_suffix']) && is_bool($item['default'])) {
$form['options']['responsives']['responsive'][$i][$key][$k]['#field_suffix'] = '';
$form['options']['responsives']['responsive'][$i][$key][$k]['#title_display'] = 'before';
}
}
}
break;
default:
break;
}
}
}
}
// Allows form elements information to be altered without a class.
// @see ctools_export_ui_edit_item_form
drupal_alter('slick_ui_optionset_form', $form, $form_state);
}
/**
* Overrides the edit form submit handler.
*
* At this point, submission is successful. Our only responsibility is
* to copy anything out of values onto the item that we are able to edit.
*
* If the keys all match up to the schema, this method will not need to be
* overridden.
*/
public function edit_form_submit(&$form, &$form_state) {
parent::edit_form_submit($form, $form_state);
$options = $form_state['values']['options'];
$optionset = $form_state['item'];
$optimized = isset($options['optimized']) ? $options['optimized'] : FALSE;
// Map and update the friendly CSS easing to its bezier equivalent.
$override = '';
if ($form_state['values']['options']['settings']['cssEaseOverride']) {
$override = $this
->getBezier($form_state['values']['options']['settings']['cssEaseOverride']);
}
$optionset->options['settings']['cssEaseBezier'] = $override;
if (isset($options['responsives']['responsive'])) {
foreach ($options['responsives']['responsive'] as $key => $responsive) {
if (isset($responsive['settings']['cssEaseOverride'])) {
$responsive_override = $responsive['settings']['cssEaseOverride'] ? $this
->getBezier($responsive['settings']['cssEaseOverride']) : '';
$optionset->options['responsives']['responsive'][$key]['settings']['cssEaseBezier'] = $responsive_override;
}
}
}
// Typecast the values.
_slick_typecast_optionset($optionset->options, $form_state['values']['breakpoints']);
// Optimized if so configured.
if (!empty($optimized)) {
$defaults = slick_get_options();
$required = $this
->getOptionsRequiredByTemplate();
$main = array_diff_assoc($defaults, $required);
$settings = $optionset->options['settings'];
// Remove wasted dependent options if disabled, empty or not.
slick_remove_wasted_dependent_options($settings);
$optionset->options['settings'] = array_diff_assoc($settings, $main);
if (isset($options['responsives']['responsive'])) {
$responsives =& $optionset->options['responsives']['responsive'];
foreach ($responsives as $key => &$responsive) {
if (!empty($responsive['unslick'])) {
$responsives[$key]['settings'] = array();
}
else {
slick_remove_wasted_dependent_options($responsives[$key]['settings']);
$responsives[$key]['settings'] = array_diff_assoc($responsives[$key]['settings'], $defaults);
}
}
}
}
// Remove useless option.
if (isset($options['options__active_tab'])) {
unset($optionset->options['options__active_tab']);
}
}
/**
* Defines a list of form elements available for the Slick.
*
* @return array
* All available Slick form elements.
*
* @see http://kenwheeler.github.io/slick
*/
public function getSlickElements() {
$elements =& drupal_static(__METHOD__, NULL);
if (!isset($elements)) {
$elements = array();
$elements['mobileFirst'] = array(
'title' => t('Mobile first'),
'description' => t('Responsive settings use mobile first calculation, or equivalent to min-width query.'),
'type' => 'checkbox',
);
$elements['asNavFor'] = array(
'title' => t('asNavFor target'),
'description' => t('Leave empty if using sub-modules to have it auto-matched. Set the slider to be the navigation of other slider (Class or ID Name). Use selector identifier ("." or "#") accordingly. See HTML structure section at README.txt for more info. Overriden by field formatter, or Views style.'),
'type' => 'textfield',
);
$elements['accessibility'] = array(
'title' => t('Accessibility'),
'description' => t('Enables tabbing and arrow key navigation.'),
'type' => 'checkbox',
);
$elements['adaptiveHeight'] = array(
'title' => t('Adaptive height'),
'description' => t('Enables adaptive height for SINGLE slide horizontal carousels. This is useless with variableWidth.'),
'type' => 'checkbox',
);
$elements['autoplay'] = array(
'title' => t('Autoplay'),
'description' => t('Enables autoplay.'),
'type' => 'checkbox',
);
$elements['autoplaySpeed'] = array(
'title' => t('Autoplay speed'),
'description' => t('Autoplay speed in milliseconds.'),
'type' => 'textfield',
'states' => array(
'visible' => array(
':input[name*="options[settings][autoplay]"]' => array(
'checked' => TRUE,
),
),
),
);
$elements['pauseOnHover'] = array(
'title' => t('Pause on hover'),
'description' => t('Pause autoplay on hover.'),
'type' => 'checkbox',
'states' => array(
'visible' => array(
':input[name*="options[settings][autoplay]"]' => array(
'checked' => TRUE,
),
),
),
);
$elements['pauseOnDotsHover'] = array(
'title' => t('Pause on dots hover'),
'description' => t('Pauses autoplay when a dot is hovered.'),
'type' => 'checkbox',
'states' => array(
'visible' => array(
':input[name*="options[settings][autoplay]"]' => array(
'checked' => TRUE,
),
),
),
);
$elements['arrows'] = array(
'title' => t('Arrows'),
'description' => t('Show prev/next arrows'),
'type' => 'checkbox',
);
$elements['prevArrow'] = array(
'title' => t('Previous arrow'),
'description' => t("Customize the previous arrow text."),
'type' => 'textfield',
'states' => array(
'visible' => array(
':input[name*="options[settings][arrows]"]' => array(
'checked' => TRUE,
),
),
),
);
$elements['nextArrow'] = array(
'title' => t('Next arrow'),
'description' => t("Customize the next arrow text."),
'type' => 'textfield',
'states' => array(
'visible' => array(
':input[name*="options[settings][arrows]"]' => array(
'checked' => TRUE,
),
),
),
);
$elements['centerMode'] = array(
'title' => t('Center mode'),
'description' => t('Enables centered view with partial prev/next slides. Use with odd numbered slidesToShow counts.'),
'type' => 'checkbox',
);
$elements['centerPadding'] = array(
'title' => t('Center padding'),
'description' => t('Side padding when in center mode (px or %). Be aware, too large padding at small breakpoint will screw the slide calculation with slidesToShow.'),
'type' => 'textfield',
'states' => array(
'visible' => array(
':input[name*="options[settings][centerMode]"]' => array(
'checked' => TRUE,
),
),
),
);
$elements['dots'] = array(
'title' => t('Dots'),
'description' => t('Show dot indicators.'),
'type' => 'checkbox',
);
$elements['dotsClass'] = array(
'title' => t('Dot class'),
'description' => t('Class for slide indicator dots container. Do not prefix with dot. If you change this, edit its CSS accordingly.'),
'type' => 'textfield',
'states' => array(
'visible' => array(
':input[name*="options[settings][dots]"]' => array(
'checked' => TRUE,
),
),
),
);
$elements['appendDots'] = array(
'title' => t('Append dots'),
'description' => t('Change where the navigation dots are attached (Selector, htmlString). If you change this, be sure to provide its relevant markup. Try <strong>.slick__arrow</strong> to achieve this style: <br />< o o o o o o o ><br />Be sure to enable Arrows in such a case.'),
'type' => 'textfield',
'states' => array(
'visible' => array(
':input[name*="options[settings][dots]"]' => array(
'checked' => TRUE,
),
),
),
);
$elements['draggable'] = array(
'title' => t('Draggable'),
'description' => t('Enable mouse dragging.'),
'type' => 'checkbox',
);
$elements['fade'] = array(
'title' => t('Fade'),
'description' => t('Enable fade. Warning! This wants slidesToShow 1. Larger than 1, and Slick may be screwed up.'),
'type' => 'checkbox',
);
$elements['focusOnSelect'] = array(
'title' => t('Focus on select'),
'description' => t('Enable focus on selected element (click).'),
'type' => 'checkbox',
);
$elements['infinite'] = array(
'title' => t('Infinite'),
'description' => t('Infinite loop sliding.'),
'type' => 'checkbox',
);
$elements['initialSlide'] = array(
'title' => t('Initial slide'),
'description' => t('Slide to start on.'),
'type' => 'textfield',
);
$lazies = array(
'anticipated',
'ondemand',
'progressive',
);
$elements['lazyLoad'] = array(
'title' => t('Lazy load'),
'description' => t("Set lazy loading technique. 'ondemand' will load the image as soon as you slide to it, 'progressive' loads one image after the other when the page loads. 'anticipated' preloads images, and requires Slick 1.6.1+. Note: dummy image is no good for ondemand. If ondemand fails to generate images, try progressive instead. Or use <a href='@url' target='_blank'>imageinfo_cache</a>. To share images for Pinterest, leave empty, otherwise no way to read actual image src.", array(
'@url' => '//www.drupal.org/project/imageinfo_cache',
)),
'type' => 'select',
'options' => drupal_map_assoc($lazies),
'empty_option' => t('- None -'),
);
if (module_exists('blazy')) {
$elements['lazyLoad']['options']['blazy'] = 'Blazy';
}
$elements['respondTo'] = array(
'title' => t('Respond to'),
'description' => t("Width that responsive object responds to. Can be 'window', 'slider' or 'min' (the smaller of the two)."),
'type' => 'select',
'options' => drupal_map_assoc(array(
'window',
'slider',
'min',
)),
);
$elements['rtl'] = array(
'title' => t('RTL'),
'description' => t("Change the slider's direction to become right-to-left."),
'type' => 'checkbox',
);
$elements['rows'] = array(
'title' => t('Rows'),
'description' => t("Setting this to more than 1 initializes grid mode. Use slidesPerRow to set how many slides should be in each row."),
'type' => 'textfield',
);
$elements['slidesPerRow'] = array(
'title' => t('Slides per row'),
'description' => t("With grid mode intialized via the rows option, this sets how many slides are in each grid row."),
'type' => 'textfield',
);
$elements['slide'] = array(
'title' => t('Slide element'),
'description' => t("Element query to use as slide. Slick will use any direct children as slides, without having to specify which tag or selector to target."),
'type' => 'textfield',
);
$elements['slidesToShow'] = array(
'title' => t('Slides to show'),
'description' => t('Number of slides to show at a time. If 1, it will behave like slideshow, more than 1 a carousel. Provide more if it is a thumbnail navigation with asNavFor. Only works with odd number slidesToShow counts when using centerMode (e.g.: 3, 5, 7, etc.). Not-compatible with variableWidth.'),
'type' => 'textfield',
);
$elements['slidesToScroll'] = array(
'title' => t('Slides to scroll'),
'description' => t('Number of slides to scroll at a time, or steps at each scroll.'),
'type' => 'textfield',
);
$elements['speed'] = array(
'title' => t('Speed'),
'description' => t('Slide/Fade animation speed in milliseconds.'),
'type' => 'textfield',
'field_suffix' => 'ms',
);
$elements['swipe'] = array(
'title' => t('Swipe'),
'description' => t('Enable swiping.'),
'type' => 'checkbox',
);
$elements['swipeToSlide'] = array(
'title' => t('Swipe to slide'),
'description' => t('Allow users to drag or swipe directly to a slide irrespective of slidesToScroll.'),
'type' => 'checkbox',
'states' => array(
'visible' => array(
':input[name*="options[settings][swipe]"]' => array(
'checked' => TRUE,
),
),
),
);
$elements['edgeFriction'] = array(
'title' => t('Edge friction'),
'description' => t("Resistance when swiping edges of non-infinite carousels. If you don't want resistance, set it to 1."),
'type' => 'textfield',
);
$elements['touchMove'] = array(
'title' => t('Touch move'),
'description' => t('Enable slide motion with touch.'),
'type' => 'checkbox',
);
$elements['touchThreshold'] = array(
'title' => t('Touch threshold'),
'description' => t('Swipe distance threshold.'),
'type' => 'textfield',
'states' => array(
'visible' => array(
':input[name*="options[settings][touchMove]"]' => array(
'checked' => TRUE,
),
),
),
);
$elements['useCSS'] = array(
'title' => t('Use CSS'),
'description' => t('Enable/disable CSS transitions.'),
'type' => 'checkbox',
);
$elements['cssEase'] = array(
'title' => t('CSS ease'),
'description' => t('CSS3 animation easing. <a href="@ceaser">Learn</a> <a href="@bezier">more</a>. Ignored if <strong>CSS ease override</strong> is provided.', array(
'@ceaser' => '//matthewlein.com/ceaser/',
'@bezier' => '//cubic-bezier.com',
)),
'type' => 'textfield',
'states' => array(
'visible' => array(
':input[name*="options[settings][useCSS]"]' => array(
'checked' => TRUE,
),
),
),
);
$elements['cssEaseBezier'] = array(
'type' => 'hidden',
);
$elements['cssEaseOverride'] = array(
'title' => t('CSS ease override'),
'description' => t('If provided, this will override the CSS ease with the pre-defined CSS easings based on <a href="@ceaser">CSS Easing Animation Tool</a>. Leave it empty to use your own CSS ease.', array(
'@ceaser' => '//matthewlein.com/ceaser/',
)),
'type' => 'select',
'options' => $this
->getCssEasingOptions(),
'empty_option' => t('- None -'),
'states' => array(
'visible' => array(
':input[name*="options[settings][useCSS]"]' => array(
'checked' => TRUE,
),
),
),
);
$elements['useTransform'] = array(
'title' => t('Use transform'),
'description' => t('Enable/disable CSS transforms.'),
'type' => 'checkbox',
);
$elements['easing'] = array(
'title' => t('jQuery easing'),
'description' => t('Add easing for jQuery animate as fallback. Use with <a href="@easing">easing</a> libraries or default easing methods. This will be ignored and replaced by CSS ease for supporting browsers, or effective if useCSS is disabled.', array(
'@easing' => '//gsgd.co.uk/sandbox/jquery/easing/',
)),
'type' => 'select',
'options' => $this
->getJsEasingOptions(),
'empty_option' => t('- None -'),
);
$elements['variableWidth'] = array(
'title' => t('variableWidth'),
'description' => t('Disables automatic slide width calculation. Best with uniform image heights, use scale height image effect. Useless with adaptiveHeight, and non-uniform image heights. Useless with slidesToShow > 1 if the container is smaller than the amount of visible slides. Troubled with lazyLoad ondemand.'),
'type' => 'checkbox',
);
$elements['vertical'] = array(
'title' => t('Vertical'),
'description' => t('Vertical slide direction. See <a href="@url" target="_blank">relevant issue</a>.', array(
'@url' => '//github.com/kenwheeler/slick/issues/1001',
)),
'type' => 'checkbox',
);
$elements['verticalSwiping'] = array(
'title' => t('Vertical swiping'),
'description' => t('Changes swipe direction to vertical.'),
'type' => 'checkbox',
'states' => array(
'visible' => array(
':input[name*="options[settings][vertical]"]' => array(
'checked' => TRUE,
),
),
),
);
$elements['waitForAnimate'] = array(
'title' => t('waitForAnimate'),
'description' => t('Ignores requests to advance the slide while animating.'),
'type' => 'checkbox',
);
// Defines the default values if available.
$defaults = slick_get_options();
foreach ($elements as $name => $element) {
$default = $element['type'] == 'checkbox' ? FALSE : '';
$elements[$name]['default'] = isset($defaults[$name]) ? $defaults[$name] : $default;
}
// Allows form elements information to be altered.
drupal_alter('slick_ui_elements_info', $elements);
}
return $elements;
}
/**
* Defines available options for the responsive Slick.
*
* @param int $count
* The number of breakpoints.
*
* @return array
* An array of Slick responsive options.
*/
public function getSlickResponsiveElements($count = 0) {
$elements = array();
$breakpoints = drupal_map_assoc(range(0, $count - 1));
$slick_elements = slick_clean_options($this
->getSlickElements());
foreach ($breakpoints as $key => $breakpoint) {
$elements[$key] = array(
'title' => t('Breakpoint #@key', array(
'@key' => $key + 1,
)),
'type' => 'fieldset',
);
$elements[$key]['breakpoint'] = array(
'title' => t('Breakpoint'),
'description' => t('Breakpoint width in pixel. If mobileFirst enabled, equivalent to min-width, otherwise max-width.'),
'type' => 'textfield',
'field_suffix' => 'px',
'default' => FALSE,
);
$elements[$key]['unslick'] = array(
'title' => t('Unslick'),
'description' => t("Disable Slick at a given breakpoint. Note, you can't window shrink this, once you unslick, you are unslicked."),
'type' => 'checkbox',
'default' => '',
);
$elements[$key]['settings'] = array();
// Duplicate relevant main settings.
foreach ($slick_elements as $name => $element) {
$elements[$key]['settings'][$name] = $element;
}
// Allows form responsive elements information to be altered.
drupal_alter('slick_ui_responsive_elements_info', $elements);
}
return $elements;
}
/**
* Defines options required by theme_slick(), used with optimized option.
*/
public function getOptionsRequiredByTemplate() {
$options = array(
'asNavFor' => '',
'dotsClass' => 'slick-dots',
'focusOnSelect' => FALSE,
'initialSlide' => 0,
'lazyLoad' => 'ondemand',
'mousewheel' => FALSE,
'prevArrow' => 'Previous',
'nextArrow' => 'Next',
'rtl' => FALSE,
'rows' => 1,
'slidesPerRow' => 1,
'slide' => '',
'slidesToShow' => 1,
);
drupal_alter('slick_ui_options_required_by_template_info', $options);
return $options;
}
/**
* Overrides parent::list_form.
*/
public function list_form(&$form, &$form_state) {
parent::list_form($form, $form_state);
$form['slick description']['#prefix'] = '<div class="ctools-export-ui-row ctools-export-ui-slick-description clearfix">';
$form['slick description']['#markup'] = t("<p>Manage the Slick optionsets. Optionsets are Config Entities.</p><p>By default, when this module is enabled, a single optionset is created from configuration. Install Slick example module to speed up by cloning them. Use the Operations column to edit, clone and delete optionsets.<br /><strong class='error'>Important!</strong> Avoid overriding Default optionset as it is meant for Default -- checking and cleaning. Use Clone, or Add, instead. If you did, please clone it and revert, otherwise messes are yours.<br />Slick doesn't need Slick UI to run. It is always safe to uninstall (not only disable) Slick UI once done with optionsets, either stored at codes, or database.</p>");
$form['slick description']['#suffix'] = '</div>';
}
/**
* Overrides parent::list_build_row.
*/
public function list_build_row($item, &$form_state, $operations) {
parent::list_build_row($item, $form_state, $operations);
$name = $item->{$this->plugin['export']['key']};
$skins = slick_skins();
$breakpoints = $this->items[$name]->breakpoints ? $this->items[$name]->breakpoints : 0;
$skin = $this->items[$name]->skin;
$skin_name = $skin ? check_plain($skin) : t('None');
if ($skin) {
$description = isset($skins[$skin]['description']) && $skins[$skin]['description'] ? filter_xss($skins[$skin]['description']) : '';
if ($description) {
$skin_name .= '<br /><em>' . $description . '</em>';
}
}
$breakpoints_row[] = array(
'data' => $breakpoints,
'class' => array(
'ctools-export-ui-breakpoints',
),
);
array_splice($this->rows[$name]['data'], 2, 0, $breakpoints_row);
$skin_row[] = array(
'data' => $skin_name,
'class' => array(
'ctools-export-ui-skin',
),
'style' => "white-space: normal; word-wrap: break-word; max-width: 320px;",
);
array_splice($this->rows[$name]['data'], 3, 0, $skin_row);
}
/**
* Overrides parent::list_table_header.
*/
public function list_table_header() {
$headers = parent::list_table_header();
$breakpoints_header[] = array(
'data' => t('Breakpoint'),
'class' => array(
'ctools-export-ui-breakpoints',
),
);
array_splice($headers, 2, 0, $breakpoints_header);
$skin_header[] = array(
'data' => t('Skin'),
'class' => array(
'ctools-export-ui-skin',
),
);
array_splice($headers, 3, 0, $skin_header);
return $headers;
}
/**
* Overrides parent::build_operations.
*/
public function build_operations($item) {
$allowed_operations = parent::build_operations($item);
if ($item->name == 'default') {
if (isset($allowed_operations['enable'])) {
unset($allowed_operations['enable']);
}
if (isset($allowed_operations['edit'])) {
unset($allowed_operations['edit']);
}
if (isset($allowed_operations['disable'])) {
unset($allowed_operations['disable']);
}
}
return $allowed_operations;
}
/**
* List of all easing methods available from jQuery Easing v1.3.
*
* @return array
* An array of available jQuery Easing options as fallback for browsers that
* don't support pure CSS easing methods.
*/
public function getJsEasingOptions() {
$easings =& drupal_static(__METHOD__, NULL);
if (!isset($easings)) {
$easings = array(
'linear' => 'Linear',
'swing' => 'Swing',
'easeInQuad' => 'easeInQuad',
'easeOutQuad' => 'easeOutQuad',
'easeInOutQuad' => 'easeInOutQuad',
'easeInCubic' => 'easeInCubic',
'easeOutCubic' => 'easeOutCubic',
'easeInOutCubic' => 'easeInOutCubic',
'easeInQuart' => 'easeInQuart',
'easeOutQuart' => 'easeOutQuart',
'easeInOutQuart' => 'easeInOutQuart',
'easeInQuint' => 'easeInQuint',
'easeOutQuint' => 'easeOutQuint',
'easeInOutQuint' => 'easeInOutQuint',
'easeInSine' => 'easeInSine',
'easeOutSine' => 'easeOutSine',
'easeInOutSine' => 'easeInOutSine',
'easeInExpo' => 'easeInExpo',
'easeOutExpo' => 'easeOutExpo',
'easeInOutExpo' => 'easeInOutExpo',
'easeInCirc' => 'easeInCirc',
'easeOutCirc' => 'easeOutCirc',
'easeInOutCirc' => 'easeInOutCirc',
'easeInElastic' => 'easeInElastic',
'easeOutElastic' => 'easeOutElastic',
'easeInOutElastic' => 'easeInOutElastic',
'easeInBack' => 'easeInBack',
'easeOutBack' => 'easeOutBack',
'easeInOutBack' => 'easeInOutBack',
'easeInBounce' => 'easeInBounce',
'easeOutBounce' => 'easeOutBounce',
'easeInOutBounce' => 'easeInOutBounce',
);
}
return $easings;
}
/**
* List of available pure CSS easing methods.
*
* @param bool $all
* Flag to output the array as is for further processing.
*
* @return array
* An array of CSS easings for select options, or all for the mappings.
*
* @see https://github.com/kenwheeler/slick/issues/118
* @see http://matthewlein.com/ceaser/
* @see http://www.w3.org/TR/css3-transitions/
*/
public function getCssEasingOptions($all = FALSE) {
$css_easings =& drupal_static(__METHOD__, NULL);
if (!isset($css_easings)) {
$css_easings = array();
$available_easings = array(
// Defaults/ Native.
'ease' => 'ease|ease',
'linear' => 'linear|linear',
'ease-in' => 'ease-in|ease-in',
'ease-out' => 'ease-out|ease-out',
'swing' => 'swing|ease-in-out',
// Penner Equations (approximated).
'easeInQuad' => 'easeInQuad|cubic-bezier(0.550, 0.085, 0.680, 0.530)',
'easeInCubic' => 'easeInCubic|cubic-bezier(0.550, 0.055, 0.675, 0.190)',
'easeInQuart' => 'easeInQuart|cubic-bezier(0.895, 0.030, 0.685, 0.220)',
'easeInQuint' => 'easeInQuint|cubic-bezier(0.755, 0.050, 0.855, 0.060)',
'easeInSine' => 'easeInSine|cubic-bezier(0.470, 0.000, 0.745, 0.715)',
'easeInExpo' => 'easeInExpo|cubic-bezier(0.950, 0.050, 0.795, 0.035)',
'easeInCirc' => 'easeInCirc|cubic-bezier(0.600, 0.040, 0.980, 0.335)',
'easeInBack' => 'easeInBack|cubic-bezier(0.600, -0.280, 0.735, 0.045)',
'easeOutQuad' => 'easeOutQuad|cubic-bezier(0.250, 0.460, 0.450, 0.940)',
'easeOutCubic' => 'easeOutCubic|cubic-bezier(0.215, 0.610, 0.355, 1.000)',
'easeOutQuart' => 'easeOutQuart|cubic-bezier(0.165, 0.840, 0.440, 1.000)',
'easeOutQuint' => 'easeOutQuint|cubic-bezier(0.230, 1.000, 0.320, 1.000)',
'easeOutSine' => 'easeOutSine|cubic-bezier(0.390, 0.575, 0.565, 1.000)',
'easeOutExpo' => 'easeOutExpo|cubic-bezier(0.190, 1.000, 0.220, 1.000)',
'easeOutCirc' => 'easeOutCirc|cubic-bezier(0.075, 0.820, 0.165, 1.000)',
'easeOutBack' => 'easeOutBack|cubic-bezier(0.175, 0.885, 0.320, 1.275)',
'easeInOutQuad' => 'easeInOutQuad|cubic-bezier(0.455, 0.030, 0.515, 0.955)',
'easeInOutCubic' => 'easeInOutCubic|cubic-bezier(0.645, 0.045, 0.355, 1.000)',
'easeInOutQuart' => 'easeInOutQuart|cubic-bezier(0.770, 0.000, 0.175, 1.000)',
'easeInOutQuint' => 'easeInOutQuint|cubic-bezier(0.860, 0.000, 0.070, 1.000)',
'easeInOutSine' => 'easeInOutSine|cubic-bezier(0.445, 0.050, 0.550, 0.950)',
'easeInOutExpo' => 'easeInOutExpo|cubic-bezier(1.000, 0.000, 0.000, 1.000)',
'easeInOutCirc' => 'easeInOutCirc|cubic-bezier(0.785, 0.135, 0.150, 0.860)',
'easeInOutBack' => 'easeInOutBack|cubic-bezier(0.680, -0.550, 0.265, 1.550)',
);
foreach ($available_easings as $key => $easing) {
list($readable_easing, $bezier) = array_pad(array_map('trim', explode("|", $easing, 2)), 2, NULL);
$css_easings[$key] = $all ? $easing : $readable_easing;
// Satisfy both phpcs and coder since no skip tolerated.
unset($bezier);
}
}
return $css_easings;
}
/**
* Maps existing jQuery easing value to equivalent CSS easing methods.
*
* @param string $easing
* The name of the human readable easing.
*
* @return string
* A string of unfriendly bezier equivalent for the Slick, or NULL.
*/
public function getBezier($easing = NULL) {
$css_easing = '';
if ($easing) {
$easings = $this
->getCssEasingOptions(TRUE);
list(, $css_easing) = array_pad(array_map('trim', explode("|", $easings[$easing], 2)), 2, NULL);
}
return $css_easing;
}
}Members
Name |
Modifiers | Type | Description | Overrides |
|---|---|---|---|---|
|
ctools_export_ui:: |
property | |||
|
ctools_export_ui:: |
property | |||
|
ctools_export_ui:: |
property | |||
|
ctools_export_ui:: |
public | function | Menu callback to determine if an operation is accessible. | 1 |
|
ctools_export_ui:: |
public | function | ||
|
ctools_export_ui:: |
public | function | Main entry point to clone an item. | |
|
ctools_export_ui:: |
public | function | Deletes exportable items from the database. | |
|
ctools_export_ui:: |
public | function | Page callback to delete an exportable item. | |
|
ctools_export_ui:: |
public | function | Callback to disable a page. | |
|
ctools_export_ui:: |
public | function | Clear the object cache for the currently edited item. | |
|
ctools_export_ui:: |
public | function | Retrieve the item currently being edited from the object cache. | |
|
ctools_export_ui:: |
public | function | Figure out what the cache key is for this object. | |
|
ctools_export_ui:: |
public | function | Cache the item currently currently being edited. | |
|
ctools_export_ui:: |
public | function | ||
|
ctools_export_ui:: |
public | function | Execute the form. | |
|
ctools_export_ui:: |
public | function | Execute the standard form for editing. | |
|
ctools_export_ui:: |
public | function | Execute the wizard for editing. | |
|
ctools_export_ui:: |
public | function | Perform a final validation check before allowing the form to be finished. | |
|
ctools_export_ui:: |
public | function | Import form. Provides simple helptext instructions and textarea for pasting a export definition. | |
|
ctools_export_ui:: |
public | function | Submit callback for import form. | |
|
ctools_export_ui:: |
public | function | Import form validate handler. | |
|
ctools_export_ui:: |
public | function | Validate callback for the edit form. | |
|
ctools_export_ui:: |
public | function | Main entry point to edit an item. | |
|
ctools_export_ui:: |
public | function | Called to save the final product from the edit form. | |
|
ctools_export_ui:: |
public | function | Wizard 'back' callback when using a wizard to edit an item. | |
|
ctools_export_ui:: |
public | function | Wizard 'cancel' callback when using a wizard to edit an item. | |
|
ctools_export_ui:: |
public | function | Wizard 'cancel' callback when using a wizard to edit an item. | 1 |
|
ctools_export_ui:: |
public | function | Wizard 'next' callback when using a wizard to edit an item. | 1 |
|
ctools_export_ui:: |
public | function | Callback to enable a page. | |
|
ctools_export_ui:: |
public | function | Page callback to display export information for an exportable item. | |
|
ctools_export_ui:: |
public | function | Get a page title for the current page from our plugin strings. | |
|
ctools_export_ui:: |
public | function | Get the form info for the wizard. | 1 |
|
ctools_export_ui:: |
public | function | hook_menu() entry point. | |
|
ctools_export_ui:: |
public | function | Page callback to import information for an exportable item. | |
|
ctools_export_ui:: |
public | function | Fake constructor -- this is easier to deal with than the real constructor because we are retaining PHP4 compatibility, which would require all child classes to implement their own constructor. | 1 |
|
ctools_export_ui:: |
public | function | Add listing CSS to the page. | |
|
ctools_export_ui:: |
public | function | Determine if a row should be filtered out. | 2 |
|
ctools_export_ui:: |
public | function | Render a footer to go after thie list. | |
|
ctools_export_ui:: |
public | function | Submit the filter/sort form. | |
|
ctools_export_ui:: |
public | function | Validate the filter/sort form. | |
|
ctools_export_ui:: |
public | function | Render a header to go before the list. | |
|
ctools_export_ui:: |
public | function | Master entry point for handling a list. | |
|
ctools_export_ui:: |
public | function | Render all of the rows together. | |
|
ctools_export_ui:: |
public | function | Provide a list of fields to test against for the default "search" widget. | 1 |
|
ctools_export_ui:: |
public | function | Provide a list of sort options. | 2 |
|
ctools_export_ui:: |
public | function | Called by ctools_export_ui_load to load the item. | |
|
ctools_export_ui:: |
public | function | Perform a drupal_goto() to the location provided by the plugin for the operation. | |
|
ctools_export_ui:: |
public | function | Set an item's state to enabled or disabled and output to user. | |
|
SlickUi:: |
public | function |
Overrides parent::build_operations. Overrides ctools_export_ui:: |
|
|
SlickUi:: |
public | function |
Overrides the actual editing form. Overrides ctools_export_ui:: |
|
|
SlickUi:: |
public | function |
Overrides the edit form submit handler. Overrides ctools_export_ui:: |
|
|
SlickUi:: |
public | function | Maps existing jQuery easing value to equivalent CSS easing methods. | |
|
SlickUi:: |
public | function | List of available pure CSS easing methods. | |
|
SlickUi:: |
public | function | List of all easing methods available from jQuery Easing v1.3. | |
|
SlickUi:: |
public | function | Defines options required by theme_slick(), used with optimized option. | |
|
SlickUi:: |
public | function | Defines a list of form elements available for the Slick. | |
|
SlickUi:: |
public | function | Defines available options for the responsive Slick. | |
|
SlickUi:: |
public | function |
Overrides parent::list_build_row. Overrides ctools_export_ui:: |
|
|
SlickUi:: |
public | function |
Overrides parent::list_form. Overrides ctools_export_ui:: |
|
|
SlickUi:: |
public | function |
Overrides parent::list_table_header. Overrides ctools_export_ui:: |