Esmith::FormMagick::Panel::pseudonyms

From SME Server
Jump to navigationJump to search

NAME

esmith::FormMagick::Panels::pseudonyms - useful panel functions

In a root terminal you can do the command below if you want to display the up-to-date content

perldoc esmith::FormMagick::Panels::pseudonyms

SYNOPSIS

          use esmith::FormMagick::Panels::pseudonyms;

          my $panel = esmith::FormMagick::Panel::pseudonyms->new();
          $panel->display();

DESCRIPTION

new();

Exactly as for esmith::FormMagick

get_cgi_param FM FIELD

Returns the named CGI parameter as a string

get_prop ITEM PROP

A simple accessor for esmith::ConfigDB::Record::prop

get_value ITEM

A simple accessor for esmith::ConfigDB::Record::value

ACTION

performCreatePseudonym

Create a new pseudonym

performModifyPseudonmy

Modify a pseudonym.

existing_accounts

Return a hash of existing system accounts

print_begin_page

Print the initial page of the ofrm

get_pseudonym_account

Returns the current Account property for this pseudonym

is_pseudonym_not_removable

Returns 1 if the current Account is not removable, 0 otherwise is_pseudonym_internal Returns YES if the current Account property Visible is ’internal’

validate_new_pseudonym_name FM PSEUDONYM

Returns "OK" if the pseudonym starts with a letter or number and contains only letters, numbers, . - and _ and isn’t taken

Returns "VALID_PSEUDONYM_NAMES" if the name contains invalid chars

Returns "NAME_IN_USE" if this pseudonym is taken.

validate_is_pseudonym FM NAME

returns "OK" if it is. returns "NOT_A_PSUEDONYM" if the name in question isn’t an existing pseudonym

build_cgi_params()

Builds a CGI query string, using various sensible defaults and esmith::FormMagick’s props_to_query_string() method.

print_hidden_pseudonym_field FM

prints a hidden form field containing the current value of the pseudonym attribute