Ubuntu Manpages

Octopussy::Search_Template

Octopussy Search Template module

Create a new Search Template

Parameters:

$user - user who create this template \%conf - hashref of the new Search Template configuration

Remove the Search Template '$search_tpl'

Parameters:

$user - user who created this template $search_tpl - Name of the Search Template to remove

Get list of Search Templates

Parameters:

$user - user who created this template

Returns:

@tpls - Array of Search Templates names

Get template name / user List

Parameters:

$sort - selected field to sort List (default: 'name')

Returns:

@sorted_list - Array of Search Templates names for all users

Get the XML filename for the Search Template '$search_tpl'

Parameters:

$user - user who created this template $search_tpl - Name of the Search Template

Returns:

$filename - Filename of the XML file for Search Template '$search_tpl'

Get the configuration for the Search Template '$search_tpl'

Parameters:

$user - user who created this template $search_tpl - Name of the Search Template

Returns:

\%conf - Hashref of the Search Template configuration

Get the configuration for all Search Templates from User $user

Parameters:

$user - user who created this template $sort - selected field to sort configurations

Returns:

@configurations - Array of Hashref Search Template configurations

Checks that '$name' is valid for a Search Template name

Sebastien Thebert <octo.devel@gmail.com>