\Als_Admin_Settings

Als_Admin_Settings.

Summary

Methods
Properties
Constants
add_message()
add_error()
show_messages()
add_menu_page()
show_statistics_page()
show_listings_page()
show_searches()
total_searches()
get_option()
output()
save()
get_settings_pages()
output_fields()
get_field_description()
save_fields()
show_index_details()
No public properties found
No constants found
No protected methods found
No protected properties found
N/A
No private methods found
$settings
$errors
$messages
N/A

Properties

$settings

$settings : array

Setting pages.

Type

array

$errors

$errors : array

Error messages.

Type

array

$messages

$messages : array

Update messages.

Type

array

Methods

add_message()

add_message(string  $text) 

Add a message.

Parameters

string $text

add_error()

add_error(string  $text) 

Add an error.

Parameters

string $text

show_messages()

show_messages() : string

Output messages + errors.

Returns

string

add_menu_page()

add_menu_page() 

Add an admin page

show_statistics_page()

show_statistics_page() 

Display the statistics page

show_listings_page()

show_listings_page() 

Display the sponsored listings page

show_searches()

show_searches(  $conditions = '1=1',   $order_by = 'time DESC',   $limit = 10,   $no_results_msg = false) 

Displays searches based on conditions

Parameters

$conditions

Specific conditions that you need to be used

$order_by
$limit

maximum number of results and an optional offset

$no_results_msg

What message to be displayed incase no results are found

total_searches()

total_searches(  $where = "1=1",   $echo = true) 

Returns Total searches

Parameters

$where

specific conditions to accompany this request

$echo

whether or not to echo the results

get_option()

get_option(mixed  $option_name, mixed  $default = '') : string

Get a setting from the settings API.

Parameters

mixed $option_name

the name of the option to retrieve

mixed $default

the default value of the option name

Returns

string

output()

output() 

Settings page.

Handles the display of the main als settings page in admin.

save()

save() 

Save the settings.

get_settings_pages()

get_settings_pages() 

Include the settings page classes.

output_fields()

output_fields(array  $options) 

Output admin fields.

Loops though the als options array and outputs each field.

Parameters

array $options

Opens array to output

get_field_description()

get_field_description(array  $value) 

Helper function to get the formated description and tip HTML for a given form field. Plugins can call this when implementing their own custom settings types.

Parameters

array $value

The form field value array

save_fields()

save_fields(array  $options) : boolean

Save admin fields.

Parameters

array $options

Returns

boolean

show_index_details()

show_index_details() 

Indexing stuff