[ Index ]

PHP Cross Reference of Drupal 6 (yi-drupal)

title

Body

[close]

/sites/all/modules/pathauto/ -> pathauto.inc (summary)

(no description)

File Size: 752 lines (26 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 16 functions

  _pathauto_alias_exists()
  _pathauto_existing_alias_data()
  pathauto_cleanstring()
  _pathauto_clean_separators()
  pathauto_clean_alias()
  pathauto_create_alias()
  _pathauto_path_is_callback()
  _pathauto_set_alias()
  _pathauto_verbose()
  pathauto_get_placeholders()
  pathauto_clean_token_values()
  pathauto_punctuation_chars()
  _pathauto_get_schema_alias_maxlength()
  _pathauto_get_raw_tokens()
  _pathauto_get_i18n_possible_files()
  _pathauto_get_i18n_file()

Functions
Functions that are not part of a class:

_pathauto_alias_exists($alias, $source, $language = '')   X-Ref
Check to see if there is already an alias pointing to a different item.

param: $alias
param: $source
param: $language
return:

_pathauto_existing_alias_data($source, $language = '')   X-Ref
Fetches an existing URL alias given a path and optional language.

param: $source
param: $language
return:

pathauto_cleanstring($string)   X-Ref
Clean up a string segment to be used in an URL alias.

Performs the following possible alterations:
- Remove all HTML tags.
- Process the string through the transliteration module.
- Replace or remove punctuation with the separator character.
- Remove back-slashes.
- Replace non-ascii and non-numeric characters with the separator.
- Remove common words.
- Replace whitespace with the separator character.
- Trim duplicate, leading, and trailing separators.
- Convert to lower-case.
- Shorten to a desired length and logical position based on word boundaries.

This function should *not* be called on URL alias or path strings because it
is assumed that they are already clean.

param: $string
return:

_pathauto_clean_separators($string, $separator = NULL)   X-Ref
Trims duplicate, leading, and trailing separators from a string.

param: $string
param: $separator
return:

pathauto_clean_alias($alias)   X-Ref
Clean up an URL alias.

Performs the following alterations:
- Trim duplicate, leading, and trailing back-slashes.
- Trim duplicate, leading, and trailing separators.
- Shorten to a desired length and logical position based on word boundaries.

param: $alias
return:

pathauto_create_alias($module, $op, $placeholders, $source, $entity_id, $type = NULL, $language = '')   X-Ref
Apply patterns to create an alias.

param: $module
param: $op
param: $placeholders
param: $source
param: $entity_id
param: $type
param: $language
return:

_pathauto_path_is_callback($path)   X-Ref
Verify if the given path is a valid menu callback.

Taken from menu_execute_active_handler().

param: $path
return:

_pathauto_set_alias($path, $existing_alias = NULL, $op = NULL)   X-Ref
Private function for Pathauto to create an alias.

param: $path
param: $existing_alias
param: $op
return:

_pathauto_verbose($message = NULL, $op = NULL)   X-Ref
Output a helpful message if verbose output is enabled.

Verbose output is only enabled when:
- The 'pathauto_verbose' setting is enabled.
- The current user has the 'notify of path changes' permission.
- The $op parameter is anything but 'bulkupdate' or 'return'.

param: $message
param: $op
return:

pathauto_get_placeholders($type, $object)   X-Ref
Generalized function to get tokens across all Pathauto types.

param: $object
return:

pathauto_clean_token_values($full, $options = array()   X-Ref
Clean tokens so they are URL friendly.

param: $full
return:

pathauto_punctuation_chars()   X-Ref
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:

_pathauto_get_schema_alias_maxlength()   X-Ref
Fetch the maximum length of the {url_alias}.dst field from the schema.

return:

_pathauto_get_raw_tokens()   X-Ref
Fetch an array of non-raw tokens that have matching raw tokens.

return:

_pathauto_get_i18n_possible_files()   X-Ref
Return all the possible paths of the i18n-ascii.txt transliteration file.

return:

_pathauto_get_i18n_file()   X-Ref
Fetch the path to the i18n-ascii.txt transliteration file

return:



Generated: Mon Jul 9 18:01:44 2012 Cross-referenced by PHPXref 0.7