diff --git a/core/includes/common.inc b/core/includes/common.inc index 67a4457..68f47ed 100644 --- a/core/includes/common.inc +++ b/core/includes/common.inc @@ -541,10 +541,10 @@ function drupal_get_destination() { * * @return * An associative array containing the keys: - * - 'path': The path of the URL. If the given $url is external, this includes + * - path: The path of the URL. If the given $url is external, this includes * the scheme and host. - * - 'query': An array of query parameters of $url, if existent. - * - 'fragment': The fragment of $url, if existent. + * - query: An array of query parameters of $url, if existent. + * - fragment: The fragment of $url, if existent. * * @see url() * @see drupal_goto() @@ -1638,9 +1638,9 @@ function format_rss_item($title, $link, $description, $args = array()) { * An array where each item represents an element and is either a: * - (key => value) pair (value) * - Associative array with fields: - * - 'key': element name - * - 'value': element contents - * - 'attributes': associative array of element attributes + * - key: element name + * - value: element contents + * - attributes: associative array of element attributes * * In both cases, 'value' can be a simple string, or it can be another array * with the same format as $array itself for nesting. @@ -2024,29 +2024,29 @@ function _format_date_callback(array $matches = NULL, $new_langcode = NULL) { * URL encode them. * @param $options * An associative array of additional options, with the following elements: - * - 'query': An array of query key/value-pairs (without any URL-encoding) to + * - query: An array of query key/value-pairs (without any URL-encoding) to * append to the URL. - * - 'fragment': A fragment identifier (named anchor) to append to the URL. + * - fragment: A fragment identifier (named anchor) to append to the URL. * Do not include the leading '#' character. - * - 'absolute': Defaults to FALSE. Whether to force the output to be an + * - absolute: Defaults to FALSE. Whether to force the output to be an * absolute link (beginning with http:). Useful for links that will be * displayed outside the site, such as in an RSS feed. - * - 'alias': Defaults to FALSE. Whether the given path is a URL alias + * - alias: Defaults to FALSE. Whether the given path is a URL alias * already. - * - 'external': Whether the given path is an external URL. - * - 'language': An optional language object. If the path being linked to is + * - external: Whether the given path is an external URL. + * - language: An optional language object. If the path being linked to is * internal to the site, $options['language'] is used to look up the alias * for the URL. If $options['language'] is omitted, the global $language_url * will be used. - * - 'https': Whether this URL should point to a secure location. If not + * - https: Whether this URL should point to a secure location. If not * defined, the current scheme is used, so the user stays on http or https * respectively. TRUE enforces HTTPS and FALSE enforces HTTP, but HTTPS can * only be enforced when the variable 'https' is set to TRUE. - * - 'base_url': Only used internally, to modify the base URL when a language + * - base_url: Only used internally, to modify the base URL when a language * dependent URL requires so. - * - 'prefix': Only used internally, to modify the path when a language + * - prefix: Only used internally, to modify the path when a language * dependent URL requires so. - * - 'script': The script filename in Drupal's root directory to use when + * - script: The script filename in Drupal's root directory to use when * clean URLs are disabled, such as 'index.php'. Defaults to an empty * string, as most modern web servers automatically find 'index.php'. If * clean URLs are disabled, the value of $path is appended as query @@ -2054,9 +2054,9 @@ function _format_date_callback(array $matches = NULL, $new_langcode = NULL) { * Drupal on a web server that cannot be configured to automatically find * index.php, then hook_url_outbound_alter() can be implemented to force * this value to 'index.php'. - * - 'entity_type': The entity type of the object that called url(). Only + * - entity_type: The entity type of the object that called url(). Only * set if url() is invoked by entity_uri(). - * - 'entity': The entity object (such as a node) for which the URL is being + * - entity: The entity object (such as a node) for which the URL is being * generated. Only set if url() is invoked by entity_uri(). * * @return @@ -2284,7 +2284,7 @@ function drupal_attributes(array $attributes = array()) { * well-formed HTML. See url() for more information and notes. * @param array $options * An associative array of additional options, with the following elements: - * - 'attributes': An associative array of HTML attributes to apply to the + * - attributes: An associative array of HTML attributes to apply to the * anchor tag. If element 'class' is included, it must be an array; 'title' * must be a string; other elements are more flexible, as they just need * to work in a call to drupal_attributes($options['attributes']). @@ -2293,7 +2293,7 @@ function drupal_attributes(array $attributes = array()) { * you will see the escaped HTML image tag. $text is not sanitized if * 'html' is TRUE. The calling function must ensure that $text is already * safe. - * - 'language': An optional language object. If the path being linked to is + * - language: An optional language object. If the path being linked to is * internal to the site, $options['language'] is used to determine whether * the link is "active", or pointing to the current page (the language as * well as the path must match). This element is also used by url(). @@ -2751,7 +2751,7 @@ function drupal_add_html_head_link($attributes, $header = FALSE) { * @param $data * (optional) The stylesheet data to be added, depending on what is passed * through to the $options['type'] parameter: - * - 'file': The path to the CSS file relative to the base_path(), or a + * - file: The path to the CSS file relative to the base_path(), or a * stream wrapper URI. For example: "modules/devel/devel.css" or * "public://generated_css/stylesheet_1.css". Note that Modules should * always prefix the names of their CSS files with the module name; for @@ -2766,25 +2766,25 @@ function drupal_add_html_head_link($attributes, $header = FALSE) { * 'mymodule-name-rtl.css' file added to the list, if exists in the same * directory. This CSS file should contain overrides for properties which * should be reversed or otherwise different in a right-to-left display. - * - 'inline': A string of CSS that should be placed in the given scope. Note + * - inline: A string of CSS that should be placed in the given scope. Note * that it is better practice to use 'file' stylesheets, rather than * 'inline', as the CSS would then be aggregated and cached. - * - 'external': The absolute path to an external CSS file that is not hosted + * - external: The absolute path to an external CSS file that is not hosted * on the local server. These files will not be aggregated if CSS * aggregation is enabled. * @param $options * (optional) A string defining the 'type' of CSS that is being added in the * $data parameter ('file', 'inline', or 'external'), or an array which can * have any or all of the following keys: - * - 'type': The type of stylesheet being added. Available options are 'file', + * - type: The type of stylesheet being added. Available options are 'file', * 'inline' or 'external'. Defaults to 'file'. - * - 'basename': Force a basename for the file being added. Modules are + * - basename: Force a basename for the file being added. Modules are * expected to use stylesheets with unique filenames, but integration of * external libraries may make this impossible. The basename of * 'core/modules/node/node.css' is 'node.css'. If the external library * "node.js" ships with a 'node.css', then a different, unique basename * would be 'node.js.css'. - * - 'group': A number identifying the group in which to add the stylesheet. + * - group: A number identifying the group in which to add the stylesheet. * Available constants are: * - CSS_SYSTEM: Any system-layer CSS. * - CSS_DEFAULT: Any module-layer CSS. @@ -2793,7 +2793,7 @@ function drupal_add_html_head_link($attributes, $header = FALSE) { * within a lower weight group is output to the page before the markup for * loading a stylesheet within a higher weight group, so CSS within higher * weight groups take precendence over CSS within lower weight groups. - * - 'every_page': For optimal front-end performance when aggregation is + * - every_page: For optimal front-end performance when aggregation is * enabled, this should be set to TRUE if the stylesheet is present on every * page of the website for users for whom it is present at all. This * defaults to FALSE. It is set to TRUE for stylesheets added via module and @@ -2814,7 +2814,7 @@ function drupal_add_html_head_link($attributes, $header = FALSE) { * be downloaded when first encountered, so it should be kept relatively * small by ensuring that most commonly needed stylesheets are added to * every page. - * - 'weight': The weight of the stylesheet specifies the order in which the + * - weight: The weight of the stylesheet specifies the order in which the * CSS will appear relative to other stylesheets with the same group and * 'every_page' flag. The exact ordering of stylesheets is as follows: * - First by group. @@ -2824,11 +2824,11 @@ function drupal_add_html_head_link($attributes, $header = FALSE) { * being the same, a stylesheet added by a call to drupal_add_css() that * happened later in the page request gets added to the page after one for * which drupal_add_css() happened earlier in the page request. - * - 'media': The media type for the stylesheet, e.g., all, print, screen. + * - media: The media type for the stylesheet, e.g., all, print, screen. * Defaults to 'all'. - * - 'preprocess': If TRUE and CSS aggregation/compression is enabled, the + * - preprocess: If TRUE and CSS aggregation/compression is enabled, the * styles will be aggregated and compressed. Defaults to TRUE. - * - 'browsers': An array containing information specifying which browsers + * - browsers: An array containing information specifying which browsers * should load the CSS item. See drupal_pre_render_conditional_comments() * for details. * @@ -3210,12 +3210,12 @@ function drupal_aggregate_css(&$css_groups) { * * @param $element * A render array containing: - * - '#items': The CSS items as returned by drupal_add_css() and altered by + * - #items: The CSS items as returned by drupal_add_css() and altered by * drupal_get_css(). - * - '#group_callback': A function to call to group #items to enable the use + * - #group_callback: A function to call to group #items to enable the use * of fewer tags by aggregating files and/or using multiple @import * statements within a single tag. - * - '#aggregate_callback': A function to call to aggregate the items within + * - #aggregate_callback: A function to call to aggregate the items within * the groups arranged by the #group_callback function. * * @return @@ -3876,12 +3876,12 @@ function drupal_region_class($region) { * * @param $data * (optional) If given, the value depends on the $options parameter: - * - 'file': Path to the file relative to base_path(). - * - 'inline': The JavaScript code that should be placed in the given scope. - * - 'external': The absolute path to an external JavaScript file that is not + * - file: Path to the file relative to base_path(). + * - inline: The JavaScript code that should be placed in the given scope. + * - external: The absolute path to an external JavaScript file that is not * hosted on the local server. These files will not be aggregated if * JavaScript aggregation is enabled. - * - 'setting': An associative array with configuration options. The array is + * - setting: An associative array with configuration options. The array is * merged directly into Drupal.settings. All modules should wrap their * actual configuration settings in another variable to prevent conflicts in * the Drupal.settings namespace. Items added with a string key will replace @@ -5299,9 +5299,9 @@ function drupal_cron_cleanup() { * @return array * An associative array of file objects, keyed on the chosen key. Each element * in the array is an object containing file information, with properties: - * - 'uri': Full URI of the file. - * - 'filename': File name. - * - 'name': Name of file without the extension. + * - uri: Full URI of the file. + * - filename: File name. + * - name: Name of file without the extension. */ function drupal_system_listing($mask, $directory, $key = 'name', $min_depth = 1) { $config = conf_path(); @@ -5720,7 +5720,7 @@ function drupal_render_page($page) { * drupal_render() can optionally cache the rendered output of elements to * improve performance. To use drupal_render() caching, set the element's #cache * property to an associative array with one or several of the following keys: - * - 'keys': An array of one or more keys that identify the element. If 'keys' + * - keys: An array of one or more keys that identify the element. If 'keys' * is set, the cache ID is created automatically from these keys. See * drupal_render_cid_create(). * - 'granularity' (optional): Define the cache granularity using binary @@ -5729,11 +5729,11 @@ function drupal_render_page($page) { * DRUPAL_CACHE_PER_PAGE | DRUPAL_CACHE_PER_ROLE to cache separately for each * page and role. If not specified the element is cached globally for each * theme and language. - * - 'cid': Specify the cache ID directly. Either 'keys' or 'cid' is required. + * - cid: Specify the cache ID directly. Either 'keys' or 'cid' is required. * If 'cid' is set, 'keys' and 'granularity' are ignored. Use only if you * have special requirements. - * - 'expire': Set to one of the cache lifetime constants. - * - 'bin': Specify a cache bin to cache the element in. Defaults to 'cache'. + * - expire: Set to one of the cache lifetime constants. + * - bin: Specify a cache bin to cache the element in. Defaults to 'cache'. * * This function is usually called from within another function, like * drupal_get_form() or a theme function. Elements are sorted internally diff --git a/core/includes/database/schema.inc b/core/includes/database/schema.inc index 27934dc..84e2260 100644 --- a/core/includes/database/schema.inc +++ b/core/includes/database/schema.inc @@ -26,20 +26,20 @@ require_once __DIR__ . '/query.inc'; * the module defines. * * The following keys are defined: - * - 'description': A string in non-markup plain text describing this table + * - description: A string in non-markup plain text describing this table * and its purpose. References to other tables should be enclosed in * curly-brackets. For example, the node_revisions table * description field might contain "Stores per-revision title and * body data for each {node}." - * - 'fields': An associative array ('fieldname' => specification) + * - fields: An associative array ('fieldname' => specification) * that describes the table's database columns. The specification * is also an array. The following specification parameters are defined: - * - 'description': A string in non-markup plain text describing this field + * - description: A string in non-markup plain text describing this field * and its purpose. References to other tables should be enclosed in * curly-brackets. For example, the node table vid field * description might contain "Always holds the largest (most * recent) {node_revision}.vid value for this nid." - * - 'type': The generic datatype: 'char', 'varchar', 'text', 'blob', 'int', + * - type: The generic datatype: 'char', 'varchar', 'text', 'blob', 'int', * 'float', 'numeric', or 'serial'. Most types just map to the according * database engine specific datatypes. Use 'serial' for auto incrementing * fields. This will expand to 'INT auto_increment' on MySQL. @@ -50,9 +50,9 @@ require_once __DIR__ . '/query.inc'; * but be advised that your schema will fail to load on backends that * do not have a type specified. A possible solution can be to * use the "text" type as a fallback. - * - 'serialize': A boolean indicating whether the field will be stored as + * - serialize: A boolean indicating whether the field will be stored as * a serialized string. - * - 'size': The data size: 'tiny', 'small', 'medium', 'normal', + * - size: The data size: 'tiny', 'small', 'medium', 'normal', * 'big'. This is a hint about the largest value the field will * store and determines which of the database engine specific * datatypes will be used (e.g. on MySQL, TINYINT vs. INT vs. BIGINT). @@ -60,16 +60,16 @@ require_once __DIR__ . '/query.inc'; * INT, VARCHAR, BLOB, etc.). * Not all sizes are available for all data types. See * DatabaseSchema::getFieldTypeMap() for possible combinations. - * - 'not null': If true, no NULL values will be allowed in this + * - not null: If true, no NULL values will be allowed in this * database column. Defaults to false. - * - 'default': The field's default value. The PHP type of the + * - default: The field's default value. The PHP type of the * value matters: '', '0', and 0 are all different. If you * specify '0' as the default value for a type 'int' field it * will not work because '0' is a string containing the * character "zero", not an integer. - * - 'length': The maximal length of a type 'char', 'varchar' or 'text' + * - length: The maximal length of a type 'char', 'varchar' or 'text' * field. Ignored for other field types. - * - 'unsigned': A boolean indicating whether a type 'int', 'float' + * - unsigned: A boolean indicating whether a type 'int', 'float' * and 'numeric' only is signed or unsigned. Defaults to * FALSE. Ignored for other field types. * - 'precision', 'scale': For type 'numeric' fields, indicates @@ -78,17 +78,17 @@ require_once __DIR__ . '/query.inc'; * mandatory. Ignored for other field types. * All parameters apart from 'type' are optional except that type * 'numeric' columns must specify 'precision' and 'scale'. - * - 'primary key': An array of one or more key column specifiers (see below) + * - primary key: An array of one or more key column specifiers (see below) * that form the primary key. - * - 'unique keys': An associative array of unique keys ('keyname' => + * - unique keys: An associative array of unique keys ('keyname' => * specification). Each specification is an array of one or more * key column specifiers (see below) that form a unique key on the table. - * - 'foreign keys': An associative array of relations ('my_relation' => + * - foreign keys: An associative array of relations ('my_relation' => * specification). Each specification is an array containing the name of * the referenced table ('table'), and an array of column mappings * ('columns'). Column mappings are defined by key pairs ('source_column' => * 'referenced_column'). - * - 'indexes': An associative array of indexes ('indexname' => + * - indexes: An associative array of indexes ('indexname' => * specification). Each specification is an array of one or more * key column specifiers (see below) that form an index on the * table. diff --git a/core/includes/file.inc b/core/includes/file.inc index 05bf6c1..121f8fd 100644 --- a/core/includes/file.inc +++ b/core/includes/file.inc @@ -2005,17 +2005,17 @@ function file_download() { * The preg_match() regular expression of the files to find. * @param $options * An associative array of additional options, with the following elements: - * - 'nomask': The preg_match() regular expression of the files to ignore. + * - nomask: The preg_match() regular expression of the files to ignore. * Defaults to '/(\.\.?|CVS)$/'. - * - 'callback': The callback function to call for each match. There is no + * - callback: The callback function to call for each match. There is no * default callback. - * - 'recurse': When TRUE, the directory scan will recurse the entire tree + * - recurse: When TRUE, the directory scan will recurse the entire tree * starting at the provided directory. Defaults to TRUE. - * - 'key': The key to be used for the returned associative array of files. + * - key: The key to be used for the returned associative array of files. * Possible values are 'uri', for the file's URI; 'filename', for the * basename of the file; and 'name' for the name of the file without the * extension. Defaults to 'uri'. - * - 'min_depth': Minimum depth of directories to return files from. Defaults + * - min_depth: Minimum depth of directories to return files from. Defaults * to 0. * @param $depth * Current depth of recursion. This parameter is only used internally and @@ -2099,8 +2099,8 @@ function file_upload_max_size() { * A string containing the URI, path, or filename. * @param $mapping * An optional map of extensions to their mimetypes, in the form: - * - 'mimetypes': a list of mimetypes, keyed by an identifier, - * - 'extensions': the mapping itself, an associative array in which + * - mimetypes: a list of mimetypes, keyed by an identifier, + * - extensions: the mapping itself, an associative array in which * the key is the extension (lowercase) and the value is the mimetype * identifier. If $mapping is NULL file_mimetype_mapping() is called. * diff --git a/core/includes/form.inc b/core/includes/form.inc index 5663ac6..bd288d6 100644 --- a/core/includes/form.inc +++ b/core/includes/form.inc @@ -4248,7 +4248,7 @@ function element_validate_number($element, &$form_state) { * An array defining the batch. The following keys can be used -- only * 'operations' is required, and batch_init() provides default values for * the messages. - * - 'operations': Array of function calls to be performed. + * - operations: Array of function calls to be performed. * Example: * @code * array( @@ -4256,25 +4256,25 @@ function element_validate_number($element, &$form_state) { * array('my_function_2', array($arg2_1, $arg2_2)), * ) * @endcode - * - 'title': Title for the progress page. Only safe strings should be passed. + * - title: Title for the progress page. Only safe strings should be passed. * Defaults to t('Processing'). - * - 'init_message': Message displayed while the processing is initialized. + * - init_message: Message displayed while the processing is initialized. * Defaults to t('Initializing.'). - * - 'progress_message': Message displayed while processing the batch. + * - progress_message: Message displayed while processing the batch. * Available placeholders are @current, @remaining, @total, @percentage, * @estimate and @elapsed. Defaults to t('Completed @current of @total.'). - * - 'error_message': Message displayed if an error occurred while processing + * - error_message: Message displayed if an error occurred while processing * the batch. Defaults to t('An error has occurred.'). - * - 'finished': Name of a function to be executed after the batch has + * - finished: Name of a function to be executed after the batch has * completed. This should be used to perform any result massaging that * may be needed, and possibly save data in $_SESSION for display after * final page redirection. - * - 'file': Path to the file containing the definitions of the + * - file: Path to the file containing the definitions of the * 'operations' and 'finished' functions, for instance if they don't * reside in the main .module file. The path should be relative to * base_path(), and thus should be built using drupal_get_path(). - * - 'css': Array of paths to CSS files to be used on the progress page. - * - 'url_options': options passed to url() when constructing redirect + * - css: Array of paths to CSS files to be used on the progress page. + * - url_options: options passed to url() when constructing redirect * URLs for the batch. * * Operations are added as new batch sets. Batch sets are used to ensure diff --git a/core/includes/graph.inc b/core/includes/graph.inc index 7fcc57a..e01b6f7 100644 --- a/core/includes/graph.inc +++ b/core/includes/graph.inc @@ -33,13 +33,13 @@ * * @return * The passed-in $graph with more secondary keys filled in: - * - 'paths': Contains a list of vertices than can be reached on a path from + * - paths: Contains a list of vertices than can be reached on a path from * this vertex. - * - 'reverse_paths': Contains a list of vertices that has a path from them + * - reverse_paths: Contains a list of vertices that has a path from them * to this vertex. - * - 'weight': If there is a path from a vertex to another then the weight of + * - weight: If there is a path from a vertex to another then the weight of * the latter is higher. - * - 'component': Vertices in the same component have the same component + * - component: Vertices in the same component have the same component * identifier. * * @see _drupal_depth_first_search() diff --git a/core/includes/image.inc b/core/includes/image.inc index f6ae7f1..1e899b1 100644 --- a/core/includes/image.inc +++ b/core/includes/image.inc @@ -115,11 +115,11 @@ function image_toolkit_invoke($method, stdClass $image, array $params = array()) * @return * FALSE, if the file could not be found or is not an image. Otherwise, a * keyed array containing information about the image: - * - "width": Width, in pixels. - * - "height": Height, in pixels. - * - "extension": Commonly used file extension for the image. - * - "mime_type": MIME type ('image/jpeg', 'image/gif', 'image/png'). - * - "file_size": File size in bytes. + * - width: Width, in pixels. + * - height: Height, in pixels. + * - extension: Commonly used file extension for the image. + * - mime_type: MIME type ('image/jpeg', 'image/gif', 'image/png'). + * - file_size: File size in bytes. */ function image_get_info($filepath, $toolkit = FALSE) { $details = FALSE; diff --git a/core/includes/stream_wrappers.inc b/core/includes/stream_wrappers.inc index 0edcee1..abc5e48 100644 --- a/core/includes/stream_wrappers.inc +++ b/core/includes/stream_wrappers.inc @@ -163,8 +163,8 @@ interface DrupalStreamWrapperInterface extends StreamWrapperInterface { * The URI, path, or filename. * @param $mapping * An optional map of extensions to their mimetypes, in the form: - * - 'mimetypes': a list of mimetypes, keyed by an identifier, - * - 'extensions': the mapping itself, an associative array in which + * - mimetypes: a list of mimetypes, keyed by an identifier, + * - extensions: the mapping itself, an associative array in which * the key is the extension and the value is the mimetype identifier. * * @return diff --git a/core/includes/tablesort.inc b/core/includes/tablesort.inc index 7873cdb..c5f30e0 100644 --- a/core/includes/tablesort.inc +++ b/core/includes/tablesort.inc @@ -96,8 +96,8 @@ class TableSort extends SelectQueryExtender { * An array of column headers in the format described in theme_table(). * @return * An associative array describing the criterion, containing the keys: - * - "name": The localized title of the table column. - * - "sql": The name of the database field to sort on. + * - name: The localized title of the table column. + * - sql: The name of the database field to sort on. */ protected function order() { return tablesort_get_order($this->header); @@ -200,8 +200,8 @@ function tablesort_get_query_parameters() { * An array of column headers in the format described in theme_table(). * @return * An associative array describing the criterion, containing the keys: - * - "name": The localized title of the table column. - * - "sql": The name of the database field to sort on. + * - name: The localized title of the table column. + * - sql: The name of the database field to sort on. */ function tablesort_get_order($headers) { $order = isset($_GET['order']) ? $_GET['order'] : ''; diff --git a/core/includes/theme.inc b/core/includes/theme.inc index 0c955e8..450f51a 100644 --- a/core/includes/theme.inc +++ b/core/includes/theme.inc @@ -455,26 +455,26 @@ class ThemeRegistry Extends DrupalCacheArray { * The theme registry that will eventually be cached; It is an associative * array keyed by theme hooks, whose values are associative arrays describing * the hook: - * - 'type': The passed-in $type. - * - 'theme path': The passed-in $path. - * - 'function': The name of the function generating output for this theme + * - type: The passed-in $type. + * - theme path: The passed-in $path. + * - function: The name of the function generating output for this theme * hook. Either defined explicitly in hook_theme() or, if neither 'function' * nor 'template' is defined, then the default theme function name is used. * The default theme function name is the theme hook prefixed by either * 'theme_' for modules or '$name_' for everything else. If 'function' is * defined, 'template' is not used. - * - 'template': The filename of the template generating output for this + * - template: The filename of the template generating output for this * theme hook. The template is in the directory defined by the 'path' key of * hook_theme() or defaults to $path. - * - 'variables': The variables for this theme hook as defined in + * - variables: The variables for this theme hook as defined in * hook_theme(). If there is more than one implementation and 'variables' is * not specified in a later one, then the previous definition is kept. - * - 'render element': The renderable element for this theme hook as defined + * - render element: The renderable element for this theme hook as defined * in hook_theme(). If there is more than one implementation and * 'render element' is not specified in a later one, then the previous * definition is kept. - * - 'preprocess functions': See theme() for detailed documentation. - * - 'process functions': See theme() for detailed documentation. + * - preprocess functions: See theme() for detailed documentation. + * - process functions: See theme() for detailed documentation. * @param $name * The name of the module, theme engine, base theme engine, theme or base * theme implementing hook_theme(). @@ -722,18 +722,18 @@ function _theme_build_registry($theme, $base_theme, $theme_engine) { * An associative array of the currently available themes. The keys are the * names of the themes and the values are objects having the following * properties: - * - 'filename': The name of the .info file. - * - 'name': The name of the theme. - * - 'status': 1 for enabled, 0 for disabled themes. - * - 'info': The contents of the .info file. - * - 'stylesheets': A two dimensional array, using the first key for the + * - filename: The name of the .info file. + * - name: The name of the theme. + * - status: 1 for enabled, 0 for disabled themes. + * - info: The contents of the .info file. + * - stylesheets: A two dimensional array, using the first key for the * 'media' attribute (e.g. 'all'), the second for the name of the file * (e.g. style.css). The value is a complete filepath * (e.g. themes/bartik/style.css). - * - 'scripts': An associative array of JavaScripts, using the filename as key + * - scripts: An associative array of JavaScripts, using the filename as key * and the complete filepath as value. - * - 'engine': The name of the theme engine. - * - 'base theme': The name of the base theme. + * - engine: The name of the theme engine. + * - base theme: The name of the base theme. */ function list_themes($refresh = FALSE) { $list = &drupal_static(__FUNCTION__, array()); @@ -1719,22 +1719,22 @@ function theme_breadcrumb($variables) { * - header: An array containing the table headers. Each element of the array * can be either a localized string or an associative array with the * following keys: - * - "data": The localized title of the table column. - * - "field": The database field represented in the table column (required + * - data: The localized title of the table column. + * - field: The database field represented in the table column (required * if user is to be able to sort on this column). - * - "sort": A default sort order for this column ("asc" or "desc"). + * - sort: A default sort order for this column ("asc" or "desc"). * - Any HTML attributes, such as "colspan", to apply to the column header * cell. * - rows: An array of table rows. Every row is an array of cells, or an * associative array with the following keys: - * - "data": an array of cells + * - data: an array of cells * - Any HTML attributes, such as "class", to apply to the table row. - * - "no_striping": a boolean indicating that the row should receive no + * - no_striping: a boolean indicating that the row should receive no * 'even / odd' styling. Defaults to FALSE. * Each cell can be either a string or an associative array with the * following keys: - * - "data": The string to display in the table cell. - * - "header": Indicates this cell is a header. + * - data: The string to display in the table cell. + * - header: Indicates this cell is a header. * - Any HTML attributes, such as "colspan", to apply to the table cell. * Here's an example for $rows: * @code diff --git a/core/includes/update.inc b/core/includes/update.inc index 613319a..c29e307 100644 --- a/core/includes/update.inc +++ b/core/includes/update.inc @@ -564,14 +564,14 @@ function update_get_update_list() { * algorithm, which encode detailed information about the dependency chain * for this update function (for example: 'paths', 'reverse_paths', 'weight', * and 'component'), as well as the following additional keys: - * - 'allowed': A boolean which is TRUE when the update function's + * - allowed: A boolean which is TRUE when the update function's * dependencies are met, and FALSE otherwise. Calling functions should * inspect this value before running the update. - * - 'missing_dependencies': An array containing the names of any other + * - missing_dependencies: An array containing the names of any other * update functions that are required by this one but that are unavailable * to be run. This array will be empty when 'allowed' is TRUE. - * - 'module': The name of the module that this update function belongs to. - * - 'number': The number of this update function within that module. + * - module: The name of the module that this update function belongs to. + * - number: The number of this update function within that module. * * @see drupal_depth_first_search() */ @@ -682,11 +682,11 @@ function update_get_update_function_list($starting_updates) { * of an update function, including all update functions from the provided * list as well as any outside update functions which they directly depend * on. Each value is an associative array containing the following keys: - * - 'edges': A representation of any other update functions that immediately + * - edges: A representation of any other update functions that immediately * depend on this one. See drupal_depth_first_search() for more details on * the format. - * - 'module': The name of the module that this update function belongs to. - * - 'number': The number of this update function within that module. + * - module: The name of the module that this update function belongs to. + * - number: The number of this update function within that module. * * @see drupal_depth_first_search() * @see update_resolve_dependencies() diff --git a/core/modules/block/block.api.php b/core/modules/block/block.api.php index d33f594..4a078dd 100644 --- a/core/modules/block/block.api.php +++ b/core/modules/block/block.api.php @@ -39,10 +39,10 @@ * An associative array whose keys define the delta for each block and whose * values contain the block descriptions. Each block description is itself an * associative array, with the following key-value pairs: - * - 'info': (required) The human-readable administrative name of the block. + * - info: (required) The human-readable administrative name of the block. * This is used to identify the block on administration screens, and * is not displayed to non-administrative users. - * - 'cache': (optional) A bitmask describing what kind of caching is + * - cache: (optional) A bitmask describing what kind of caching is * appropriate for the block. Drupal provides the following bitmask * constants for defining cache granularity: * - DRUPAL_CACHE_PER_ROLE (default): The block can change depending on the @@ -56,25 +56,25 @@ * - DRUPAL_CACHE_GLOBAL: The block is the same for every user on every * page where it is visible. * - DRUPAL_NO_CACHE: The block should not get cached. - * - 'properties': (optional) Array of additional metadata to add to the + * - properties: (optional) Array of additional metadata to add to the * block. Common properties include: - * - 'administrative': Boolean which categorizes this block as usable in + * - administrative: Boolean which categorizes this block as usable in * an administrative context. This might include blocks which help an * administrator approve/deny comments, or view recently created * user accounts. - * - 'weight': (optional) Initial value for the ordering weight of this block. + * - weight: (optional) Initial value for the ordering weight of this block. * Most modules do not provide an initial value, and any value provided can * be modified by a user on the block configuration screen. - * - 'status': (optional) Initial value for block enabled status. (1 = + * - status: (optional) Initial value for block enabled status. (1 = * enabled, 0 = disabled). Most modules do not provide an initial value, * and any value provided can be modified by a user on the block * configuration screen. - * - 'region': (optional) Initial value for theme region within which this + * - region: (optional) Initial value for theme region within which this * block is set. Most modules do not provide an initial value, and * any value provided can be modified by a user on the block configuration * screen. Note: If you set a region that isn't available in the currently * enabled theme, the block will be disabled. - * - 'visibility': (optional) Initial value for the visibility flag, which + * - visibility: (optional) Initial value for the visibility flag, which * tells how to interpret the 'pages' value. Possible values are: * - BLOCK_VISIBILITY_NOTLISTED: Show on all pages except listed pages. * 'pages' lists the paths where the block should not be shown. @@ -85,7 +85,7 @@ * Most modules do not provide an initial value for 'visibility' or 'pages', * and any value provided can be modified by a user on the block * configuration screen. - * - 'pages': (optional) See 'visibility' above. + * - pages: (optional) See 'visibility' above. * * For a detailed usage example, see block_example.module. * diff --git a/core/modules/comment/comment.module b/core/modules/comment/comment.module index 7ad14e8..f1e4e06 100644 --- a/core/modules/comment/comment.module +++ b/core/modules/comment/comment.module @@ -2320,7 +2320,7 @@ function comment_action_info() { * An optional comment object. * @param array $context * Array with components: - * - 'cid': Comment ID. Required if $comment is not given. + * - cid: Comment ID. Required if $comment is not given. * * @ingroup actions */ @@ -2347,7 +2347,7 @@ function comment_publish_action($comment, $context = array()) { * An optional comment object. * @param array $context * Array with components: - * - 'cid': Comment ID. Required if $comment is not given. + * - cid: Comment ID. Required if $comment is not given. * * @ingroup actions */ @@ -2374,7 +2374,7 @@ function comment_unpublish_action($comment, $context = array()) { * Comment object to modify. * @param array $context * Array with components: - * - 'keywords': Keywords to look for. If the comment contains at least one + * - keywords: Keywords to look for. If the comment contains at least one * of the keywords, it is unpublished. * * @ingroup actions diff --git a/core/modules/field/field.api.php b/core/modules/field/field.api.php index 329cf16..d9064d9 100644 --- a/core/modules/field/field.api.php +++ b/core/modules/field/field.api.php @@ -852,13 +852,13 @@ function hook_field_widget_form(&$form, &$form_state, $field, $instance, $langco * @param $context * An associative array containing the following key-value pairs, matching the * arguments received by hook_field_widget_form(): - * - "form": The form structure where widgets are being attached to. This + * - form: The form structure where widgets are being attached to. This * might be a full form structure, or a sub-element of a larger form. - * - "field": The field structure. - * - "instance": The field instance structure. - * - "langcode": The language associated with $items. - * - "items": Array of default values for this field. - * - "delta": The order of this item in the array of subelements (0, 1, 2, + * - field: The field structure. + * - instance: The field instance structure. + * - langcode: The language associated with $items. + * - items: Array of default values for this field. + * - delta: The order of this item in the array of subelements (0, 1, 2, * etc). * * @see hook_field_widget_form() @@ -886,13 +886,13 @@ function hook_field_widget_form_alter(&$element, &$form_state, $context) { * @param $context * An associative array containing the following key-value pairs, matching the * arguments received by hook_field_widget_form(): - * - "form": The form structure where widgets are being attached to. This + * - form: The form structure where widgets are being attached to. This * might be a full form structure, or a sub-element of a larger form. - * - "field": The field structure. - * - "instance": The field instance structure. - * - "langcode": The language associated with $items. - * - "items": Array of default values for this field. - * - "delta": The order of this item in the array of subelements (0, 1, 2, + * - field: The field structure. + * - instance: The field instance structure. + * - langcode: The language associated with $items. + * - items: Array of default values for this field. + * - delta: The order of this item in the array of subelements (0, 1, 2, * etc). * * @see hook_field_widget_form() diff --git a/core/modules/field/field.attach.inc b/core/modules/field/field.attach.inc index c61ef52..4475620 100644 --- a/core/modules/field/field.attach.inc +++ b/core/modules/field/field.attach.inc @@ -17,10 +17,10 @@ class FieldValidationException extends FieldException { * @param $errors * An array of field validation errors, keyed by field name and * delta that contains two keys: - * - 'error': A machine-readable error code string, prefixed by + * - error: A machine-readable error code string, prefixed by * the field module name. A field widget may use this code to decide * how to report the error. - * - 'message': A human-readable error message such as to be + * - message: A human-readable error message such as to be * passed to form_error() for the appropriate form element. */ function __construct($errors) { @@ -155,15 +155,15 @@ const FIELD_STORAGE_INSERT = 'insert'; * - Otherwise NULL. * @param $options * An associative array of additional options, with the following keys: - * - 'field_name': The name of the field whose operation should be + * - field_name: The name of the field whose operation should be * invoked. By default, the operation is invoked on all the fields * in the entity's bundle. NOTE: This option is not compatible with * the 'deleted' option; the 'field_id' option should be used * instead. - * - 'field_id': The id of the field whose operation should be + * - field_id: The id of the field whose operation should be * invoked. By default, the operation is invoked on all the fields * in the entity's' bundles. - * - 'default': A boolean value, specifying which implementation of + * - default: A boolean value, specifying which implementation of * the operation should be invoked. * - if FALSE (default), the field types implementation of the operation * will be invoked (hook_field_[op]) @@ -171,10 +171,10 @@ const FIELD_STORAGE_INSERT = 'insert'; * will be invoked (field_default_[op]) * Internal use only. Do not explicitely set to TRUE, but use * _field_invoke_default() instead. - * - 'deleted': If TRUE, the function will operate on deleted fields + * - deleted: If TRUE, the function will operate on deleted fields * as well as non-deleted fields. If unset or FALSE, only * non-deleted fields are operated on. - * - 'language': A language code or an array of language codes keyed by field + * - language: A language code or an array of language codes keyed by field * name. It will be used to narrow down to a single value the available * languages to act on. */ @@ -250,14 +250,14 @@ function _field_invoke($op, $entity_type, $entity, &$a = NULL, &$b = NULL, $opti * Currently always NULL. * @param $options * An associative array of additional options, with the following keys: - * - 'field_name': The name of the field whose operation should be + * - field_name: The name of the field whose operation should be * invoked. By default, the operation is invoked on all the fields * in the entity's bundle. NOTE: This option is not compatible with * the 'deleted' option; the 'field_id' option should be used instead. - * - 'field_id': The id of the field whose operation should be + * - field_id: The id of the field whose operation should be * invoked. By default, the operation is invoked on all the fields * in the entity's' bundles. - * - 'default': A boolean value, specifying which implementation of + * - default: A boolean value, specifying which implementation of * the operation should be invoked. * - if FALSE (default), the field types implementation of the operation * will be invoked (hook_field_[op]) @@ -265,10 +265,10 @@ function _field_invoke($op, $entity_type, $entity, &$a = NULL, &$b = NULL, $opti * will be invoked (field_default_[op]) * Internal use only. Do not explicitely set to TRUE, but use * _field_invoke_multiple_default() instead. - * - 'deleted': If TRUE, the function will operate on deleted fields + * - deleted: If TRUE, the function will operate on deleted fields * as well as non-deleted fields. If unset or FALSE, only * non-deleted fields are operated on. - * - 'language': A language code or an array of arrays of language codes keyed + * - language: A language code or an array of arrays of language codes keyed * by entity id and field name. It will be used to narrow down to a single * value the available languages to act on. * @@ -605,11 +605,11 @@ function field_attach_form($entity_type, $entity, &$form, &$form_state, $langcod * field_attach_load_revision() instead of passing FIELD_LOAD_REVISION. * @param $options * An associative array of additional options, with the following keys: - * - 'field_id': The field ID that should be loaded, instead of + * - field_id: The field ID that should be loaded, instead of * loading all fields, for each entity. Note that returned entities * may contain data for other fields, for example if they are read * from a cache. - * - 'deleted': If TRUE, the function will operate on deleted fields + * - deleted: If TRUE, the function will operate on deleted fields * as well as non-deleted fields. If unset or FALSE, only * non-deleted fields are operated on. */ diff --git a/core/modules/field/field.default.inc b/core/modules/field/field.default.inc index cb49bdb..f2039dd 100644 --- a/core/modules/field/field.default.inc +++ b/core/modules/field/field.default.inc @@ -47,7 +47,7 @@ function field_default_extract_form_values($entity_type, $entity, $field, $insta * Generic field validation handler. * * Possible error codes: - * - 'field_cardinality': The number of values exceeds the field cardinality. + * - field_cardinality: The number of values exceeds the field cardinality. * * @see _hook_field_validate() * @@ -68,8 +68,8 @@ function field_default_extract_form_values($entity_type, $entity, $field, $insta * already been reported for the entity. The function should add its errors * to this array. Each error is an associative array, with the following * keys and values: - * - 'error': an error code (should be a string, prefixed with the module name) - * - 'message': the human readable message to be displayed. + * - error: an error code (should be a string, prefixed with the module name) + * - message: the human readable message to be displayed. */ function field_default_validate($entity_type, $entity, $field, $instance, $langcode, $items, &$errors) { // Filter out empty values. diff --git a/core/modules/field/field.info.inc b/core/modules/field/field.info.inc index af7d93d..9023233 100644 --- a/core/modules/field/field.info.inc +++ b/core/modules/field/field.info.inc @@ -42,24 +42,24 @@ function field_info_cache_clear() { * * @return * An associative array containing: - * - 'field types': Array of hook_field_info() results, keyed by field_type. + * - field types: Array of hook_field_info() results, keyed by field_type. * Each element has the following components: label, description, settings, * instance_settings, default_widget, default_formatter, and behaviors * from hook_field_info(), as well as module, giving the module that exposes * the field type. - * - 'widget types': Array of hook_field_widget_info() results, keyed by + * - widget types: Array of hook_field_widget_info() results, keyed by * widget_type. Each element has the following components: label, field * types, settings, and behaviors from hook_field_widget_info(), as well * as module, giving the module that exposes the widget type. - * - 'formatter types': Array of hook_field_formatter_info() results, keyed by + * - formatter types: Array of hook_field_formatter_info() results, keyed by * formatter_type. Each element has the following components: label, field * types, and behaviors from hook_field_formatter_info(), as well as * module, giving the module that exposes the formatter type. - * - 'storage types': Array of hook_field_storage_info() results, keyed by + * - storage types: Array of hook_field_storage_info() results, keyed by * storage type names. Each element has the following components: label, * description, and settings from hook_field_storage_info(), as well as * module, giving the module that exposes the storage type. - * - 'fieldable types': Array of hook_entity_info() results, keyed by + * - fieldable types: Array of hook_entity_info() results, keyed by * entity_type. Each element has the following components: name, id key, * revision key, bundle key, cacheable, and bundles from hook_entity_info(), * as well as module, giving the module that exposes the entity type. diff --git a/core/modules/field/modules/list/list.module b/core/modules/field/modules/list/list.module index 0d397a4..14889fb 100644 --- a/core/modules/field/modules/list/list.module +++ b/core/modules/field/modules/list/list.module @@ -370,7 +370,7 @@ function _list_values_in_use($field, $values) { * Implements hook_field_validate(). * * Possible error codes: - * - 'list_illegal_value': The value is not part of the list of allowed values. + * - list_illegal_value: The value is not part of the list of allowed values. */ function list_field_validate($entity_type, $entity, $field, $instance, $langcode, $items, &$errors) { $allowed_values = list_allowed_values($field); diff --git a/core/modules/field/modules/number/number.module b/core/modules/field/modules/number/number.module index 87e2d3a..86d1b74 100644 --- a/core/modules/field/modules/number/number.module +++ b/core/modules/field/modules/number/number.module @@ -129,8 +129,8 @@ function number_field_instance_settings_form($field, $instance) { * Implements hook_field_validate(). * * Possible error codes: - * - 'number_min': The value is less than the allowed minimum value. - * - 'number_max': The value is greater than the allowed maximum value. + * - number_min: The value is less than the allowed minimum value. + * - number_max: The value is greater than the allowed maximum value. */ function number_field_validate($entity_type, $entity, $field, $instance, $langcode, $items, &$errors) { foreach ($items as $delta => $item) { diff --git a/core/modules/field/modules/text/text.module b/core/modules/field/modules/text/text.module index d73814f..9a70b79 100644 --- a/core/modules/field/modules/text/text.module +++ b/core/modules/field/modules/text/text.module @@ -112,8 +112,8 @@ function text_field_instance_settings_form($field, $instance) { * Implements hook_field_validate(). * * Possible error codes: - * - 'text_value_max_length': The value exceeds the maximum length. - * - 'text_summary_max_length': The summary exceeds the maximum length. + * - text_value_max_length: The value exceeds the maximum length. + * - text_summary_max_length: The summary exceeds the maximum length. */ function text_field_validate($entity_type, $entity, $field, $instance, $langcode, $items, &$errors) { foreach ($items as $delta => $item) { diff --git a/core/modules/field/tests/field_test.field.inc b/core/modules/field/tests/field_test.field.inc index cc76a99..a339ea0 100644 --- a/core/modules/field/tests/field_test.field.inc +++ b/core/modules/field/tests/field_test.field.inc @@ -103,7 +103,7 @@ function field_test_field_delete($entity_type, $entity, $field, $instance, $item * Implements hook_field_validate(). * * Possible error codes: - * - 'field_test_invalid': The value is invalid. + * - field_test_invalid: The value is invalid. */ function field_test_field_validate($entity_type, $entity, $field, $instance, $langcode, $items, &$errors) { $args = func_get_args(); diff --git a/core/modules/filter/filter.module b/core/modules/filter/filter.module index 3b8942f..b238658 100644 --- a/core/modules/filter/filter.module +++ b/core/modules/filter/filter.module @@ -168,24 +168,24 @@ function filter_format_load($format_id) { * * @param $format * A format object using the properties: - * - 'format': A machine-readable name representing the ID of the text format + * - format: A machine-readable name representing the ID of the text format * to save. If this corresponds to an existing text format, that format * will be updated; otherwise, a new format will be created. - * - 'name': The title of the text format. - * - 'status': (optional) An integer indicating whether the text format is + * - name: The title of the text format. + * - status: (optional) An integer indicating whether the text format is * enabled (1) or not (0). Defaults to 1. - * - 'weight': (optional) The weight of the text format, which controls its + * - weight: (optional) The weight of the text format, which controls its * placement in text format lists. If omitted, the weight is set to 0. - * - 'filters': (optional) An associative, multi-dimensional array of filters + * - filters: (optional) An associative, multi-dimensional array of filters * assigned to the text format, keyed by the name of each filter and using * the properties: - * - 'weight': (optional) The weight of the filter in the text format. If + * - weight: (optional) The weight of the filter in the text format. If * omitted, either the currently stored weight is retained (if there is * one), or the filter is assigned a weight of 10, which will usually * put it at the bottom of the list. - * - 'status': (optional) A boolean indicating whether the filter is + * - status: (optional) A boolean indicating whether the filter is * enabled in the text format. If omitted, the filter will be disabled. - * - 'settings': (optional) An array of configured settings for the filter. + * - settings: (optional) An array of configured settings for the filter. * See hook_filter_info() for details. */ function filter_format_save($format) { diff --git a/core/modules/forum/forum.module b/core/modules/forum/forum.module index b334c42..fc546e3 100644 --- a/core/modules/forum/forum.module +++ b/core/modules/forum/forum.module @@ -727,10 +727,10 @@ function forum_form($node, $form_state) { * (optional) Taxonomy ID of the forum, if not givin all forums will be returned. * @return * A tree of taxonomy objects, with the following additional properties: - * - 'num_topics': Number of topics in the forum - * - 'num_posts': Total number of posts in all topics - * - 'last_post': Most recent post for the forum - * - 'forums': An array of child forums + * - num_topics: Number of topics in the forum + * - num_posts: Total number of posts in all topics + * - last_post: Most recent post for the forum + * - forums: An array of child forums */ function forum_forum_load($tid = NULL) { $cache = &drupal_static(__FUNCTION__, array()); diff --git a/core/modules/image/image.api.php b/core/modules/image/image.api.php index 758d38b..e9d4401 100644 --- a/core/modules/image/image.api.php +++ b/core/modules/image/image.api.php @@ -20,17 +20,17 @@ * An array of image effects. This array is keyed on the machine-readable * effect name. Each effect is defined as an associative array containing the * following items: - * - "label": The human-readable name of the effect. - * - "effect callback": The function to call to perform this image effect. - * - "dimensions passthrough": (optional) Set this item if the effect doesn't + * - label: The human-readable name of the effect. + * - effect callback: The function to call to perform this image effect. + * - dimensions passthrough: (optional) Set this item if the effect doesn't * change the dimensions of the image. - * - "dimensions callback": (optional) The function to call to transform + * - dimensions callback: (optional) The function to call to transform * dimensions for this effect. - * - "help": (optional) A brief description of the effect that will be shown + * - help: (optional) A brief description of the effect that will be shown * when adding or configuring this image effect. - * - "form callback": (optional) The name of a function that will return a + * - form callback: (optional) The name of a function that will return a * $form array providing a configuration form for this image effect. - * - "summary theme": (optional) The name of a theme function that will output + * - summary theme: (optional) The name of a theme function that will output * a summary of this image effect's configuration. * * @see hook_image_effect_info_alter() diff --git a/core/modules/image/image.effects.inc b/core/modules/image/image.effects.inc index 35a6a74..fcb8f27 100644 --- a/core/modules/image/image.effects.inc +++ b/core/modules/image/image.effects.inc @@ -69,8 +69,8 @@ function image_image_effect_info() { * @param $data * An array of attributes to use when performing the resize effect with the * following items: - * - "width": An integer representing the desired width in pixels. - * - "height": An integer representing the desired height in pixels. + * - width: An integer representing the desired width in pixels. + * - height: An integer representing the desired height in pixels. * * @return * TRUE on success. FALSE on failure to resize image. @@ -94,8 +94,8 @@ function image_resize_effect(&$image, $data) { * @param $data * An array of attributes to use when performing the resize effect with the * following items: - * - "width": An integer representing the desired width in pixels. - * - "height": An integer representing the desired height in pixels. + * - width: An integer representing the desired width in pixels. + * - height: An integer representing the desired height in pixels. */ function image_resize_dimensions(array &$dimensions, array $data) { // The new image will have the exact dimensions defined for the effect. @@ -111,9 +111,9 @@ function image_resize_dimensions(array &$dimensions, array $data) { * @param $data * An array of attributes to use when performing the scale effect with the * following items: - * - "width": An integer representing the desired width in pixels. - * - "height": An integer representing the desired height in pixels. - * - "upscale": A boolean indicating that the image should be upscaled if the + * - width: An integer representing the desired width in pixels. + * - height: An integer representing the desired height in pixels. + * - upscale: A boolean indicating that the image should be upscaled if the * dimensions are larger than the original image. * * @return @@ -145,9 +145,9 @@ function image_scale_effect(&$image, $data) { * @param $data * An array of attributes to use when performing the scale effect with the * following items: - * - "width": An integer representing the desired width in pixels. - * - "height": An integer representing the desired height in pixels. - * - "upscale": A boolean indicating that the image should be upscaled if the + * - width: An integer representing the desired width in pixels. + * - height: An integer representing the desired height in pixels. + * - upscale: A boolean indicating that the image should be upscaled if the * dimensions are larger than the original image. */ function image_scale_dimensions(array &$dimensions, array $data) { @@ -164,9 +164,9 @@ function image_scale_dimensions(array &$dimensions, array $data) { * @param $data * An array of attributes to use when performing the crop effect with the * following items: - * - "width": An integer representing the desired width in pixels. - * - "height": An integer representing the desired height in pixels. - * - "anchor": A string describing where the crop should originate in the form + * - width: An integer representing the desired width in pixels. + * - height: An integer representing the desired height in pixels. + * - anchor: A string describing where the crop should originate in the form * of "XOFFSET-YOFFSET". XOFFSET is either a number of pixels or * "left", "center", "right" and YOFFSET is either a number of pixels or * "top", "center", "bottom". @@ -198,8 +198,8 @@ function image_crop_effect(&$image, $data) { * @param $data * An array of attributes to use when performing the scale and crop effect * with the following items: - * - "width": An integer representing the desired width in pixels. - * - "height": An integer representing the desired height in pixels. + * - width: An integer representing the desired width in pixels. + * - height: An integer representing the desired height in pixels. * @return * TRUE on success. FALSE on failure to scale and crop image. * @see image_scale_and_crop() @@ -239,11 +239,11 @@ function image_desaturate_effect(&$image, $data) { * @param $data * An array of attributes to use when performing the rotate effect containing * the following items: - * - "degrees": The number of (clockwise) degrees to rotate the image. - * - "random": A boolean indicating that a random rotation angle should be + * - degrees: The number of (clockwise) degrees to rotate the image. + * - random: A boolean indicating that a random rotation angle should be * used for this image. The angle specified in "degrees" is used as a * positive and negative maximum. - * - "bgcolor": The background color to use for exposed areas of the image. + * - bgcolor: The background color to use for exposed areas of the image. * Use web-style hex colors (#FFFFFF for white, #000000 for black). Leave * blank for transparency on image types that support it. * @return @@ -293,8 +293,8 @@ function image_rotate_effect(&$image, $data) { * @param $data * An array of attributes to use when performing the rotate effect containing * the following items: - * - "degrees": The number of (clockwise) degrees to rotate the image. - * - "random": A boolean indicating that a random rotation angle should be + * - degrees: The number of (clockwise) degrees to rotate the image. + * - random: A boolean indicating that a random rotation angle should be * used for this image. The angle specified in "degrees" is used as a * positive and negative maximum. */ diff --git a/core/modules/image/image.module b/core/modules/image/image.module index f39a2a0..0b4f525 100644 --- a/core/modules/image/image.module +++ b/core/modules/image/image.module @@ -548,9 +548,9 @@ function image_styles() { * one of the defined Image style storage constants. * @return * An image style array containing the following keys: - * - "isid": The unique image style ID. - * - "name": The unique image style name. - * - "effects": An array of image effects within this image style. + * - isid: The unique image style ID. + * - name: The unique image style name. + * - effects: An array of image effects within this image style. * If the image style name or ID is not valid, an empty array is returned. * @see image_effect_load() */ @@ -1019,13 +1019,13 @@ function image_effect_definitions() { * An image style array to which this effect will be added. * @return * An array containing the image effect definition with the following keys: - * - "effect": The unique name for the effect being performed. Usually prefixed + * - effect: The unique name for the effect being performed. Usually prefixed * with the name of the module providing the effect. - * - "module": The module providing the effect. - * - "help": A description of the effect. - * - "function": The name of the function that will execute the effect. - * - "form": (optional) The name of a function to configure the effect. - * - "summary": (optional) The name of a theme function that will display a + * - module: The module providing the effect. + * - help: A description of the effect. + * - function: The name of the function that will execute the effect. + * - form: (optional) The name of a function to configure the effect. + * - summary: (optional) The name of a theme function that will display a * one-line summary of the effect. Does not include the "theme_" prefix. */ function image_effect_definition_load($effect, $style_name = NULL) { @@ -1087,11 +1087,11 @@ function image_effects() { * one of the defined Image style storage constants. * @return * An image effect array, consisting of the following keys: - * - "ieid": The unique image effect ID. - * - "isid": The unique image style ID that contains this image effect. - * - "weight": The weight of this image effect within the image style. - * - "name": The name of the effect definition that powers this image effect. - * - "data": An array of configuration options for this image effect. + * - ieid: The unique image effect ID. + * - isid: The unique image style ID that contains this image effect. + * - weight: The weight of this image effect within the image style. + * - name: The name of the effect definition that powers this image effect. + * - data: An array of configuration options for this image effect. * Besides these keys, the entirety of the image definition is merged into * the image effect array. Returns FALSE if the specified effect cannot be * found. diff --git a/core/modules/locale/locale.api.php b/core/modules/locale/locale.api.php index 4b4523a..5af69b0 100644 --- a/core/modules/locale/locale.api.php +++ b/core/modules/locale/locale.api.php @@ -68,9 +68,9 @@ function hook_language_switch_links_alter(array &$links, $type, $path) { * An array of language type definitions. Each language type has an identifier * key. The language type definition is an associative array that may contain * the following key-value pairs: - * - "name": The human-readable language type identifier. - * - "description": A description of the language type. - * - "fixed": An array of language provider identifiers. Defining this key + * - name: The human-readable language type identifier. + * - description: A description of the language type. + * - fixed: An array of language provider identifiers. Defining this key * makes the language type non-configurable. */ function hook_language_types_info() { @@ -104,24 +104,24 @@ function hook_language_types_info_alter(array &$language_types) { * An array of language provider definitions. Each language provider has an * identifier key. The language provider definition is an associative array * that may contain the following key-value pairs: - * - "types": An array of allowed language types. If a language provider does + * - types: An array of allowed language types. If a language provider does * not specify which language types it should be used with, it will be * available for all the configurable language types. - * - "callbacks": An array of functions that will be called to perform various + * - callbacks: An array of functions that will be called to perform various * tasks. Possible key-value pairs are: - * - "language": Required. The callback that will determine the language + * - language: Required. The callback that will determine the language * value. - * - "switcher": The callback that will determine the language switch links + * - switcher: The callback that will determine the language switch links * associated to the current language provider. - * - "url_rewrite": The callback that will provide URL rewriting. - * - "file": A file that will be included before the callback is invoked; this + * - url_rewrite: The callback that will provide URL rewriting. + * - file: A file that will be included before the callback is invoked; this * allows callback functions to be in separate files. - * - "weight": The default weight the language provider has. - * - "name": A human-readable identifier. - * - "description": A description of the language provider. - * - "config": An internal path pointing to the language provider + * - weight: The default weight the language provider has. + * - name: A human-readable identifier. + * - description: A description of the language provider. + * - config: An internal path pointing to the language provider * configuration page. - * - "cache": The value Drupal's page cache should be set to for the current + * - cache: The value Drupal's page cache should be set to for the current * language provider to be invoked. */ function hook_language_negotiation_info() { diff --git a/core/modules/node/node.api.php b/core/modules/node/node.api.php index c297818..344a525 100644 --- a/core/modules/node/node.api.php +++ b/core/modules/node/node.api.php @@ -220,16 +220,16 @@ function hook_node_grants($account, $op) { * integers and not boolean TRUE and FALSE. * * Each permissions item in the array is an array with the following elements: - * - 'realm': The name of a realm that the module has defined in + * - realm: The name of a realm that the module has defined in * hook_node_grants(). - * - 'gid': A 'grant ID' from hook_node_grants(). - * - 'grant_view': If set to 1 a user that has been identified as a member + * - gid: A 'grant ID' from hook_node_grants(). + * - grant_view: If set to 1 a user that has been identified as a member * of this gid within this realm can view this node. This should usually be * set to $node->status. Failure to do so may expose unpublished content * to some users. - * - 'grant_update': If set to 1 a user that has been identified as a member + * - grant_update: If set to 1 a user that has been identified as a member * of this gid within this realm can edit this node. - * - 'grant_delete': If set to 1 a user that has been identified as a member + * - grant_delete: If set to 1 a user that has been identified as a member * of this gid within this realm can delete this node. * * @@ -402,10 +402,10 @@ function hook_node_grants_alter(&$grants, $account, $op) { * @return * An array of operations. Each operation is an associative array that may * contain the following key-value pairs: - * - 'label': Required. The label for the operation, displayed in the dropdown + * - label: Required. The label for the operation, displayed in the dropdown * menu. - * - 'callback': Required. The function to call for the operation. - * - 'callback arguments': Optional. An array of additional arguments to pass + * - callback: Required. The function to call for the operation. + * - callback arguments: Optional. An array of additional arguments to pass * to the callback function. */ function hook_node_operations() { @@ -873,20 +873,20 @@ function hook_node_view_alter(&$build) { * contains a sub-array for each node type, with the the machine name of a * content type as the key. Each sub-array has up to 10 attributes. * Possible attributes: - * - "name": the human-readable name of the node type. Required. - * - "base": the base string used to construct callbacks corresponding to + * - name: the human-readable name of the node type. Required. + * - base: the base string used to construct callbacks corresponding to * this node type. * (i.e. if base is defined as example_foo, then example_foo_insert will * be called when inserting a node of that type). This string is usually * the name of the module, but not always. Required. - * - "description": a brief description of the node type. Required. - * - "help": help information shown to the user when creating a node of + * - description: a brief description of the node type. Required. + * - help: help information shown to the user when creating a node of * this type.. Optional (defaults to ''). - * - "has_title": boolean indicating whether or not this node type has a title + * - has_title: boolean indicating whether or not this node type has a title * field. Optional (defaults to TRUE). - * - "title_label": the label for the title field of this content type. + * - title_label: the label for the title field of this content type. * Optional (defaults to 'Title'). - * - "locked": boolean indicating whether the administrator can change the + * - locked: boolean indicating whether the administrator can change the * machine name of this type. FALSE = changeable (not locked), * TRUE = unchangeable (locked). Optional (defaults to TRUE). * @@ -937,19 +937,19 @@ function hook_node_info() { * corresponding to the internal name of the ranking mechanism, such as * 'recent', or 'comments'. The values should be arrays themselves, with the * following keys available: - * - "title": the human readable name of the ranking mechanism. Required. - * - "join": part of a query string to join to any additional necessary + * - title: the human readable name of the ranking mechanism. Required. + * - join: part of a query string to join to any additional necessary * table. This is not necessary if the table required is already joined to * by the base query, such as for the {node} table. Other tables should use * the full table name as an alias to avoid naming collisions. Optional. - * - "score": part of a query string to calculate the score for the ranking + * - score: part of a query string to calculate the score for the ranking * mechanism based on values in the database. This does not need to be * wrapped in parentheses, as it will be done automatically; it also does * not need to take the weighted system into account, as it will be done * automatically. It does, however, need to calculate a decimal between * 0 and 1; be careful not to cast the entire score to an integer by * inadvertently introducing a variable argument. Required. - * - "arguments": if any arguments are required for the score, they can be + * - arguments: if any arguments are required for the score, they can be * specified in an array here. * * @ingroup node_api_hooks diff --git a/core/modules/overlay/overlay.module b/core/modules/overlay/overlay.module index 8f62c01..443e470 100644 --- a/core/modules/overlay/overlay.module +++ b/core/modules/overlay/overlay.module @@ -577,13 +577,13 @@ function overlay_get_mode() { * * @param $mode * To set the mode, pass in one of the following values: - * - 'parent': This is used in the context of a parent window (a regular + * - parent: This is used in the context of a parent window (a regular * browser window). If set, JavaScript is added so that administrative * links in the parent window will open in an overlay. - * - 'child': This is used in the context of the child overlay window (the + * - child: This is used in the context of the child overlay window (the * page actually appearing within the overlay iframe). If set, JavaScript * and CSS are added so that Drupal behaves nicely from within the overlay. - * - 'none': This is used to avoid adding any overlay-related code to the + * - none: This is used to avoid adding any overlay-related code to the * page at all. Modules can set this to explicitly prevent the overlay from * being used. For example, since the overlay module itself sets the mode * to 'parent' or 'child' in overlay_init() when certain conditions are diff --git a/core/modules/search/search.api.php b/core/modules/search/search.api.php index 534c1e8..cb19f51 100644 --- a/core/modules/search/search.api.php +++ b/core/modules/search/search.api.php @@ -30,11 +30,11 @@ * * @return * Array with optional keys: - * - 'title': Title for the tab on the search page for this module. Defaults + * - title: Title for the tab on the search page for this module. Defaults * to the module name if not given. - * - 'path': Path component after 'search/' for searching with this module. + * - path: Path component after 'search/' for searching with this module. * Defaults to the module name if not given. - * - 'conditions_callback': Name of a callback function that is invoked by + * - conditions_callback: Name of a callback function that is invoked by * search_view() to get an array of additional search conditions to pass to * search_data(). For example, a search module may get additional keywords, * filters, or modifiers for the search from the query string. Sample @@ -111,8 +111,8 @@ function hook_search_reset() { * * @return * An associative array with the key-value pairs: - * - 'remaining': The number of items left to index. - * - 'total': The total number of items to index. + * - remaining: The number of items left to index. + * - total: The total number of items to index. * * @ingroup search */ @@ -181,15 +181,15 @@ function hook_search_admin() { * @return * An array of search results. To use the default search result * display, each item should have the following keys': - * - 'link': Required. The URL of the found item. - * - 'type': The type of item (such as the content type). - * - 'title': Required. The name of the item. - * - 'user': The author of the item. - * - 'date': A timestamp when the item was last modified. - * - 'extra': An array of optional extra information items. - * - 'snippet': An excerpt or preview to show with the result (can be + * - link: Required. The URL of the found item. + * - type: The type of item (such as the content type). + * - title: Required. The name of the item. + * - user: The author of the item. + * - date: A timestamp when the item was last modified. + * - extra: An array of optional extra information items. + * - snippet: An excerpt or preview to show with the result (can be * generated with search_excerpt()). - * - 'language': Language code for the item (usually two characters). + * - language: Language code for the item (usually two characters). * * @ingroup search */ diff --git a/core/modules/shortcut/shortcut.module b/core/modules/shortcut/shortcut.module index b057e4b..7ef622a 100644 --- a/core/modules/shortcut/shortcut.module +++ b/core/modules/shortcut/shortcut.module @@ -307,9 +307,9 @@ function shortcut_link_access($menu_link) { * * @return object * If the shortcut set exists, an object containing the following properties: - * - 'set_name': The internal name of the shortcut set. - * - 'title': The title of the shortcut set. - * - 'links': An array of links associated with this shortcut set. + * - set_name: The internal name of the shortcut set. + * - title: The title of the shortcut set. + * - links: An array of links associated with this shortcut set. * If the shortcut set does not exist, the function returns FALSE. */ function shortcut_set_load($set_name) { @@ -330,16 +330,16 @@ function shortcut_set_load($set_name) { * * @param $shortcut_set * An object containing the following properties: - * - 'title': The title of the shortcut set. - * - 'set_name': (optional) The internal name of the shortcut set. If + * - title: The title of the shortcut set. + * - set_name: (optional) The internal name of the shortcut set. If * omitted, a new shortcut set will be created, and the 'set_name' property * will be added to the passed-in object. - * - 'links': (optional) An array of menu links to save for the shortcut set. + * - links: (optional) An array of menu links to save for the shortcut set. * Each link is an array containing at least the following keys (which will * be expanded to fill in other default values after the shortcut set is * saved): - * - 'link_path': The Drupal path or external path that the link points to. - * - 'link_title': The title of the link. + * - link_path: The Drupal path or external path that the link points to. + * - link_title: The title of the link. * Any other keys accepted by menu_link_save() may also be provided. * * @return diff --git a/core/modules/shortcut/shortcut.test b/core/modules/shortcut/shortcut.test index 322c63f..1d0e6e7 100644 --- a/core/modules/shortcut/shortcut.test +++ b/core/modules/shortcut/shortcut.test @@ -80,9 +80,9 @@ class ShortcutTestCase extends DrupalWebTestCase { * The shortcut set object to extract information from. * @param string $key * The array key indicating what information to extract from each link: - * - 'link_path': Extract link paths. - * - 'link_title': Extract link titles. - * - 'mlid': Extract the menu link item ID numbers. + * - link_path: Extract link paths. + * - link_title: Extract link titles. + * - mlid: Extract the menu link item ID numbers. * * @return array * Array of the requested information from each link. diff --git a/core/modules/simpletest/drupal_web_test_case.php b/core/modules/simpletest/drupal_web_test_case.php index 6adaf93..32f1ec7 100644 --- a/core/modules/simpletest/drupal_web_test_case.php +++ b/core/modules/simpletest/drupal_web_test_case.php @@ -4,8 +4,8 @@ * Global variable that holds information about the tests being run. * * An array, with the following keys: - * - 'test_run_id': the ID of the test being run, in the form 'simpletest_%" - * - 'in_child_site': TRUE if the current request is a cURL request from + * - test_run_id: the ID of the test being run, in the form 'simpletest_%" + * - in_child_site: TRUE if the current request is a cURL request from * the parent site. * * @var array diff --git a/core/modules/statistics/statistics.module b/core/modules/statistics/statistics.module index eda808f..b92b305 100644 --- a/core/modules/statistics/statistics.module +++ b/core/modules/statistics/statistics.module @@ -253,9 +253,9 @@ function statistics_cron() { * * @param $dbfield * one of - * - 'totalcount': top viewed content of all time. - * - 'daycount': top viewed content for today. - * - 'timestamp': last viewed node. + * - totalcount: top viewed content of all time. + * - daycount: top viewed content for today. + * - timestamp: last viewed node. * * @param $dbrows * number of rows to be returned. diff --git a/core/modules/system/image.gd.inc b/core/modules/system/image.gd.inc index 39f86dc..6546643 100644 --- a/core/modules/system/image.gd.inc +++ b/core/modules/system/image.gd.inc @@ -337,10 +337,10 @@ function image_gd_create_tmp(stdClass $image, $width, $height) { * @return * FALSE, if the file could not be found or is not an image. Otherwise, a * keyed array containing information about the image: - * - "width": Width, in pixels. - * - "height": Height, in pixels. - * - "extension": Commonly used file extension for the image. - * - "mime_type": MIME type ('image/jpeg', 'image/gif', 'image/png'). + * - width: Width, in pixels. + * - height: Height, in pixels. + * - extension: Commonly used file extension for the image. + * - mime_type: MIME type ('image/jpeg', 'image/gif', 'image/png'). * * @see image_get_info() */ diff --git a/core/modules/system/system.api.php b/core/modules/system/system.api.php index e8026e6..245da11 100644 --- a/core/modules/system/system.api.php +++ b/core/modules/system/system.api.php @@ -157,10 +157,10 @@ function hook_cron() { * @return * An associative array where the key is the queue name and the value is * again an associative array. Possible keys are: - * - 'worker callback': The name of the function to call. It will be called + * - worker callback: The name of the function to call. It will be called * with one argument, the item created via DrupalQueue::createItem() in * hook_cron(). - * - 'time': (optional) How much time Drupal should spend on calling this + * - time: (optional) How much time Drupal should spend on calling this * worker in seconds. Defaults to 15. * * @see hook_cron() @@ -213,18 +213,18 @@ function hook_cron_queue_info_alter(&$queues) { * An associative array describing the element types being defined. The array * contains a sub-array for each element type, with the machine-readable type * name as the key. Each sub-array has a number of possible attributes: - * - "#input": boolean indicating whether or not this element carries a value + * - #input: boolean indicating whether or not this element carries a value * (even if it's hidden). - * - "#process": array of callback functions taking $element, $form_state, + * - #process: array of callback functions taking $element, $form_state, * and $complete_form. - * - "#after_build": array of callback functions taking $element and $form_state. - * - "#validate": array of callback functions taking $form and $form_state. - * - "#element_validate": array of callback functions taking $element and + * - #after_build: array of callback functions taking $element and $form_state. + * - #validate: array of callback functions taking $form and $form_state. + * - #element_validate: array of callback functions taking $element and * $form_state. - * - "#pre_render": array of callback functions taking $element and $form_state. - * - "#post_render": array of callback functions taking $element and $form_state. - * - "#submit": array of callback functions taking $form and $form_state. - * - "#title_display": optional string indicating if and how #title should be + * - #pre_render: array of callback functions taking $element and $form_state. + * - #post_render: array of callback functions taking $element and $form_state. + * - #submit: array of callback functions taking $form and $form_state. + * - #title_display: optional string indicating if and how #title should be * displayed, see theme_form_element() and theme_form_element_label(). * * @see hook_element_info_alter() @@ -302,19 +302,19 @@ function hook_js_alter(&$javascript) { * sub-array is the machine readable name of the library. Each library may * contain the following items: * - * - 'title': The human readable name of the library. - * - 'website': The URL of the library's web site. - * - 'version': A string specifying the version of the library; intentionally + * - title: The human readable name of the library. + * - website: The URL of the library's web site. + * - version: A string specifying the version of the library; intentionally * not a float because a version like "1.2.3" is not a valid float. Use PHP's * version_compare() to compare different versions. - * - 'js': An array of JavaScript elements; each element's key is used as $data + * - js: An array of JavaScript elements; each element's key is used as $data * argument, each element's value is used as $options array for * drupal_add_js(). To add library-specific (not module-specific) JavaScript * settings, the key may be skipped, the value must specify * 'type' => 'setting', and the actual settings must be contained in a 'data' * element of the value. - * - 'css': Like 'js', an array of CSS elements passed to drupal_add_css(). - * - 'dependencies': An array of libraries that are required for a library. Each + * - css: Like 'js', an array of CSS elements passed to drupal_add_css(). + * - dependencies: An array of libraries that are required for a library. Each * element is an array listing the module and name of another library. Note * that all dependencies for each dependent library will also be added when * this library is added. @@ -670,24 +670,24 @@ function hook_menu_get_item_alter(&$router_item, $path, $original_map) { * An array of menu items. Each menu item has a key corresponding to the * Drupal path being registered. The corresponding array value is an * associative array that may contain the following key-value pairs: - * - "title": Required. The untranslated title of the menu item. - * - "title callback": Function to generate the title; defaults to t(). + * - title: Required. The untranslated title of the menu item. + * - title callback: Function to generate the title; defaults to t(). * If you require only the raw string to be output, set this to FALSE. - * - "title arguments": Arguments to send to t() or your custom callback, + * - title arguments: Arguments to send to t() or your custom callback, * with path component substitution as described above. - * - "description": The untranslated description of the menu item. - * - "page callback": The function to call to display a web page when the user + * - description: The untranslated description of the menu item. + * - page callback: The function to call to display a web page when the user * visits the path. If omitted, the parent menu item's callback will be used * instead. - * - "page arguments": An array of arguments to pass to the page callback + * - page arguments: An array of arguments to pass to the page callback * function, with path component substitution as described above. - * - "delivery callback": The function to call to package the result of the + * - delivery callback: The function to call to package the result of the * page callback function and send it to the browser. Defaults to * drupal_deliver_html_page() unless a value is inherited from a parent menu * item. Note that this function is called even if the access checks fail, * so any custom delivery callback function should take that into account. * See drupal_deliver_html_page() for an example. - * - "access callback": A function returning TRUE if the user has access + * - access callback: A function returning TRUE if the user has access * rights to this menu item, and FALSE if not. It can also be a boolean * constant instead of a function, and you can also use numeric values * (will be cast to boolean). Defaults to user_access() unless a value is @@ -695,11 +695,11 @@ function hook_menu_get_item_alter(&$router_item, $path, $original_map) { * can inherit access callbacks. To use the user_access() default callback, * you must specify the permission to check as 'access arguments' (see * below). - * - "access arguments": An array of arguments to pass to the access callback + * - access arguments: An array of arguments to pass to the access callback * function, with path component substitution as described above. If the * access callback is inherited (see above), the access arguments will be * inherited with it, unless overridden in the child menu item. - * - "theme callback": (optional) A function returning the machine-readable + * - theme callback: (optional) A function returning the machine-readable * name of the theme that will be used to render the page. If not provided, * the value will be inherited from a parent menu item. If there is no * theme callback, or if the function does not return the name of a current @@ -712,16 +712,16 @@ function hook_menu_get_item_alter(&$router_item, $path, $original_map) { * switching functionality (for example, a module which allows the theme to * be set dynamically based on the current user's role) should use * hook_custom_theme() instead. - * - "theme arguments": An array of arguments to pass to the theme callback + * - theme arguments: An array of arguments to pass to the theme callback * function, with path component substitution as described above. - * - "file": A file that will be included before the page callback is called; + * - file: A file that will be included before the page callback is called; * this allows page callback functions to be in separate files. The file * should be relative to the implementing module's directory unless * otherwise specified by the "file path" option. Does not apply to other * callbacks (only page callback). - * - "file path": The path to the directory containing the file specified in + * - file path: The path to the directory containing the file specified in * "file". This defaults to the path to the module implementing the hook. - * - "load arguments": An array of arguments to be passed to each of the + * - load arguments: An array of arguments to be passed to each of the * wildcard object loaders in the path, after the path argument itself. * For example, if a module registers path node/%node/revisions/%/view * with load arguments set to array(3), the '%node' in the path indicates @@ -743,12 +743,12 @@ function hook_menu_get_item_alter(&$router_item, $path, $original_map) { * component and numbering starts at zero). user_category_load() can then * use these values to extract the information that 'foo' is the category * being requested. - * - "weight": An integer that determines the relative position of items in + * - weight: An integer that determines the relative position of items in * the menu; higher-weighted items sink. Defaults to 0. Menu items with the * same weight are ordered alphabetically. - * - "menu_name": Optional. Set this to a custom menu if you don't want your + * - menu_name: Optional. Set this to a custom menu if you don't want your * item to be placed in Navigation. - * - "context": (optional) Defines the context a tab may appear in. By + * - context: (optional) Defines the context a tab may appear in. By * default, all tabs are only displayed as local tasks when being rendered * in a page context. All tabs that should be accessible as contextual links * in page region containers outside of the parent menu item's primary page @@ -762,14 +762,14 @@ function hook_menu_get_item_alter(&$router_item, $path, $original_map) { * @code * 'context' => MENU_CONTEXT_PAGE | MENU_CONTEXT_INLINE, * @endcode - * - "tab_parent": For local task menu items, the path of the task's parent + * - tab_parent: For local task menu items, the path of the task's parent * item; defaults to the same path without the last component (e.g., the * default parent for 'admin/people/create' is 'admin/people'). - * - "tab_root": For local task menu items, the path of the closest non-tab + * - tab_root: For local task menu items, the path of the closest non-tab * item; same default as "tab_parent". - * - "position": Position of the block ('left' or 'right') on the system + * - position: Position of the block ('left' or 'right') on the system * administration page for this item. - * - "type": A bitmask of flags describing properties of the menu item. + * - type: A bitmask of flags describing properties of the menu item. * Many shortcut bitmasks are provided as constants in menu.inc: * - MENU_NORMAL_ITEM: Normal menu items show up in the menu tree and can be * moved/hidden by the administrator. @@ -785,7 +785,7 @@ function hook_menu_get_item_alter(&$router_item, $path, $original_map) { * - MENU_DEFAULT_LOCAL_TASK: Every set of local tasks should provide one * "default" task, which should display the same page as the parent item. * If the "type" element is omitted, MENU_NORMAL_ITEM is assumed. - * - "options": An array of options to be passed to l() when generating a link + * - options: An array of options to be passed to l() when generating a link * from this menu item. * * For a detailed usage example, see page_example.module. @@ -1424,18 +1424,18 @@ function hook_init() { * * The toolkit's functions must be named image_toolkitname_operation(). * where the operation may be: - * - 'load': Required. See image_gd_load() for usage. - * - 'save': Required. See image_gd_save() for usage. - * - 'settings': Optional. See image_gd_settings() for usage. - * - 'resize': Optional. See image_gd_resize() for usage. - * - 'rotate': Optional. See image_gd_rotate() for usage. - * - 'crop': Optional. See image_gd_crop() for usage. - * - 'desaturate': Optional. See image_gd_desaturate() for usage. + * - load: Required. See image_gd_load() for usage. + * - save: Required. See image_gd_save() for usage. + * - settings: Optional. See image_gd_settings() for usage. + * - resize: Optional. See image_gd_resize() for usage. + * - rotate: Optional. See image_gd_rotate() for usage. + * - crop: Optional. See image_gd_crop() for usage. + * - desaturate: Optional. See image_gd_desaturate() for usage. * * @return * An array with the toolkit name as keys and sub-arrays with these keys: - * - 'title': A string with the toolkit's title. - * - 'available': A Boolean value to indicate that the toolkit is operating + * - title: A string with the toolkit's title. + * - available: A Boolean value to indicate that the toolkit is operating * properly, e.g. all required libraries exist. * * @see system_image_toolkits() @@ -1468,32 +1468,32 @@ function hook_image_toolkits() { * * @param $message * An array containing the message data. Keys in this array include: - * - 'id': + * - id: * The drupal_mail() id of the message. Look at module source code or * drupal_mail() for possible id values. - * - 'to': + * - to: * The address or addresses the message will be sent to. The * formatting of this string must comply with RFC 2822. - * - 'from': + * - from: * The address the message will be marked as being from, which is * either a custom address or the site-wide default email address. - * - 'subject': + * - subject: * Subject of the email to be sent. This must not contain any newline * characters, or the email may not be sent properly. - * - 'body': + * - body: * An array of strings containing the message text. The message body is * created by concatenating the individual array strings into a single text * string using "\n\n" as a separator. - * - 'headers': + * - headers: * Associative array containing mail headers, such as From, Sender, * MIME-Version, Content-Type, etc. - * - 'params': + * - params: * An array of optional parameters supplied by the caller of drupal_mail() * that is used to build the message before hook_mail_alter() is invoked. - * - 'language': + * - language: * The language object used to build the message before hook_mail_alter() * is invoked. - * - 'send': + * - send: * Set to FALSE to abort sending this email message. * * @see drupal_mail() @@ -1656,13 +1656,13 @@ function hook_permission() { * Whether a theme, module, etc. is being processed. This is primarily useful * so that themes tell if they are the actual theme being called or a parent * theme. May be one of: - * - 'module': A module is being checked for theme implementations. - * - 'base_theme_engine': A theme engine is being checked for a theme that is + * - module: A module is being checked for theme implementations. + * - base_theme_engine: A theme engine is being checked for a theme that is * a parent of the actual theme being used. - * - 'theme_engine': A theme engine is being checked for the actual theme + * - theme_engine: A theme engine is being checked for the actual theme * being used. - * - 'base_theme': A base theme is being checked for theme implementations. - * - 'theme': The actual theme in use is being checked. + * - base_theme: A base theme is being checked for theme implementations. + * - theme: The actual theme in use is being checked. * @param $theme * The actual name of theme, module, etc. that is being being processed. * @param $path @@ -1851,19 +1851,19 @@ function hook_custom_theme() { * of this array is the type of return value and then you should write a * list of the types of the parameters. XML-RPC types are the following * (See the types at http://www.xmlrpc.com/spec): - * - "boolean": 0 (false) or 1 (true). - * - "double": a floating point number (for example, -12.214). - * - "int": a integer number (for example, -12). - * - "array": an array without keys (for example, array(1, 2, 3)). - * - "struct": an associative array or an object (for example, + * - boolean: 0 (false) or 1 (true). + * - double: a floating point number (for example, -12.214). + * - int: a integer number (for example, -12). + * - array: an array without keys (for example, array(1, 2, 3)). + * - struct: an associative array or an object (for example, * array('one' => 1, 'two' => 2)). - * - "date": when you return a date, then you may either return a + * - date: when you return a date, then you may either return a * timestamp (time(), mktime() etc.) or an ISO8601 timestamp. When * date is specified as an input parameter, then you get an object, * which is described in the function xmlrpc_date - * - "base64": a string containing binary data, automatically + * - base64: a string containing binary data, automatically * encoded/decoded automatically. - * - "string": anything else, typically a string. + * - string: anything else, typically a string. * - A descriptive help string, enclosed in a t() function for translation * purposes. * Both forms are shown in the example. @@ -3204,14 +3204,14 @@ function hook_registry_files_alter(&$files, $modules) { * - 'type' * A string representing the type of task. This parameter has three * possible values: - * - 'normal': This indicates that the task will be treated as a regular + * - normal: This indicates that the task will be treated as a regular * callback function, which does its processing and optionally returns * HTML output. This is the default behavior which is used when 'type' is * not set. - * - 'batch': This indicates that the task function will return a batch + * - batch: This indicates that the task function will return a batch * API definition suitable for batch_set(). The installer will then take * care of automatically running the task via batch processing. - * - 'form': This indicates that the task function will return a standard + * - form: This indicates that the task function will return a standard * form API definition (and separately define validation and submit * handlers, as appropriate). The installer will then take care of * automatically directing the user through the form submission process. @@ -3400,20 +3400,20 @@ function hook_file_mimetype_mapping_alter(&$mapping) { * An associative array of action descriptions. The keys of the array * are the names of the action functions, and each corresponding value * is an associative array with the following key-value pairs: - * - 'type': The type of object this action acts upon. Core actions have types + * - type: The type of object this action acts upon. Core actions have types * 'node', 'user', 'comment', and 'system'. - * - 'label': The human-readable name of the action, which should be passed + * - label: The human-readable name of the action, which should be passed * through the t() function for translation. - * - 'configurable': If FALSE, then the action doesn't require any extra + * - configurable: If FALSE, then the action doesn't require any extra * configuration. If TRUE, then your module must define a form function with * the same name as the action function with '_form' appended (e.g., the * form for 'node_assign_owner_action' is 'node_assign_owner_action_form'.) * This function takes $context as its only parameter, and is paired with * the usual _submit function, and possibly a _validate function. - * - 'triggers': An array of the events (that is, hooks) that can trigger this + * - triggers: An array of the events (that is, hooks) that can trigger this * action. For example: array('node_insert', 'user_update'). You can also * declare support for any trigger by returning array('any') for this value. - * - 'behavior': (optional) A machine-readable array of behaviors of this + * - behavior: (optional) A machine-readable array of behaviors of this * action, used to signal additionally required actions that may need to be * triggered. Modules that are processing actions should take special care * for the "presave" hook, in which case a dependent "save" action should @@ -3601,12 +3601,12 @@ function hook_date_format_types_alter(&$types) { * @return * A list of date formats to offer as choices in the administrative * interface. Each date format is a keyed array consisting of three elements: - * - 'type': The date type name that this format can be used with, as + * - type: The date type name that this format can be used with, as * declared in an implementation of hook_date_format_types(). - * - 'format': A PHP date format string to use when formatting dates. It + * - format: A PHP date format string to use when formatting dates. It * can contain any of the formatting options described at * http://php.net/manual/en/function.date.php - * - 'locales': (optional) An array of 2 and 5 character locale codes, + * - locales: (optional) An array of 2 and 5 character locale codes, * defining which locales this format applies to (for example, 'en', * 'en-us', etc.). If your date format is not language-specific, leave this * array empty. @@ -4149,18 +4149,18 @@ function hook_menu_site_status_alter(&$menu_site_status, $path) { * FileTransfer type (not human readable, used for form elements and * variable names, etc), and the values are subarrays that define properties * of that type. The keys in each subarray are: - * - 'title': Required. The human-readable name of the connection type. - * - 'class': Required. The name of the FileTransfer class. The constructor + * - title: Required. The human-readable name of the connection type. + * - class: Required. The name of the FileTransfer class. The constructor * will always be passed the full path to the root of the site that should * be used to restrict where file transfer operations can occur (the $jail) * and an array of settings values returned by the settings form. - * - 'file': Required. The include file containing the FileTransfer class. + * - file: Required. The include file containing the FileTransfer class. * This should be a separate .inc file, not just the .module file, so that * the minimum possible code is loaded when authorize.php is running. - * - 'file path': Optional. The directory (relative to the Drupal root) + * - file path: Optional. The directory (relative to the Drupal root) * where the include file lives. If not defined, defaults to the base * directory of the module implementing the hook. - * - 'weight': Optional. Integer weight used for sorting connection types on + * - weight: Optional. Integer weight used for sorting connection types on * the authorize.php form. * * @see FileTransfer diff --git a/core/modules/system/system.module b/core/modules/system/system.module index 5fb47ad..c8d134f 100644 --- a/core/modules/system/system.module +++ b/core/modules/system/system.module @@ -3203,11 +3203,11 @@ function system_send_email_action_submit($form, $form_state) { * provided. * @param array $context * Array with the following elements: - * - 'recipient': E-mail message recipient. This will be passed through + * - recipient: E-mail message recipient. This will be passed through * token_replace(). - * - 'subject': The subject of the message. This will be passed through + * - subject: The subject of the message. This will be passed through * token_replace(). - * - 'message': The message to send. This will be passed through + * - message: The message to send. This will be passed through * token_replace(). * - Other elements will be used as the data for token replacement. * @@ -3277,7 +3277,7 @@ function system_message_action_submit($form, $form_state) { * provided. * @param array $context * Array with the following elements: - * - 'message': The message to send. This will be passed through + * - message: The message to send. This will be passed through * token_replace(). * - Other elements will be used as the data for token replacement in * the message. @@ -3320,7 +3320,7 @@ function system_goto_action_submit($form, $form_state) { * Ignored. * @param array $context * Array with the following elements: - * - 'url': URL to redirect to. This will be passed through + * - url: URL to redirect to. This will be passed through * token_replace(). * - Other elements will be used as the data for token replacement. * diff --git a/core/modules/taxonomy/taxonomy.module b/core/modules/taxonomy/taxonomy.module index 606abfc..2b286fb 100644 --- a/core/modules/taxonomy/taxonomy.module +++ b/core/modules/taxonomy/taxonomy.module @@ -1380,7 +1380,7 @@ function taxonomy_options_list($field, $instance) { * Confirm that terms entered as values meet at least one of these conditions. * * Possible error codes: - * - 'taxonomy_term_illegal_value': The value is not part of the list of allowed values. + * - taxonomy_term_illegal_value: The value is not part of the list of allowed values. */ function taxonomy_field_validate($entity_type, $entity, $field, $instance, $langcode, $items, &$errors) { // Build an array of existing term IDs so they can be loaded with diff --git a/core/modules/update/update.authorize.inc b/core/modules/update/update.authorize.inc index 35dde0e..9b3786e 100644 --- a/core/modules/update/update.authorize.inc +++ b/core/modules/update/update.authorize.inc @@ -18,9 +18,9 @@ * @param $projects * A nested array of projects to install into the live webroot, keyed by * project name. Each subarray contains the following keys: - * - 'project': The canonical project short name. - * - 'updater_name': The name of the Updater class to use for this project. - * - 'local_url': The locally installed location of new code to update with. + * - project: The canonical project short name. + * - updater_name: The name of the Updater class to use for this project. + * - local_url: The locally installed location of new code to update with. */ function update_authorize_run_update($filetransfer, $projects) { $operations = array(); diff --git a/core/modules/update/update.module b/core/modules/update/update.module index 6577af7..ecfc2e9 100644 --- a/core/modules/update/update.module +++ b/core/modules/update/update.module @@ -627,7 +627,7 @@ function _update_project_status_sort($a, $b) { * * @param $variables * An associative array containing: - * - 'last': The timestamp when the site last checked for available updates. + * - last: The timestamp when the site last checked for available updates. * * @see theme_update_report() * @see theme_update_available_updates_form() diff --git a/core/modules/user/user.api.php b/core/modules/user/user.api.php index 752d3d4..ad0f5f7 100644 --- a/core/modules/user/user.api.php +++ b/core/modules/user/user.api.php @@ -203,9 +203,9 @@ function hook_user_format_name_alter(&$name, $account) { * @return * An array of operations. Each operation is an associative array that may * contain the following key-value pairs: - * - "label": Required. The label for the operation, displayed in the dropdown menu. - * - "callback": Required. The function to call for the operation. - * - "callback arguments": Optional. An array of additional arguments to pass to + * - label: Required. The label for the operation, displayed in the dropdown menu. + * - callback: Required. The function to call for the operation. + * - callback arguments: Optional. An array of additional arguments to pass to * the callback function. * */