| [ Index ] |
PHP Cross Reference of Drupal 6 (gatewave) |
[Source view] [Print] [Project Stats]
(no description)
| File Size: | 772 lines (23 kb) |
| Included or required: | 0 times |
| Referenced: | 0 times |
| Includes or requires: | 0 files |
| ctools_api_version($minimum, $maximum = NULL) X-Ref |
| Test the CTools API version. This function can always be used to safely test if CTools has the minimum API version that your module can use. It can also try to protect you from running if the CTools API version is too new, but if you do that you need to be very quick about watching CTools API releases and release new versions of your software as soon as the new release is made, or people might end up updating CTools and having your module shut down without any recourse. It is recommended that every hook of your module that might use CTools or might lead to a use of CTools be guarded like this: param: $minimum param: $maximum |
| ctools_include($file, $module = 'ctools', $dir = 'includes') X-Ref |
| Include .inc files as necessary. This fuction is helpful for including .inc files for your module. The general case is including ctools funcitonality like this: param: $file param: $module param: $dir |
| ctools_image_path($image, $module = 'ctools', $dir = 'images') X-Ref |
| Provide the proper path to an image as necessary. This helper function is used by ctools but can also be used in other modules in the same way as explained in the comments of ctools_include. param: $image param: $module param: $dir |
| ctools_add_css($file, $module = 'ctools', $dir = 'css') X-Ref |
| Include css files as necessary. This helper function is used by ctools but can also be used in other modules in the same way as explained in the comments of ctools_include. param: $file param: $module param: $dir |
| ctools_add_js($file, $module = 'ctools', $dir = 'js') X-Ref |
| Include js files as necessary. This helper function is used by ctools but can also be used in other modules in the same way as explained in the comments of ctools_include. param: $file param: $module param: $dir |
| ctools_static($name, $default_value = NULL, $reset = FALSE) X-Ref |
| Central static variable storage. Modeled after Drupal 7's drupal_static(). param: $name param: $default_value param: $reset |
| ctools_static_reset($name) X-Ref |
| Reset one or all centrally stored static variable(s). Modeled after Drupal 7's drupal_static_reset(). param: $name |
| ctools_get_roles() X-Ref |
| Get a list of roles in the system. return: |
| ctools_break_phrase($str) X-Ref |
| No description |
| ctools_set_page_token($token = NULL, $type = NULL, $argument = NULL) X-Ref |
| Set a token/value pair to be replaced later in the request, specifically in ctools_preprocess_page(). param: $token param: $type param: $argument return: |
| ctools_set_variable_token($token) X-Ref |
| Easily set a token from the page variables. This function can be used like this: $token = ctools_set_variable_token('tabs'); $token will then be a simple replacement for the 'tabs' about of the variables available in the page template. |
| ctools_set_callback_token($token, $callback) X-Ref |
| Easily set a token from the page variables. This function can be used like this: $token = ctools_set_variable_token('id', 'mymodule_myfunction'); |
| ctools_init() X-Ref |
| Implement hook_init to keep our global CSS at the ready. |
| ctools_shutdown_handler() X-Ref |
| Shutdown handler used during ajax operations to help catch fatal errors. |
| ctools_theme() X-Ref |
| Implementation of hook_theme(). |
| ctools_menu() X-Ref |
| Implementation of hook_menu(). |
| ctools_cron() X-Ref |
| Implementation of hook_cron. Clean up old caches. |
| ctools_flush_caches() X-Ref |
| Ensure the CTools CSS cache is flushed whenever hook_flush_caches is invoked. |
| ctools_forms() X-Ref |
| Provide a search form with a different id so that form_alters will miss it and thus not get advanced search settings. |
| ctools_file_download($filepath) X-Ref |
| Implementation of hook_file_download() When using the private file system, we have to let Drupal know it's ok to download CSS and image files from our temporary directory. |
| ctools_ctools_plugin_directory($owner, $plugin_type) X-Ref |
| Implementation of hook_ctools_plugin_directory() to let the system know where all our own plugins are. |
| ctools_js_replacements() X-Ref |
| Implementation of hook_js_replacements(). This is a hook that is not a standard yet. We hope jquery_update and others will expose this hook to inform modules which scripts they are modifying in the theme layer. The return format is $scripts[$type][$old_path] = $new_path. |
| ctools_ctools_plugin_access() X-Ref |
| Inform CTools that the layout plugin can be loaded from themes. |
| ctools_garland_preprocess_page(&$vars) X-Ref |
| Override or insert PHPTemplate variables into the templates. This needs to be in the .module file to ensure availability; we can't change the paths or it won't be able to find templates. |
| ctools_preprocess_node(&$vars) X-Ref |
| A theme preprocess function to automatically allow panels-based node templates based upon input when the panel was configured. |
| ctools_preprocess_page(&$variables) X-Ref |
| A theme preprocess function to allow content type plugins to use page template variables which are not yet available when the content type is rendered. |
| ctools_access_menu($access) X-Ref |
| Determine if the current user has access via a plugin. This function is meant to be embedded in the Drupal menu system, and therefore is in the .module file since sub files can't be loaded, and takes arguments a little bit more haphazardly than ctools_access(). param: $access param: ... return: |
| ctools_access_multiperm() X-Ref |
| Determine if the current user has access via checks to multiple different permissions. This function is a thin wrapper around user_access that allows multiple permissions to be easily designated for use on, for example, a menu callback. param: ... return: |
| ctools_js_load($js) X-Ref |
| Check to see if the incoming menu item is js capable or not. This can be used as %ctools_js as part of a path in hook menu. CTools ajax functions will automatically change the phrase 'nojs' to 'ajax' when it attaches ajax to a link. This can be used to autodetect if that happened. |
| ctools_export_ui_load($item_name, $plugin_name) X-Ref |
| Menu _load hook. This function will be called to load an object as a replacement for %ctools_export_ui in menu paths. |
| ctools_export_ui_task_access($plugin_name, $op, $item = NULL) X-Ref |
| Menu access callback for various tasks of export-ui. |
| ctools_export_ui_context_cache_get($plugin_name, $key) X-Ref |
| Cache callback on behalf of ctools_export_ui. |
| ctools_export_ui_context_cache_set($plugin_name, $key, $item) X-Ref |
| Cache callback on behalf of ctools_export_ui. |
| ctools_export_ui_ctools_access_get($argument) X-Ref |
| Callback for access control ajax form on behalf of export ui. Returns the cached access config and contexts used. Note that this is assuming that access will be in $item->access -- if it is not, an export UI plugin will have to make its own callbacks. |
| ctools_export_ui_ctools_access_set($argument, $access) X-Ref |
| Callback for access control ajax form on behalf of export ui Returns the cached access config and contexts used. Note that this is assuming that access will be in $item->access -- if it is not, an export UI plugin will have to make its own callbacks. |
| Generated: Thu Mar 24 11:18:33 2011 | Cross-referenced by PHPXref 0.7 |