Index: pathauto.inc =================================================================== RCS file: /cvs/drupal-contrib/contributions/modules/pathauto/pathauto.inc,v retrieving revision 1.1.2.46 diff -u -p -r1.1.2.46 pathauto.inc --- pathauto.inc 28 May 2008 10:35:31 -0000 1.1.2.46 +++ pathauto.inc 28 May 2008 16:55:32 -0000 @@ -2,19 +2,26 @@ // $Id: pathauto.inc,v 1.1.2.46 2008/05/28 10:35:31 freso Exp $ /** - * Copied from search.module's PREG_CLASS_SEARCH_EXCLUDE + * @file + * Miscellaneous functions for Pathauto. * - * Matches Unicode character classes to exclude from the search index. + * @ingroup pathauto + */ + +/** + * Matches Unicode character classes. * * See: http://www.unicode.org/Public/UNIDATA/UCD.html#General_Category_Values * * The index only contains the following character classes: - * Lu Letter, Uppercase - * Ll Letter, Lowercase - * Lt Letter, Titlecase - * Lo Letter, Other - * Nd Number, Decimal Digit - * No Number, Other + * Lu Letter, Uppercase + * Ll Letter, Lowercase + * Lt Letter, Titlecase + * Lo Letter, Other + * Nd Number, Decimal Digit + * No Number, Other + * + * Copied from search.module's PREG_CLASS_SEARCH_EXCLUDE. */ define('PREG_CLASS_ALNUM', '\x{0}-\x{2f}\x{3a}-\x{40}\x{5b}-\x{60}\x{7b}-\x{bf}\x{d7}\x{f7}\x{2b0}-'. @@ -46,12 +53,14 @@ define('PREG_CLASS_ALNUM', '\x{ff65}\x{ff70}\x{ff9e}\x{ff9f}\x{ffe0}-\x{fffd}'); /** - * Check to see if there is already an alias pointing to a different item + * Check to see if there is already an alias pointing to a different item. * - * @param string $alias - * A string alias (i.e. dst) - * @param string $src - * A string that is the internal path + * @param $alias + * A string alias (i.e. dst). + * @param $src + * A string that is the internal path. + * @return + * TRUE if an alias exists, FALSE if not. */ function _pathauto_alias_exists($alias, $src) { $alias_pid = db_result(db_query("SELECT pid FROM {url_alias} WHERE dst = '%s' AND src <> '%s'", $alias, $src, 0, 1)); @@ -67,10 +76,14 @@ function _pathauto_alias_exists($alias, } /** - * Returns old alias and pid if there is already an alias pointing to a different item + * Returns old alias and pid if there is already an alias + * pointing to a different item. * - * @param string $src - * A string that is the internal path + * @param $src + * A string that is the internal path. + * @return + * An array with the keys "pid" and "old_alias" containing + * the "pid" and old "alias", respectively, of the old alias. */ function _pathauto_existing_alias_data($src) { $output = array( @@ -99,10 +112,16 @@ function _pathauto_existing_alias_data($ } /** - * Clean up a string value provided by a module, resulting in a - * string containing only alphanumerics and separators + * Clean up a string value provided by a module. + * + * Resulting string contains only alphanumerics and separators. + * * @param $string * A string to clean. + * @param $clean_slash + * Whether to clean slashes from the given string. + * @return + * The cleaned string. */ function pathauto_cleanstring($string, $clean_slash = TRUE) { // Default words to ignore @@ -191,25 +210,25 @@ function pathauto_cleanstring($string, $ } /** - * Apply patterns to create an alias + * Apply patterns to create an alias. * * @param $module - * The name of your module (e.g., 'node') + * The name of your module (e.g., 'node'). * @param $op - * Operation being performed on the content being aliased ('insert', - * 'update', or 'bulkupdate') + * Operation being performed on the content being aliased + * ('insert', 'update', or 'bulkupdate'). * @param $placeholders * An array whose keys consist of the translated placeholders * which appear in patterns (e.g., t('[title]')) and values are the - * actual values to be substituted into the pattern (e.g., $node->title) + * actual values to be substituted into the pattern (e.g., $node->title). * @param $src - * The "real" URI of the content to be aliased (e.g., "node/$node->nid") + * The "real" URI of the content to be aliased (e.g., "node/$node->nid"). * @param $type - * For modules which provided patternitems in hook_pathauto(), - * the relevant identifier for the specific item to be aliased (e.g., - * $node->type) + * For modules which provided pattern items in hook_pathauto(), + * the relevant identifier for the specific item to be aliased + * (e.g., $node->type). * @return - * The alias that was created + * The alias that was created. */ function pathauto_create_alias($module, $op, $placeholders, $src, $entity_id, $type = NULL) { if (($op != 'bulkupdate') and variable_get('pathauto_verbose', FALSE) && user_access('notify of path changes')) { @@ -315,12 +334,12 @@ function pathauto_create_alias($module, } /** - * Verifies if the given path is a valid menu callback. + * Verify if the given path is a valid menu callback. + * * Taken from menu_execute_active_handler(). * * @param $path * A string containing a relative path. - * * @return * TRUE if the path already exists. */ @@ -335,10 +354,10 @@ function _pathauto_path_is_callback($pat } /** - * Private function for pathauto to create an alias + * Private function for Pathauto to create an alias. * * @param $src - * The internal path + * The internal path. * @param $dst * The visible externally used path. * @param $pid @@ -392,12 +411,13 @@ function _pathauto_set_alias($src, $dst, } /** - * Generalized function to get tokens across all Pathauto types + * Generalized function to get tokens across all Pathauto types. * * @param $object * A user, node, or category object. * @return - * tokens for that object formatted in the way that Pathauto expects to see them. + * Tokens for that object formatted in the way that + * Pathauto expects to see them. */ function pathauto_get_placeholders($type, $object) { if (function_exists('token_get_values')) { @@ -412,10 +432,12 @@ function pathauto_get_placeholders($type } /** - * Cleans tokens so they are URL friendly + * Clean tokens so they are URL friendly. * - * @param $values - * An array of token values that need to be "cleaned" for use in the URL + * @param $full + * An array of token values that need to be "cleaned" for use in the URL. + * @return + * An array of the cleaned tokens. */ function pathauto_clean_token_values($full) { foreach ($full->values as $key => $value) { @@ -431,9 +453,15 @@ function pathauto_clean_token_values($fu } /** - * Returns an array of arrays for punctuation values keyed by a name - * including the value and a textual description - * Can and should be expanded to include "all" non text punctuation values + * Return an array of arrays for punctuation values. + * + * Returns an array of arrays for punctuation values keyed by a name, including + * the value and a textual description. + * Can and should be expanded to include "all" non text punctuation values. + * + * @return + * An array of arrays for punctuation values keyed by a name, including the + * value and a textual description. */ function pathauto_punctuation_chars() { $punctuation = array(); Index: pathauto.install =================================================================== RCS file: /cvs/drupal-contrib/contributions/modules/pathauto/pathauto.install,v retrieving revision 1.1.4.30 diff -u -p -r1.1.4.30 pathauto.install --- pathauto.install 28 May 2008 10:35:31 -0000 1.1.4.30 +++ pathauto.install 28 May 2008 16:55:32 -0000 @@ -2,7 +2,10 @@ // $Id: pathauto.install,v 1.1.4.30 2008/05/28 10:35:31 freso Exp $ /** - * @file Provides install, updated, and uninstall functions for pathauto. + * @file + * Install, update, and uninstall functions for Pathauto. + * + * @ingroup pathauto */ /** @@ -75,8 +78,7 @@ function pathauto_uninstall() { } /** - * Set the weight a little heavier to allow taxonomy to do its work - * + * Set the weight a little heavier to allow taxonomy to do its work. */ function pathauto_update_1() { $ret = array(); @@ -86,7 +88,8 @@ function pathauto_update_1() { /** * Increase the maximum length of variable names from 48 to 128. - * Copied from DRUPAL-6 sytem_update_6002 per http://drupal.org/node/66795 + * + * Copied from DRUPAL-6 system_update_6002 per http://drupal.org/node/66795 */ function pathauto_update_2() { $ret = array(); @@ -103,7 +106,7 @@ function pathauto_update_2() { } /** - * Delete the pathauto_node_supportsfeeds + * Delete the pathauto_node_supportsfeeds. */ function pathauto_update_3() { // Do nothing, this update was a mistake @@ -111,7 +114,7 @@ function pathauto_update_3() { } /** - * New style naming for the punctuation chars + * New style naming for the punctuation chars. */ function pathauto_update_4() { variable_set('pathauto_punctuation_quotes', variable_get('pathauto_quotes', 0)); @@ -129,7 +132,7 @@ function pathauto_update_5() { } /** - * Remove some variables that are no longer used + * Remove some variables that are no longer used. */ function pathauto_update_6() { $ret = array(); @@ -140,7 +143,7 @@ function pathauto_update_6() { } /** - * Remove the url_alias_extra table which wasn't used + * Remove the url_alias_extra table which wasn't used. */ function pathauto_update_7() { $ret = array(); Index: pathauto.module =================================================================== RCS file: /cvs/drupal-contrib/contributions/modules/pathauto/pathauto.module,v retrieving revision 1.44.4.93 diff -u -p -r1.44.4.93 pathauto.module --- pathauto.module 28 May 2008 10:35:31 -0000 1.44.4.93 +++ pathauto.module 28 May 2008 16:55:32 -0000 @@ -2,7 +2,24 @@ // $Id: pathauto.module,v 1.44.4.93 2008/05/28 10:35:31 freso Exp $ /** - * Implementation of hook_help + * @defgroup pathauto Pathauto: Automatically generates aliases for content + * + * The Pathauto module automatically generates path aliases for various kinds of + * content (nodes, categories, users) without requiring the user to manually + * specify the path alias. This allows you to get aliases like + * /category/my-node-title.html instead of /node/123. The aliases are based upon + * a "pattern" system which the administrator can control. + */ + +/** + * @file + * Main file for the Pathauto module, which automatically generates aliases for content. + * + * @ingroup pathauto + */ + +/** + * Implementation of hook_help(). */ function pathauto_help($section) { switch ($section) { @@ -26,14 +43,14 @@ function pathauto_help($section) { } /** - * Implementation of hook_perm + * Implementation of hook_perm(). */ function pathauto_perm() { return array('administer pathauto', 'notify of path changes'); } -/* - * Implementation of hook_menu +/** + * Implementation of hook_menu(). */ function pathauto_menu($may_cache) { $items = array(); @@ -61,7 +78,7 @@ function pathauto_menu($may_cache) { } /** - * Include all pathauto include files. + * Include all Pathauto include files. */ function _pathauto_include() { $pathauto_path = drupal_get_path('module', 'pathauto'); @@ -354,9 +371,19 @@ function pathauto_admin_settings() { } /** - * Helper function to see if they are using all -raw tokens available + * Helper function for pathauto_admin_settings(). * - * Returns a status flag if there is an error or not + * See if they are using all -raw tokens available + * and if all the tokens are valid in the given context. + * + * @param $pattern + * A string containing the pattern to be tested. + * @param $type + * A flag indicating the class of substitution tokens to use. + * @return + * A status flag, telling whether there is an error or not. + * @see token_get_list() + * For more information on the $type parameter. */ function _pathauto_check_pattern($pattern, $type) { // Hold items we've warned about so we only warn once per token @@ -407,6 +434,9 @@ function _pathauto_check_pattern($patter return $return; } +/** + * Validate pathauto_admin_settings form submissions. + */ function pathauto_admin_settings_validate($form_id, $form_values) { // Validate that the separator is not set to be removed per http://drupal.org/node/184119 // This isn't really all that bad so warn, but still allow them to save the value. @@ -423,7 +453,7 @@ function pathauto_admin_settings_validat } /** - * Implementation of hook_token_values() for Pathauto specific tokens + * Implementation of hook_token_values() for Pathauto specific tokens. */ function pathauto_token_values($type, $object = NULL) { if (module_exists('taxonomy')) { @@ -492,7 +522,7 @@ function pathauto_token_values($type, $o } /** - * Implementation of hook_token_list() for Pathauto specific tokens + * Implementation of hook_token_list() for Pathauto specific tokens. */ function pathauto_token_list($type = 'all') { $tokens = array(); @@ -517,7 +547,7 @@ function pathauto_token_list($type = 'al } /** - * Menu callback: select certain alias types to delete + * Menu callback: select certain alias types to delete. */ function pathauto_admin_delete() { /* TODO: @@ -572,7 +602,7 @@ function pathauto_admin_delete() { } /** - * Submit handler for the bulk delete form + * Process pathauto_admin_delete form submissions. */ function pathauto_admin_delete_submit($form_id, $form_values) { foreach ($form_values as $key => $value) { @@ -591,6 +621,11 @@ function pathauto_admin_delete_submit($f return 'admin/build/path/delete_bulk'; } +/** + * Implementation of hook_path_alias_types(). + * + * Used primarily by the bulk delete form. + */ function pathauto_path_alias_types() { $objects = array('user/' => t('users'), 'node/' => t('content')); if (module_exists('blog')) { @@ -696,6 +731,9 @@ function pathauto_node_operations() { /** * Callback function for updating node aliases. + * + * @param $nodes + * Array of node nid's. */ function pathauto_node_operations_update($nodes) { foreach ($nodes as $nid) { @@ -707,6 +745,7 @@ function pathauto_node_operations_update //============================================================================== // Taxonomy related functions. + /** * Implementation of hook_taxonomy(). */ @@ -750,7 +789,7 @@ function pathauto_taxonomy($op, $type, $ // User related functions. /** - * Implementation of hook_user() for users, trackers, and blogs + * Implementation of hook_user() for users, trackers, and blogs. */ function pathauto_user($op, &$edit, &$user, $category = FALSE) { _pathauto_include(); Index: pathauto_node.inc =================================================================== RCS file: /cvs/drupal-contrib/contributions/modules/pathauto/pathauto_node.inc,v retrieving revision 1.29.4.29 diff -u -p -r1.29.4.29 pathauto_node.inc --- pathauto_node.inc 28 May 2008 10:35:31 -0000 1.29.4.29 +++ pathauto_node.inc 28 May 2008 16:55:32 -0000 @@ -1,8 +1,15 @@ 0 AND src IS NULL"; @@ -103,7 +110,7 @@ function user_pathauto_bulkupdate() { } /** - * Bulk generate aliases for all blogs without aliases + * Bulk generate aliases for all blogs without aliases. */ function blog_pathauto_bulkupdate() { $query = "SELECT uid, name, src, dst FROM {users} LEFT JOIN {url_alias} ON CONCAT('blog/', CAST(uid AS CHAR)) = src WHERE uid > 0 AND src IS NULL"; @@ -125,7 +132,7 @@ function blog_pathauto_bulkupdate() { } /** - * Bulk generate aliases for user trackers without aliases + * Bulk generate aliases for user trackers without aliases. */ function tracker_pathauto_bulkupdate() { // We do the double CONCAT because Pgsql8.1 doesn't support more than three arguments to CONCAT