/drupal7/sites/all/modules/views_slideshow/views_slideshow.api.php - Annoter - Club Drupal - Forge Centrale Marseille

root / drupal7 / sites / all / modules / views_slideshow / views_slideshow.api.php @ 31a5a6d6

-ad3d82
+<?php
 /**
  * @file
  * Hooks provided by Views Slideshow.
  */
 /**
-            c73bc8d8
+ * @defgroup vss_hooks Hooks
-ad3d82
+ * @{
-            c73bc8d8
+ * Hooks for modules to implement to extend or modify Views Slideshow.
+ *
  * Allows modules to create actual slideshow implementations or add
  * widgets such as pagers.
+ *
  * @see contrib\views_slideshow_simple_pager\views_slideshow_simple_pager.module
  * @see https://api.drupal.org/api/drupal/includes%21module.inc/group/hooks/7.x
-ad3d82
+ */
 /**
  * Define the type of the slideshow (eg.: cycle, imageflow, ddblock).
+ *
-            a2bb1a14
+ * @return array
  *   Associative array of slideshow type and its information.
-ad3d82
+ */
 function hook_views_slideshow_slideshow_info() {
   $options = array(
     'views_slideshow_cycle' => array(
       'name' => t('Cycle'),
       'accepts' => array(
         'goToSlide',
         'nextSlide',
         'pause',
         'play',
         'previousSlide',
       ),
       'calls' => array(
         'transitionBegin',
         'transitionEnd',
         'goToSlide',
         'pause',
         'play',
         'nextSlide',
         'previousSlide',
       ),
     ),
   );
   return $options;
+}
 /**
  * Define form fields to be displayed in the views settings form.
-            a2bb1a14
+            Assos Assos
-ad3d82
+ * These fields would help configure your slideshow type.
  */
 function hook_views_slideshow_slideshow_type_form(&$form, &$form_state, &$view) {
   $form['views_slideshow_cycle']['effect'] = array(
     '#type' => 'select',
     '#title' => t('Effect'),
     '#options' => $effects,
     '#default_value' => $view->options['views_slideshow_cycle']['effect'],
-            a2bb1a14
+    '#description' => t('The transition effect that will be used to change between images. Not all options below may be relevant depending on the effect. !link', array('!link' => l(t('Follow this link to see examples of each effect.'), 'http://jquery.malsup.com/cycle/browser.html', array('attributes' => array('target' => '_blank'))))),
-ad3d82
+  );
+}
 /**
-            a2bb1a14
+ * Set default values for options specified in hook_views_slideshow_type_form.
-ad3d82
+            Assos Assos
-            a2bb1a14
+ * @return array
  *   Associative array of slideshow type name and options.
-ad3d82
+ */
 function hook_views_slideshow_option_definition() {
   $options['views_slideshow_cycle'] = array(
     'contains' => array(
-            a2bb1a14
+      // Transition.
-ad3d82
+      'effect' => array('default' => 'fade'),
       'transition_advanced' => array('default' => 0),
       'timeout' => array('default' => 5000),
-            a2bb1a14
+      'speed' => array('default' => 700),
-ad3d82
+      'delay' => array('default' => 0),
       'sync' => array('default' => 1),
       'random' => array('default' => 0),
-            a2bb1a14
+    ),
-ad3d82
+  );
   return $options;
+}
 /**
  * Form validation callback for the slideshow settings.
  */
 function hook_views_slideshow_options_form_validate(&$form, &$form_state, &$view) {
   if (!is_numeric($form_state['values']['style_options']['views_slideshow_cycle']['speed'])) {
-ece262b
+    form_error($form['views_slideshow_cycle']['speed'], t('!setting must be numeric!', array('!setting' => 'Speed')));
-ad3d82
+            Assos Assos
   if (!is_numeric($form_state['values']['style_options']['views_slideshow_cycle']['timeout'])) {
-ece262b
+    form_error($form['views_slideshow_cycle']['timeout'], t('!setting must be numeric!', array('!setting' => 'Timeout')));
-ad3d82
+            Assos Assos
   if (!is_numeric($form_state['values']['style_options']['views_slideshow_cycle']['remember_slide_days'])) {
-ece262b
+    form_error($form['views_slideshow_cycle']['remember_slide_days'], t('!setting must be numeric!', array('!setting' => 'Slide days')));
-ad3d82
+            Assos Assos
+}
 /**
  * Form submission callback for the slideshow settings.
  */
 function hook_views_slideshow_options_form_submit($form, &$form_state) {
   // Act on option submission.
+}
 /**
  * Define slideshow skins to be available to the end user.
  */
 function hook_views_slideshow_skin_info() {
   return array(
     'default' => array(
       'name' => t('Default'),
     ),
   );
+}
 /**
  * Define new widgets (pagers, controls, counters).
+ *
  * Available events for accepts and calls
  *  - pause
  *  - play
  *  - nextSlide
  *  - previousSlide
  *  - goToSlide
  *  - transitionBegin
-            a2bb1a14
+ *  - transitionEnd.
-ad3d82
+            Assos Assos
-            a2bb1a14
+ * @return array
  *   Array keyed by the widget names.
-ad3d82
+ */
 function hook_views_slideshow_widget_info() {
   return array(
     'views_slideshow_pager' => array(
       'name' => t('Pager'),
       'accepts' => array(
         'transitionBegin' => array('required' => TRUE),
-            a2bb1a14
+        'goToSlide' => array(),
         'previousSlide' => array(),
         'nextSlide' => array(),
-ad3d82
+      ),
       'calls' => array(
         'goToSlide',
         'pause',
         'play',
       ),
     ),
     'views_slideshow_controls' => array(
       'name' => t('Controls'),
       'accepts' => array(
         'pause' => array('required' => TRUE),
         'play' => array('required' => TRUE),
       ),
       'calls' => array(
         'nextSlide',
         'pause',
         'play',
         'previousSlide',
       ),
     ),
     'views_slideshow_slide_counter' => array(
       'name' => t('Slide Counter'),
       'accepts' => array(
         'transitionBegin' => array('required' => TRUE),
-            a2bb1a14
+        'goToSlide' => array(),
         'previousSlide' => array(),
         'nextSlide' => array(),
-ad3d82
+      ),
       'calls' => array(),
     ),
   );
+}
 /**
-            a2bb1a14
+ * Form fields to be added for a specific widget type.
+ *
  * Example of a widget type would be views_slideshow_pager
  * or views_slideshow_slide_counter.
-ad3d82
+ */
 function INSERT_WIDGET_TYPE_HERE_views_slideshow_widget_form_options(&$form, $form_state, $view, $defaults, $dependency) {
+}
 /**
  * Hook called by the pager widget to configure it, the fields that should be shown.
  */
 function hook_views_slideshow_widget_pager_info($view) {
+}
 /**
  * Hook called by the pager widget to add form items.
  */
 function INSERT_WIDGET_TYPE_HERE_views_slideshow_widget_pager_form_options(&$form, &$form_state, &$view, $defaults, $dependency) {
+}
 /**
  * Hook called by the controls widget to configure it, the fields that should be shown.
  */
 function hook_views_slideshow_widget_controls_info($view) {
+}
 /**
  * Hook called by the controls widget to add form items.
  */
 function INSERT_WIDGET_TYPE_HERE_views_slideshow_widget_controls_form_options(&$form, &$form_state, &$view, $defaults, $dependency) {
+}
 /**
-            c73bc8d8
+ * @} End of "defgroup vss_hooks".
-ad3d82
+ */

Projet

Général

Profil

Club Drupal

root / drupal7 / sites / all / modules / views_slideshow / views_slideshow.api.php @ 31a5a6d6