danielebarchiesi@2: <?php
danielebarchiesi@2: 
danielebarchiesi@2: /**
danielebarchiesi@2:  * @file
danielebarchiesi@2:  * Contains the list style plugin.
danielebarchiesi@2:  */
danielebarchiesi@2: 
danielebarchiesi@2: /**
danielebarchiesi@2:  * Style plugin to render each item in a slideshow of an ordered or unordered list.
danielebarchiesi@2:  *
danielebarchiesi@2:  * @ingroup views_style_plugins
danielebarchiesi@2:  */
danielebarchiesi@2: class views_slideshow_plugin_style_slideshow extends views_plugin_style_list {
danielebarchiesi@2: 
danielebarchiesi@2:   // Set default options
danielebarchiesi@2:   function option_definition() {
danielebarchiesi@2:     $options = parent::option_definition();
danielebarchiesi@2: 
danielebarchiesi@2:     // Load all include files from views slideshow addons.
danielebarchiesi@2:     module_load_all_includes('views_slideshow.inc');
danielebarchiesi@2: 
danielebarchiesi@2:     // call every module using hook_views_slideshow_option_definition and merge
danielebarchiesi@2:     // it's return value with the other default options.
danielebarchiesi@2:     return array_merge($options, module_invoke_all('views_slideshow_option_definition'));
danielebarchiesi@2:   }
danielebarchiesi@2: 
danielebarchiesi@2:   // Build the settings form for the view.
danielebarchiesi@2:   function options_form(&$form, &$form_state) {
danielebarchiesi@2:     // Include ctools dependent support
danielebarchiesi@2:     ctools_include('dependent');
danielebarchiesi@2: 
danielebarchiesi@2:     // load up all views slideshow modules functions.
danielebarchiesi@2:     module_load_all_includes('views_slideshow.inc');
danielebarchiesi@2:     parent::options_form($form, $form_state);
danielebarchiesi@2: 
danielebarchiesi@2:     // Wrap all the form elements to help style the form.
danielebarchiesi@2:     $form['views_slideshow_wrapper'] = array(
danielebarchiesi@2:       '#markup' => '<div id="views-slideshow-form-wrapper">',
danielebarchiesi@2:     );
danielebarchiesi@2: 
danielebarchiesi@2:     // Style
danielebarchiesi@2:     $form['slideshow_skin_header'] = array(
danielebarchiesi@2:       '#markup' => '<h2>' . t('Style') . '</h2>',
danielebarchiesi@2:     );
danielebarchiesi@2: 
danielebarchiesi@2:     // Get a list of all available skins.
danielebarchiesi@2:     $skin_info = $this->views_slideshow_get_skins();
danielebarchiesi@2:     foreach ($skin_info as $skin => $info) {
danielebarchiesi@2:       $skins[$skin] = $info['name'];
danielebarchiesi@2:     }
danielebarchiesi@2:     asort($skins);
danielebarchiesi@2: 
danielebarchiesi@2:     // Create the drop down box so users can choose an available skin.
danielebarchiesi@2:     $form['slideshow_skin'] = array(
danielebarchiesi@2:       '#type' => 'select',
danielebarchiesi@2:       '#title' => t('Skin'),
danielebarchiesi@2:       '#options' => $skins,
danielebarchiesi@2:       '#default_value' => $this->options['slideshow_skin'],
danielebarchiesi@2:       '#description' => t('Select the skin to use for this display.  Skins allow for easily swappable layouts of things like next/prev links and thumbnails.  Note that not all skins support all widgets, so a combination of skins and widgets may lead to unpredictable results in layout.'),
danielebarchiesi@2:     );
danielebarchiesi@2: 
danielebarchiesi@2:     /**
danielebarchiesi@2:      * Slides
danielebarchiesi@2:      */
danielebarchiesi@2:     $form['slides_header'] = array(
danielebarchiesi@2:       '#markup' => '<h2>' . t('Slides') . '</h2>',
danielebarchiesi@2:     );
danielebarchiesi@2: 
danielebarchiesi@2:     // Get all slideshow types.
danielebarchiesi@2:     $slideshows = module_invoke_all('views_slideshow_slideshow_info');
danielebarchiesi@2: 
danielebarchiesi@2:     if ($slideshows) {
danielebarchiesi@2: 
danielebarchiesi@2:       // Build our slideshow options for the form.
danielebarchiesi@2:       $slideshow_options = array();
danielebarchiesi@2:       foreach ($slideshows as $slideshow_id => $slideshow_info) {
danielebarchiesi@2:         $slideshow_options[$slideshow_id] = $slideshow_info['name'];
danielebarchiesi@2:       }
danielebarchiesi@2: 
danielebarchiesi@2:       $form['slideshow_type'] = array(
danielebarchiesi@2:         '#type' => 'select',
danielebarchiesi@2:         '#title' => t('Slideshow Type'),
danielebarchiesi@2:         '#options' => $slideshow_options,
danielebarchiesi@2:         '#default_value' => $this->options['slideshow_type'],
danielebarchiesi@2:       );
danielebarchiesi@2: 
danielebarchiesi@2:       $arguments = array(
danielebarchiesi@2:         &$form,
danielebarchiesi@2:         &$form_state,
danielebarchiesi@2:         &$this,
danielebarchiesi@2:       );
danielebarchiesi@2: 
danielebarchiesi@2:       foreach (module_implements('views_slideshow_slideshow_type_form') as $module) {
danielebarchiesi@2:         $form[$module] = array(
danielebarchiesi@2:           '#type' => 'fieldset',
danielebarchiesi@2:           '#title' => t('!module options', array('!module' => $slideshows[$module]['name'])),
danielebarchiesi@2:           '#collapsible' => TRUE,
danielebarchiesi@2:           '#attributes' => array('class' => array($module)),
danielebarchiesi@2:           '#states' => array(
danielebarchiesi@2:             'visible' => array(
danielebarchiesi@2:               ':input[name="style_options[slideshow_type]"]' => array('value' => $module),
danielebarchiesi@2:             ),
danielebarchiesi@2:           ),
danielebarchiesi@2:         );
danielebarchiesi@2: 
danielebarchiesi@2:         $function = $module . '_views_slideshow_slideshow_type_form';
danielebarchiesi@2:         call_user_func_array($function, $arguments);
danielebarchiesi@2:       }
danielebarchiesi@2:     }
danielebarchiesi@2:     else {
danielebarchiesi@2:       $form['enable_module'] = array(
danielebarchiesi@2:         '#markup' => t('There is no Views Slideshow plugin enabled. Go to the !modules and enable a Views Slideshow plugin module. For example Views Slideshow Singleframe.', array('!modules' => l('Modules Page', 'admin/modules'))),
danielebarchiesi@2:       );
danielebarchiesi@2:     }
danielebarchiesi@2: 
danielebarchiesi@2:     /**
danielebarchiesi@2:      * Widgets
danielebarchiesi@2:      */
danielebarchiesi@2:     $form['widgets_header'] = array(
danielebarchiesi@2:       '#markup' => '<h2>' . t('Widgets') . '</h2>',
danielebarchiesi@2:     );
danielebarchiesi@2: 
danielebarchiesi@2:     // Loop through all locations so we can add header for each location.
danielebarchiesi@2:     $location = array('top' => t('Top'), 'bottom' => t('Bottom'));
danielebarchiesi@2:     foreach ($location as $location_id => $location_name) {
danielebarchiesi@2:       // Widget Header
danielebarchiesi@2:       $form['widgets'][$location_id]['header'] = array(
danielebarchiesi@2:         '#markup' => '<h3>' . t('!location Widgets', array('!location' => $location_name)) . '</h3>',
danielebarchiesi@2:       );
danielebarchiesi@2:     }
danielebarchiesi@2: 
danielebarchiesi@2:     // Get all widgets that are registered.
danielebarchiesi@2:     // If we have widgets then build it's form fields.
danielebarchiesi@2:     $widgets = module_invoke_all('views_slideshow_widget_info');
danielebarchiesi@2:     if (!empty($widgets)) {
danielebarchiesi@2: 
danielebarchiesi@2:       // Build our weight values by number of widgets
danielebarchiesi@2:       $weights = array();
danielebarchiesi@2:       for ($i = 1; $i <= count($widgets); $i++) {
danielebarchiesi@2:         $weights[$i] = $i;
danielebarchiesi@2:       }
danielebarchiesi@2: 
danielebarchiesi@2:       // Loop through our widgets and locations to build our form values for
danielebarchiesi@2:       // each widget.
danielebarchiesi@2:       foreach ($widgets as $widget_id => $widget_info) {
danielebarchiesi@2:         foreach ($location as $location_id => $location_name) {
danielebarchiesi@2:           $widget_dependency = 'style_options[widgets][' . $location_id . '][' . $widget_id . ']';
danielebarchiesi@2: 
danielebarchiesi@2:           // Determine if a widget is compatible with a slideshow.
danielebarchiesi@2:           $compatible_slideshows = array();
danielebarchiesi@2:           foreach ($slideshows as $slideshow_id => $slideshow_info) {
danielebarchiesi@2:             $is_compatible = 1;
danielebarchiesi@2:             // Check if every required accept value in the widget has a
danielebarchiesi@2:             // corresponding calls value in the slideshow.
danielebarchiesi@2:             foreach($widget_info['accepts'] as $accept_key => $accept_value) {
danielebarchiesi@2:               if (is_array($accept_value) && !empty($accept_value['required']) && !in_array($accept_key, $slideshow_info['calls'])) {
danielebarchiesi@2:                 $is_compatible = 0;
danielebarchiesi@2:                 break;
danielebarchiesi@2:               }
danielebarchiesi@2:             }
danielebarchiesi@2: 
danielebarchiesi@2:             // No need to go through this if it's not compatible.
danielebarchiesi@2:             if ($is_compatible) {
danielebarchiesi@2:               // Check if every required calls value in the widget has a
danielebarchiesi@2:               // corresponding accepts call.
danielebarchiesi@2:               foreach($widget_info['calls'] as $calls_key => $calls_value) {
danielebarchiesi@2:                 if (is_array($calls_value) && !empty($calls_value['required']) && !in_array($calls_key, $slideshow_info['accepts'])) {
danielebarchiesi@2:                   $is_compatible = 0;
danielebarchiesi@2:                   break;
danielebarchiesi@2:                 }
danielebarchiesi@2:               }
danielebarchiesi@2:             }
danielebarchiesi@2: 
danielebarchiesi@2:             // If it passed all those tests then they are compatible.
danielebarchiesi@2:             if ($is_compatible) {
danielebarchiesi@2:               $compatible_slideshows[] = $slideshow_id;
danielebarchiesi@2:             }
danielebarchiesi@2:           }
danielebarchiesi@2: 
danielebarchiesi@2:           // Use Widget Checkbox
danielebarchiesi@2:           $form['widgets'][$location_id][$widget_id]['enable'] = array(
danielebarchiesi@2:             '#type' => 'checkbox',
danielebarchiesi@2:             '#title' => t($widget_info['name']),
danielebarchiesi@2:             '#default_value' => $this->options['widgets'][$location_id][$widget_id]['enable'],
danielebarchiesi@2:             '#description' => t('Should !name be rendered at the !location of the slides.', array('!name' => $widget_info['name'], '!location' => $location_name)),
danielebarchiesi@2:           );
danielebarchiesi@2: 
danielebarchiesi@2:           $form['widgets'][$location_id][$widget_id]['enable']['#dependency']['edit-style-options-slideshow-type'] = !empty($compatible_slideshows) ? $compatible_slideshows : array('none');
danielebarchiesi@2: 
danielebarchiesi@2:           // Need to wrap this so it indents correctly.
danielebarchiesi@2:           $form['widgets'][$location_id][$widget_id]['wrapper'] = array(
danielebarchiesi@2:             '#markup' => '<div class="vs-dependent">',
danielebarchiesi@2:           );
danielebarchiesi@2: 
danielebarchiesi@2:           // Widget weight
danielebarchiesi@2:           // We check to see if the default value is greater than the number of
danielebarchiesi@2:           // widgets just in case a widget has been removed and the form hasn't
danielebarchiesi@2:           // hasn't been saved again.
danielebarchiesi@2:           $form['widgets'][$location_id][$widget_id]['weight'] = array(
danielebarchiesi@2:             '#type' => 'select',
danielebarchiesi@2:             '#title' => t('Weight of the !name', array('!name' => $widget_info['name'])),
danielebarchiesi@2:             '#default_value' => ($this->options['widgets'][$location_id][$widget_id]['weight'] > count($widgets)) ? count($widgets) : $this->options['widgets'][$location_id][$widget_id]['weight'],
danielebarchiesi@2:             '#options' => $weights,
danielebarchiesi@2:             '#description' => t('Determines in what order the !name appears.  A lower weight will cause the !name to be above higher weight items.', array('!name' => $widget_info['name'])),
danielebarchiesi@2:             '#prefix' => '<div class="vs-dependent">',
danielebarchiesi@2:             '#suffix' => '</div>',
danielebarchiesi@2:             '#states' => array(
danielebarchiesi@2:               'visible' => array(
danielebarchiesi@2:                 ':input[name="style_options[widgets][' . $location_id . '][' . $widget_id . '][enable]"]' => array('checked' => TRUE),
danielebarchiesi@2:               ),
danielebarchiesi@2:             ),
danielebarchiesi@2:           );
danielebarchiesi@2: 
danielebarchiesi@2:           // Add all the widget settings.
danielebarchiesi@2:           if (function_exists($widget_id . '_views_slideshow_widget_form_options')) {
danielebarchiesi@2:             $arguments = array(
danielebarchiesi@2:               &$form['widgets'][$location_id][$widget_id],
danielebarchiesi@2:               &$form_state,
danielebarchiesi@2:               &$this,
danielebarchiesi@2:               $this->options['widgets'][$location_id][$widget_id],
danielebarchiesi@2:               $widget_dependency,
danielebarchiesi@2:             );
danielebarchiesi@2:             call_user_func_array($widget_id . '_views_slideshow_widget_form_options', $arguments);
danielebarchiesi@2:           }
danielebarchiesi@2: 
danielebarchiesi@2:           $form['widgets'][$location_id][$widget_id]['wrapper_close'] = array(
danielebarchiesi@2:             '#markup' => '</div>',
danielebarchiesi@2:           );
danielebarchiesi@2:         }
danielebarchiesi@2:       }
danielebarchiesi@2:     }
danielebarchiesi@2: 
danielebarchiesi@2:     $form['views_slideshow_wrapper_close'] = array(
danielebarchiesi@2:       '#markup' => '</div>',
danielebarchiesi@2:     );
danielebarchiesi@2:   }
danielebarchiesi@2: 
danielebarchiesi@2:   // Run any validation on the form settings.
danielebarchiesi@2:   function options_validate(&$form, &$form_state) {
danielebarchiesi@2:     module_load_all_includes('views_slideshow.inc');
danielebarchiesi@2: 
danielebarchiesi@2:     $arguments = array(
danielebarchiesi@2:       &$form,
danielebarchiesi@2:       &$form_state,
danielebarchiesi@2:       &$this,
danielebarchiesi@2:     );
danielebarchiesi@2: 
danielebarchiesi@2:     // Call all modules that use hook_views_slideshow_options_form_validate
danielebarchiesi@2:     foreach (module_implements('views_slideshow_options_form_validate') as $module) {
danielebarchiesi@2:       $function = $module . '_views_slideshow_options_form_validate';
danielebarchiesi@2:       call_user_func_array($function, $arguments);
danielebarchiesi@2:     }
danielebarchiesi@2:   }
danielebarchiesi@2: 
danielebarchiesi@2:   // Run any necessary actions on submit.
danielebarchiesi@2:   function options_submit(&$form, &$form_state) {
danielebarchiesi@2:     module_load_all_includes('views_slideshow.inc');
danielebarchiesi@2: 
danielebarchiesi@2:     $arguments = array(
danielebarchiesi@2:       $form,
danielebarchiesi@2:       &$form_state,
danielebarchiesi@2:     );
danielebarchiesi@2: 
danielebarchiesi@2:     // Call all modules that use hook_views_slideshow_options_form_submit
danielebarchiesi@2:     foreach (module_implements('views_slideshow_options_form_submit') as $module) {
danielebarchiesi@2:       $function = $module . '_views_slideshow_options_form_submit';
danielebarchiesi@2:       call_user_func_array($function, $arguments);
danielebarchiesi@2:     }
danielebarchiesi@2: 
danielebarchiesi@2:     // In addition to the skin, we also pre-save the definition that
danielebarchiesi@2:     // correspond to it.  That lets us avoid a hook lookup on every page.
danielebarchiesi@2:     $skins = $this->views_slideshow_get_skins();
danielebarchiesi@2:     $form_state['values']['style_options']['skin_info'] = $skins[$form_state['values']['style_options']['slideshow_skin']];
danielebarchiesi@2:   }
danielebarchiesi@2: 
danielebarchiesi@2:   /**
danielebarchiesi@2:    * Retrieve a list of all available skins in the system.
danielebarchiesi@2:    */
danielebarchiesi@2:   function views_slideshow_get_skins() {
danielebarchiesi@2:     static $skins;
danielebarchiesi@2: 
danielebarchiesi@2:     if (empty($skins)) {
danielebarchiesi@2:       $skins = array();
danielebarchiesi@2: 
danielebarchiesi@2:       // Call all modules that use hook_views_slideshow_skin_info
danielebarchiesi@2:       foreach (module_implements('views_slideshow_skin_info') as $module) {
danielebarchiesi@2:         $skin_items = call_user_func($module . '_views_slideshow_skin_info');
danielebarchiesi@2:         if (isset($skin_items) && is_array($skin_items)) {
danielebarchiesi@2:           foreach (array_keys($skin_items) as $skin) {
danielebarchiesi@2:             // Ensure that the definition is complete, so we don't need lots
danielebarchiesi@2:             // of error checking later.
danielebarchiesi@2:             $skin_items[$skin] += array(
danielebarchiesi@2:               'class' => 'default',
danielebarchiesi@2:               'name' => t('Untitled skin'),
danielebarchiesi@2:               'module' => $module,
danielebarchiesi@2:               'path' => '',
danielebarchiesi@2:               'stylesheets' => array(),
danielebarchiesi@2:             );
danielebarchiesi@2:           }
danielebarchiesi@2:           $skins = array_merge($skins, $skin_items);
danielebarchiesi@2:         }
danielebarchiesi@2:       }
danielebarchiesi@2:     }
danielebarchiesi@2: 
danielebarchiesi@2:     return $skins;
danielebarchiesi@2:   }
danielebarchiesi@2: }