Textpattern PHP Cross Reference Content Management Systems

Summary: /textpattern/include/txp_prefs.php - 833 lines - 24531 bytes - Source - Print

Description: Preferences panel user interface and interaction.

Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 21 functions

prefs_save()
prefs_list()
pref_func()
text_input()
pref_longtext_input()
gmtoffset_select()
is_dst()
logging()
permlinkmodes()
commentmode()
weeks()
dateformats()
permlink_format()
prod_levels()
default_event()
commentsendmail()
custom_set()
themename()
doctypes()
defaultPublishStatus()
real_max_upload_size()

Functions

Functions that are not part of a class:

prefs_save()  line: 54
Commits prefs to the database.

prefs_list($message = '')  line: 147
Renders the list of preferences.

Plugins may add their own prefs, for example by using plugin lifecycle events
or raising a (pre) callback on event=admin / step=prefs_list so they are
installed or updated when accessing the Preferences panel. Access to the
prefs can be controlled by using add_privs() on 'prefs.your-prefs-event-name'.

param: string $message The feedback / error string to display
pref_func($func, $name, $val, $size = '')  line: 328
Calls a core or custom function to render a preference input widget.

return: string HTML
param: string $func Callable in a string presentation
param: string $name HTML name/id of the input control
param: string $val  Initial (or current) value of the input control
param: int    $size Size of the input control (width or depth, dependent on control)
text_input($name, $val, $size = 0)  line: 354
Renders a HTML <input> element.

return: string HTML
param: string $name HTML name and id of the text box
param: string $val  Initial (or current) content of the text box
param: int    $size Width of the textbox. Options are INPUT_MEDIUM | INPUT_SMALL | INPUT_XSMALL
pref_longtext_input($name, $val, $size = '')  line: 381
Renders a HTML <textarea> element.

return: string HTML
param: string $name HTML name of the textarea
param: string $val  Initial (or current) content of the textarea
param: int    $size Number of rows the textarea has
gmtoffset_select($name, $val line: 395
Renders a HTML <select> list of cities for timezone selection.

Can be altered by plugins via the 'prefs_ui > gmtoffset'
pluggable UI callback event.

return: string HTML
param: string $name HTML name of the list
param: string $val  Initial (or current) selected option
is_dst($name, $val line: 421
Renders a HTML choice for whether Daylight Savings Time is in effect.

Can be altered by plugins via the 'prefs_ui > is_dst'
pluggable UI callback event.

return: string HTML
param: string $name HTML name of the widget
param: string $val  Initial (or current) selected item
logging($name, $val line: 473
Renders a HTML <select> list of hit logging options.

return: string HTML
param: string $name HTML name and id of the list
param: string $val  Initial (or current) selected item
permlinkmodes($name, $val line: 492
Renders a HTML <select> list of supported permanent link URL formats.

return: string HTML
param: string $name HTML name and id of the list
param: string $val  Initial (or current) selected item
commentmode($name, $val line: 515
Renders a HTML choice of comment popup modes.

return: string HTML
param: string $name HTML name and id of the widget
param: string $val  Initial (or current) selected item
weeks($name, $val line: 533
Renders a HTML <select> list of comment popup modes.

Can be altered by plugins via the 'prefs_ui > weeks'
pluggable UI callback event.

return: string HTML
param: string $name HTML name and id of the widget
param: string $val  Initial (or current) selected item
dateformats($name, $val line: 561
Renders a HTML <select> list of available ways to display the date.

Can be altered by plugins via the 'prefs_ui > dateformats'
pluggable UI callback event.

return: string HTML
param: string $name HTML name and id of the widget
param: string $val  Initial (or current) selected item
permlink_format($name, $val line: 626
Renders a HTML <select> list of content permlink options.

return: string HTML
param: string $name HTML name and id of the widget
param: string $val  Initial (or current) selected item
prod_levels($name, $val line: 644
Renders a HTML <select> list of site production status.

return: string HTML
param: string $name HTML name and id of the widget
param: string $val  Initial (or current) selected item
default_event($name, $val line: 663
Renders a HTML <select> list of available panels to show immediately
after login.

return: string HTML
param: string $name HTML name of the widget
param: string $val  Initial (or current) selected item
commentsendmail($name, $val line: 695
Renders a HTML <select> list of sendmail options.

return: string HTML
param: string $name HTML name and id of the widget
param: string $val  Initial (or current) selected item
custom_set($name, $val line: 714
Renders a HTML custom field.

Can be altered by plugins via the 'prefs_ui > custom_set'
pluggable UI callback event.

return: string HTML
param: string $name HTML name of the widget
param: string $val  Initial (or current) content
themename($name, $val line: 731
Renders a HTML <select> list of installed admin-side themes.

Can be altered by plugins via the 'prefs_ui > theme_name'
pluggable UI callback event.

return: string HTML
param: string $name HTML name and id of the widget
param: string $val  Initial (or current) selected item
doctypes($name, $val line: 760
Renders a HTML <select> list of available public site markup schemes to
adhere to.

return: string HTML
param: string $name HTML name and id of the widget
param: string $val  Initial (or current) selected item
defaultPublishStatus($name, $val line: 779
Renders a HTML <select> list of available publishing
status values.

return: string HTML
param: string $name HTML name and id of the widget
param: string $val  Initial (or current) selected item
real_max_upload_size($user_max line: 793
Gets the maximum allowed file upload size.

Computes the maximum acceptable file size to the application if the
user-selected value is larger than the maximum allowed by the current PHP
configuration.

return: int Actual value; the lower of user-supplied value or system-defined value
param: int $user_max Desired upload size supplied by the administrator

title

Body