Docs for page options.php

Description

options.php

Functions needed to display the options pages.

filesource: Source Code for this file
version: $Id: options.php,v 1.66 2006/08/22 18:56:16 stevetruckstuff Exp $
license: GNU Public License
copyright: © 1999-2006 The SquirrelMail Project Team

Classes

Class	Description
SquirrelOption	SquirrelOption: An option for SquirrelMail.

Constants

SMOPT_REFRESH_ALL = 2 (line 33)

SMOPT_REFRESH_FOLDERLIST = 1 (line 32)

SMOPT_REFRESH_NONE = 0 (line 31)

SMOPT_SAVE_DEFAULT = 'save_option' (line 43)

SMOPT_SAVE_NOOP = 'save_option_noop' (line 44)

SMOPT_SIZE_HUGE = 4 (line 40)

SMOPT_SIZE_LARGE = 3 (line 39)

SMOPT_SIZE_MEDIUM = 2 (line 38)

SMOPT_SIZE_NORMAL = 5 (line 41)

SMOPT_SIZE_SMALL = 1 (line 37)

SMOPT_SIZE_TINY = 0 (line 36)

SMOPT_TYPE_BOOLEAN = 5 (line 25)

SMOPT_TYPE_COMMENT = 7 (line 27)

SMOPT_TYPE_FLDRLIST = 8 (line 28)

SMOPT_TYPE_FLOAT = 4 (line 24)

SMOPT_TYPE_HIDDEN = 6 (line 26)

SMOPT_TYPE_INTEGER = 3 (line 23)

SMOPT_TYPE_STRING = 0 (line 20)

*******************************************

SMOPT_TYPE_STRLIST = 1 (line 21)

SMOPT_TYPE_TEXTAREA = 2 (line 22)

Functions

create_hidden_element (line 611)

Create hidden field.

return: html formated hidden input field

string create_hidden_element (string $name, string $value)

string $name: field name
string $value: field value

create_option_groups (line 623)

array create_option_groups (array $optgrps, array $optvals)

array $optgrps
array $optvals

create_optmode_element (line 601)

Create hidden 'optmode' input field with value set by argument

return: html formated hidden input field

string create_optmode_element (string $optmode)

string $optmode

create_optpage_element (line 592)

Create hidden 'optpage' input field with value set by argument

return: html formated hidden input field

string create_optpage_element (string $optpage)

string $optpage: identification of option page

OptionSubmit (line 730)

Create submit button inside table row.

void OptionSubmit (string $name)

string $name

print_option_groups (line 695)

void print_option_groups (array $option_groups)

array $option_groups

save_option (line 570)

Saves option

void save_option (object $option)

object $option: object that holds option name and new_value

save_option_noop (line 583)

save function that does not save

void save_option_noop (object $option)

object $option

/functions/options.php