Docs For Class Sps

method can_read [line 135]

void can_read(
[
$user_id = 0])

Can a specific user (defaults to the current user) READ from this table?

Parameters:

$user_id

[ Top ]

method can_write [line 146]

void can_write(
[
$user_id = 0])

Can a specific user (defaults to the current user) WRITE from this table?

Parameters:

$user_id

[ Top ]

method conf [line 153]

void conf(
)

Overridden in child classes as:

Sps_RecordData::conf()

Sps_Groups::conf()

Sps_SiteMap::conf()

Sps_Users::conf()

SpsBlogPosts::conf()

SpsBlogCategories::conf()

Sps_GoLog::conf()

Sps_Sequence::conf()

Sps_Tags::conf()

Sps_Table_Dummy::conf()

Sps_Table_SearchMgr::conf()

Sps_Go::conf()

[ Top ]

method delete [line 374]

void delete(
[
$ids = NULL])

Parameters:

array

$ids

[ Top ]

method fetch_item [line 293]

void fetch_item(

$id, [
$form_name = ''])

Parameters:

	$id
	$form_name

[ Top ]

method fetch_item_by_field [line 329]

void fetch_item_by_field(

$field_name, 
$value)

Parameters:

	$field_name
	$value

[ Top ]

method generate_id [line 170]

integer generate_id(
)

Generate a new ID for this table. This calls Sps_Sequence::next_val() to generate the ID.

method get_buttons [line 637]

void get_buttons(
)

[ Top ]

method get_csv [line 856]

void get_csv(
Sps_Form_TableSearch
$form_search, 
$data)

Parameters:

Sps_Form_TableSearch	$form_search
	$data

[ Top ]

method get_dbh [line 158]

void get_dbh(
)

[ Top ]

method get_field_definition [line 932]

void get_field_definition(

$field_name)

Parameters:

$field_name

[ Top ]

method get_field_definitions [line 958]

void get_field_definitions(
[
$form_name = "main"])

Parameters:

$form_name

[ Top ]

method get_form [line 207]

void get_form(
[
$form_name = "main"], [
&$data = NULL])

Construct a form object, and optionally prepopulate it with data.

Parameters:

	$form_name
array	&$data

[ Top ]

method get_form_definition [line 903]

void get_form_definition(
[
$form_name = "main"])

Parameters:

$form_name

[ Top ]

method get_form_email [line 983]

void get_form_email(
[
&$data = NULL])

Parameters:

array

&$data

[ Top ]

method get_form_search [line 1048]

void get_form_search(
[
&$data = NULL], [
$form_name = "main"])

Parameters:

array	&$data
	$form_name

[ Top ]

method get_id [line 198]

void get_id(
Sps_Form
&$form)

Simply call Sps_Form::get_field_value() on the primary key field.

Parameters:

Sps_Form

&$form

[ Top ]

method get_index_search_name [line 125]

void get_index_search_name(
)

Conceal the search form

[ Top ]

method get_link_definition [line 945]

void get_link_definition(

$link_name)

Parameters:

$link_name

[ Top ]

method get_name [line 128]

void get_name(
)

[ Top ]

method get_record_name [line 257]

void get_record_name(
Sps_Form
&$form)

Overridden in child classes as:

Sps_Groups::get_record_name()

Sps_SiteMap::get_record_name()

Sps_Users::get_record_name()

SpsBlogPosts::get_record_name()

SpsBlogCategories::get_record_name()

Sps_Go::get_record_name()

Parameters:

Sps_Form

&$form

[ Top ]

method get_simple_table [line 742]

void get_simple_table(
Sps_Form_TableSearch
$form_search, 
$data)

Overridden in child classes as:

Sps_SiteMap::get_simple_table()

Parameters:

Sps_Form_TableSearch	$form_search
	$data

[ Top ]

method insert [line 453]

void insert(
Sps_Form
&$form)

Parameters:

Sps_Form

&$form

[ Top ]

method merge [line 417]

void merge(
[
&$ids = NULL])

Parameters:

array

&$ids

[ Top ]

method process_form_email [line 1003]

void process_form_email(
Sps_Form
&$email_form, Sps_Form
&$data_form)

Parameters:

Sps_Form	&$email_form
Sps_Form	&$data_form

[ Top ]

method record_exists [line 268]

void record_exists(

$id)

Parameters:

$id

[ Top ]

method remove_field_definition [line 921]

void remove_field_definition(

$field_name)

Parameters:

$field_name

[ Top ]

method save [line 356]

void save(
Sps_Form
&$form)

Overridden in child classes as:

Sps_Users::save()

Calls the parent save() function, but:

Before saving, validates that the two passwords are the same
After saving, updates the password.

Sps_Table_Dummy::save()

Sps_Table_SearchMgr::save()

Parameters:

Sps_Form

&$form

[ Top ]

method search [line 1103]

void search(
Sps_Form_TableSearch
&$form_search)

Parameters:

Sps_Form_TableSearch

&$form_search

[ Top ]

method search_get_links [line 1061]

void search_get_links(
Sps_Form_TableSearch
&$form_search, Sps_Form
&$form)

Parameters:

Sps_Form_TableSearch	&$form_search
Sps_Form	&$form

[ Top ]

method set_id [line 183]

integer set_id(
Sps_Form
&$form, [
$id = 0], Sps_Form
$form)

Set the ID for the form. Looks first in $_POST, then in $_GET, then generates a new ID.

Tags:

return:

The ID assigned.

Parameters:

Sps_Form	$form	The appropriate field (primary key) for this form will have set_value() set.
Sps_Form	&$form
	$id

[ Top ]

method set_index_search_name [line 126]

void set_index_search_name(

$name)

Parameters:

$name

[ Top ]

method set_name [line 129]

void set_name(

$name)

Parameters:

string

$name

[ Top ]

method update [line 548]

void update(
Sps_Form
&$form)

Parameters:

Sps_Form

&$form

[ Top ]

Class: Sps_Table

Class Overview

Methods

Child classes:

Inherited Methods

Class: Sps

Class Details

Class Methods

method can_read [line 135]

Parameters:

method can_write [line 146]

Parameters:

method conf [line 153]

method delete [line 374]

Parameters:

method fetch_item [line 293]

Parameters:

method fetch_item_by_field [line 329]

Parameters:

method generate_id [line 170]

Tags:

method get_buttons [line 637]

method get_csv [line 856]

Parameters:

method get_dbh [line 158]

method get_field_definition [line 932]

Parameters:

method get_field_definitions [line 958]

Parameters:

method get_form [line 207]

Parameters:

method get_form_definition [line 903]

Parameters:

method get_form_email [line 983]

Parameters:

method get_form_search [line 1048]

Parameters:

method get_id [line 198]

Parameters:

method get_index_search_name [line 125]

method get_link_definition [line 945]

Parameters:

method get_name [line 128]

method get_record_name [line 257]

Parameters:

method get_simple_table [line 742]

Parameters:

method insert [line 453]

Parameters:

method merge [line 417]

Parameters:

method process_form_email [line 1003]

Parameters:

method record_exists [line 268]

Parameters:

method remove_field_definition [line 921]

Parameters:

method save [line 356]

Parameters:

method search [line 1103]

Parameters:

method search_get_links [line 1061]

Parameters:

method set_id [line 183]

Tags:

Parameters:

method set_index_search_name [line 126]

Parameters:

method set_name [line 129]

Parameters:

method update [line 548]

Parameters: