/drupal7/sites/all/modules/ctools/ctools.api.php - Diff - Club Drupal - Forge Centrale Marseille

Révision 7e72b748

Ajouté par Assos Assos il y a plus de 6 ans

ID 7e72b748e3fb6f8b6193ea4550b5885928aeef20
Parent 5024cef7
Enfant 082b75eb

Weekly update of contrib modules

      * Inform CTools about plugin types.
+     *
      * @return array
      *  An array of plugin types, keyed by the type name.
      *  See the advanced help topic 'plugins-creating' for details of the array
      *  properties.
      *   An array of plugin types, keyed by the type name.
      *   See the advanced help topic 'plugins-creating' for details of the array
      *   properties.
      */
     function hook_ctools_plugin_type() {
       $plugins['my_type'] = array(
-...
      *   directory location is being requested.
      * @param string $plugin_type
      *   The name of the plugin type for which a base directory is being requested.
+     *
      * @return string
      *   The path where CTools' plugin system should search for plugin files,
      *   relative to your module's root. Omit leading and trailing slashes.
-...
         // Yes, this is exactly like Form 2 - just a different reasoning for it.
         return "plugins/$plugin_type";
+      }
       // Finally, if nothing matches, it's safe to return nothing at all (or NULL).
       // Finally, if nothing matches, it's safe to return nothing at all (== NULL).
+    }
     /**
-...
      * allow to use it in the math expression api.
+     *
      * @param $functions
      *    An array which has the functions as value.
      *   An array which has the functions as value.
      */
     function hook_ctools_math_expression_functions_alter(&$functions) {
       // Allow to convert from degrees to radiant.
-...
      */
     function hook_ctools_content_subtype_alter($subtype, $plugin) {
       // Force a particular subtype of a particular plugin to render last.
       if ($plugin['module'] == 'some_plugin_module' && $plugin['name'] == 'some_plugin_name' && $subtype['subtype_id'] == 'my_subtype_id') {
       if ($plugin['module'] === 'some_plugin_module'
         && $plugin['name'] === 'some_plugin_name'
         && $subtype['subtype_id'] === 'my_subtype_id'
       ) {
         $subtype['render last'] = TRUE;
+      }
+    }
-...
+      }
+    }
     /**
      * Alter the conversion of context items by ctools context plugin convert()s.
+     *
      * @param ctools_context $context
      *   The current context plugin object. If this implemented a 'convert'
      *   function, the value passed in has been processed by that function.
      * @param string $converter
      *   A string associated with the plugin type, identifying the operation.
      * @param string $value
      *   The value being converted; this is the only return from the function.
      * @param $converter_options
      *   Array of key-value pairs to pass to a converter function from higher
      *   levels.
+     *
      * @see ctools_context_convert_context()
      */
     function hook_ctools_context_converter_alter($context, $converter, &$value, $converter_options) {
       if ($converter === 'mystring') {
         $value = 'fixed';
+      }
+    }
     /**
      * Alter the definition of entity context plugins.
+     *
-...
       $settings['lower case'] = TRUE;
+    }
     /**
      * Let other modules modify the context handler before it is rendered.
+     *
      * @param object $handler
      *   A handler for a current task and subtask.
      * @param array $contexts
      *   An associative array of contexts.
      * @param array $args
      *   An array for current args.
+     *
      * @see ctools_context_handler_pre_render()
      */
     function ctools_context_handler_pre_render($handler, $contexts, $args) {
       $handler->conf['css_id'] = 'my-id';
+    }
     /**
      * @} End of "addtogroup hooks".
      */

Formats disponibles : Unified diff

Projet

Général

Profil

Club Drupal

Révision 7e72b748

Ajouté par Assos Assos il y a plus de 6 ans