PHP Class Falcon_Admin, Falcon

Inheritance: extends Falcon_Autohooker
ファイルを表示 Open project: rmccue/Falcon Class Usage Examples

Protected Properties

Property Type Description
$registered_handler_settings
$wipe_handler_options boolean When the handler is changed, we can't keep the same handler-specific options saved, so this flag ensures that we wipe the data.

Public Methods

Method Description
admin_page ( ) Print the content
ajax_handler_section ( ) Handle an AJAX request for the handler section
bootstrap ( ) Bootstrap the class
handle_save_on_network ( ) Handle option saving in the network admin
init ( ) Initialization
network_settings_errors ( )
register_handler_settings_fields ( $group, $section, $handler_type = null, $current = null ) Notify the handler to register handler-specific options
register_menu ( ) Add our menu item
settings_field_from ( ) Print field for the reply-to address
settings_field_replyto ( ) Print field for the reply-to address
settings_field_send_async ( ) Print field for the Send to Author checkbox
settings_field_send_to_author ( ) Print field for the Send to Author checkbox
settings_field_type ( ) Print field for the handler type
settings_section_handler ( )
settings_section_main ( ) Print description for the main settings section
validate_from_email ( string $input ) : string Validate the reply-to address
validate_handler_options ( $input ) Validate the handler-specific options via the handler's methods
validate_replyto ( string $input ) : string Validate the reply-to address
validate_send_async ( string $input ) : string Validate the Send to Author checkbox
validate_send_to_author ( string $input ) : string Validate the Send to Author checkbox
validate_type ( string $input ) : string | boolean Validate the handler type

Method Details

admin_page() public static method

Print the content
public static admin_page ( )

ajax_handler_section() public static method

Handle an AJAX request for the handler section
public static ajax_handler_section ( )

bootstrap() public static method

Ensures all necessary hooks are added
public static bootstrap ( )

handle_save_on_network() public static method

Alas, the network admin doesn't include an options handler, so we need to use our own here isntead.
public static handle_save_on_network ( )

init() public static method

Initialization
public static init ( )

network_settings_errors() public static method

public static network_settings_errors ( )

register_handler_settings_fields() public static method

Notify the handler to register handler-specific options
See also: self::init()
public static register_handler_settings_fields ( $group, $section, $handler_type = null, $current = null )

register_menu() public static method

Add our menu item
public static register_menu ( )

settings_field_from() public static method

Print field for the reply-to address
See also: self::init()
public static settings_field_from ( )

settings_field_replyto() public static method

Print field for the reply-to address
See also: self::init()
public static settings_field_replyto ( )

settings_field_send_async() public static method

Print field for the Send to Author checkbox
See also: self::init()
public static settings_field_send_async ( )

settings_field_send_to_author() public static method

Print field for the Send to Author checkbox
See also: self::init()
public static settings_field_send_to_author ( )

settings_field_type() public static method

Print field for the handler type
See also: self::init()
public static settings_field_type ( )

settings_section_handler() public static method

public static settings_section_handler ( )

settings_section_main() public static method

Print description for the main settings section
See also: self::init()
public static settings_section_main ( )

validate_from_email() public static method

Ensures that the reply-to address is a valid formattable email address
public static validate_from_email ( string $input ) : string
$input string New reply-to address
return string Updated reply-to address if valid, otherwise the old address

validate_handler_options() public static method

Validate the handler-specific options via the handler's methods
See also: self::init()
public static validate_handler_options ( $input )

validate_replyto() public static method

Ensures that the reply-to address is a valid formattable email address
public static validate_replyto ( string $input ) : string
$input string New reply-to address
return string Updated reply-to address if valid, otherwise the old address

validate_send_async() public static method

Validate the Send to Author checkbox
public static validate_send_async ( string $input ) : string
$input string
return string

validate_send_to_author() public static method

Validate the Send to Author checkbox
public static validate_send_to_author ( string $input ) : string
$input string
return string

validate_type() public static method

Ensures that the selected type can actually be selected
public static validate_type ( string $input ) : string | boolean
$input string Selected class name
return string | boolean Selected class name if valid, otherwise false

Property Details

$registered_handler_settings protected_oe static_oe property

protected static $registered_handler_settings

$wipe_handler_options protected_oe static_oe property

When the handler is changed, we can't keep the same handler-specific options saved, so this flag ensures that we wipe the data.
protected static bool $wipe_handler_options
return boolean