Main Page | Modules | File List | File Members

Preference settings management


Functions

 links_get_list ($module, &$node, $page=FALSE, $teaser=FALSE)
 links_prefs_is_user_specific ($name, $permission= '')
 links_prefs_get ($name, $default='', $permission='')

Function Documentation

links_get_list module,
&$  node,
page = FALSE,
teaser = FALSE
 

Returns a simple integer-subscripted array with a list of links that should be displayed with a node (this is for use in hook_link() implementations). The $module parameter establishes a context for looking up site settings for how the links are formatted (e.g., title vs. URL, truncation, how many allowed, etc.).

links_prefs_get name,
default = '',
permission = ''
 

Returns the system-wide or user-specific setting for a variable, as appropriate. $name and $permission are defined the same as for links_prefs_user_allowed(). $default is simply the default value to return if this variable is unset.

To obtain the system-wide setting, without respect for user-specific overrides (if applicable), simply use variable_get() from Drupal core.

links_prefs_is_user_specific name,
permission = ''
 

Returns a boolean to indicate whether or not the specified function may be overridden by a user preference, by the current user. If no user preference is allowed for this particular variable (based on the system-wide setting), then always returns false. The application doesn't have to care *why* the setting is disallowed.

To obtain the system-wide setting, without respect for user-specific overrides (if applicable), simply use variable_get() from Drupal core.

Parameters: $name name of the variable to test $permission name of the permission to test, if this variable has different permissions for some roles than for others


Generated on Tue Aug 1 10:19:37 2006 for Drupal Links Package by  doxygen 1.4.4