Docs For Class oops

Methods

Constructor __construct [line 3358]

oops_record __construct(

$type, 
$tablename 
)

Construct a record

Parameters:

	$type:
	$tablename:

API Tags:

Access:

public

Redefined in descendants as:

[ Top ]

cache [line 3490]

void cache(
)

Cache this instance using it's own id

API Tags:

Access:

public

[ Top ]

call_all [line 4018]

array call_all(
)

Call every class-method with a specific name

All the arguments passed to this call are also arguments to the method.

except the first argument is the name of the method to call
the first argument to the method is always an array, which gets passed to the next method call, etc, etc. in the end its returned

API Tags:

Return:	return array or false if there were no classes
Access:	public

[ Top ]

call_best [line 4064]

void call_best(
)

Call the 'best' (latest,highest in the class hierarchy) method

API Tags:

Access:

public

[ Top ]

delete [line 3910]

void delete(
)

Delete the current record

API Tags:

Access:

public

[ Top ]

getLanguageField [line 3922]

void getLanguageField(

$name, [
$language = false] 
)

Built-in language field logica

Parameters:

	$name:
	$language:

API Tags:

Access:

protected

[ Top ]

get_columns [line 3392]

void get_columns(
)

Get the column information from the table

API Tags:

Access:

public

[ Top ]

get_database [line 3627]

void get_database(
)

Get a database resource

API Tags:

Access:

protected

[ Top ]

get_id [line 3613]

void get_id(
)

Get ID of the record

Example:

[[$entry->get_id()]]

API Tags:

Access:

public

[ Top ]

get_jsonp [line 3517]

void get_jsonp(
)

Get the contents of the object in JSON format

API Tags:

Access:

public

Redefined in descendants as:

oops_entry::get_jsonp() : Get the contents of the object in JSON format

[ Top ]

get_no_of_records [line 3798]

void get_no_of_records(
)

Return the number of records

API Tags:

Access:

public

[ Top ]

get_object_vars [line 3456]

void get_object_vars(
)

API Tags:

Access:

public

[ Top ]

get_primarykey_fieldname [line 3383]

void get_primarykey_fieldname(
)

Get the name of the primarykey fieldname

API Tags:

Access:

public

[ Top ]

have_best [line 4049]

void have_best(

$name 
)

Have a 'best' call?

Parameters:

$name:

API Tags:

Access:

public

[ Top ]

load [line 3789]

void load(

$id 
)

Load record by primary key

Parameters:

$id:

API Tags:

Access:

public

[ Top ]

loadall [line 3729]

void loadall(
[
$args = array()] 
)

Load records by a specific field and value

Parameters:

$args:

API Tags:

Access:

public

[ Top ]

loadallby [line 3752]

void loadallby(

$by, 
$value, [
$operator = '='] 
)

Load records by a specific field and value

Parameters:

	$by:
	$value:
	$operator:

API Tags:

Access:

public

[ Top ]

loadby [line 3770]

void loadby(

$by, 
$value, [
$operator = '='] 
)

Load record by a specific field and value

Parameters:

	$by:
	$value:
	$operator:

API Tags:

Access:

public

[ Top ]

loaded [line 3508]

boolean loaded(
)

Returns true if the record has been loaded from a source

Example:

[[if $entry->loaded()]]geladen[[/if]]

API Tags:

Return:	true if the record has been loaded from a source
Access:	public

[ Top ]

mark_as_loaded [line 3474]

void mark_as_loaded(
)

API Tags:

Access:

public

[ Top ]

void register(
)

register this class to the registry

API Tags:

Access:

public

[ Top ]

save [line 3859]

void save(
)

Save the current record

API Tags:

Access:

public

Redefined in descendants as:

oops_content::save() : Save the current record

[ Top ]

search [line 4332]

void search(

$q, [
$params = array()] 
)

Parameters:

	$q:
	$params:

API Tags:

Access:

public

[ Top ]

set_jsonp [line 3529]

void set_jsonp(

$jsonp 
)

Put the contents of the object from a JSON feed

Parameters:

$jsonp:

API Tags:

Access:

public

Redefined in descendants as:

oops_entry::set_jsonp() : Put the contents of the object from a JSON feed

[ Top ]

share_instance [line 3465]

void share_instance(

$vars 
)

Internal call for sharing data between records

Parameters:

$vars:

API Tags:

Access:

public

[ Top ]

smarty_load [line 4262]

void smarty_load(

$params, 
&$smarty 
)

Smarty standard load

A simple basic load call to load a single record.

<dl> <dt>assign</dt><dd>assign result to this variable</dd> <dt>by_column</dt><dd>value must be exactly this value</dd> <dt>eq_column</dt><dd>value must be exactly this value</dd> <dt>ne_column</dt><dd>value must not be this value</dd> <dt>lt_column</dt><dd>value must be less then this value</dd> <dt>lte_column</dt><dd>value must be less than or equal to this value</dd> <dt>gt_column</dt><dd>value must be greater than this value</dd> <dt>gte_column</dt><dd>value must be greater than or equal to this value</dd> <dt>like_column</dt><dd>value must be like this value</dd> <dt>limit</dt><dd>limit the number of results to this value</dd> <dt>order_by</dt><dd>order the results on these columns</dd> <dt>group_by</dt><dd>group the results using these columns</dd> <dt>sql_offset</dt><dd>set the sql offset in the sql statement</dd> <dt>sql_limit</dt><dd>limit the number of results in the sql statement</dd> <dt>random<dt><dd>set to '1' to choose a random result</dd> </dl>

Example:

[[oops_*entry*_load assign='*entry*' by_uid=2]]

Example:

[[oops_*entry*_load assign='*entry*' by_uri='about']]

Parameters:

	$params:
	&$smarty:

API Tags:

Access:

public

[ Top ]

smarty_loadall [line 4305]

void smarty_loadall(

$params, 
&$smarty 
)

Smarty standard load all

A simple basic load call to load specific records.

Example:

[[oops_*entry*_loadall assign='*entry*s']]

Example:

[[oops_*entry*_loadall assign='*entry*s' order_by='publish_date']]

Parameters:

	$params:
	&$smarty:

API Tags:

Access:

public

Redefined in descendants as:

oops_category::smarty_loadall() : Smarty standard loadall
oops_comment::smarty_loadall() : Smarty standard loadall

[ Top ]

smarty_search [line 4386]

void smarty_search(

$params, 
&$smarty 
)

Implements searching

<dl> <dt>q</dt><dd>search string</dd> </dl>

Parameters:

	$params:
	&$smarty:

API Tags:

Access:

public

[ Top ]

type [line 3374]

void type(
)

Get record type

API Tags:

Access:

public

[ Top ]

weigh [line 3947]

void weigh(

$args 
)

A dummy weigh function

Parameters:

$args:

API Tags:

Access:

public

Redefined in descendants as:

oops_content::weigh()

[ Top ]

_smarty_loadall_params [line 4100]

void _smarty_loadall_params(

$params, [
$args = array()] 
)

Default smarty loadall params parsing

Parameters:

	$params:
	$args:

API Tags:

Access:

protected

Redefined in descendants as:

oops_content::_smarty_loadall_params() : Overridden smarty loadall params parsing
oops_entry::_smarty_loadall_params() : Overridden smarty loadall params parsing
oops_page::_smarty_loadall_params() : Overridden smarty loadall params parsing

[ Top ]

__call [line 3961]

void __call(

$name, 
$args 
)

Make method calls to other classes which also descend from the base class

Parameters:

	$name:
	$args:

API Tags:

Access:

public

[ Top ]

__delete [line 3884]

void __delete(
)

Delete the current record

Actual delete call

API Tags:

Access:

public

[ Top ]

__get [line 3581]

void __get(

$name 
)

Internal getter

Parameters:

$name:

API Tags:

Access:

public

Redefined in descendants as:

oops_content::__get() : Handle delayed loading of certain aspects

[ Top ]

__isset [line 3604]

void __isset(

$name 
)

Internal issetter

Parameters:

$name:

API Tags:

Access:

public

[ Top ]

__load [line 3690]

void __load(

$classname, 
$select_sql, 
&$data 
)

Load records as objects via a select sql array

Parameters:

	$classname:
	$select_sql:
	&$data:

API Tags:

Access:

protected

[ Top ]

__load_array [line 3636]

void __load_array(

$select_sql, 
&$data 
)

Load records as arrays via an select sql array or sql string

Parameters:

	$select_sql:
	&$data:

API Tags:

Access:

protected

Redefined in descendants as:

oops_content::__load_array() : Load records via a select sql array

[ Top ]

__save [line 3813]

void __save(

$tablename, 
$primarykey_fieldname, 
&$data 
)

Save an associative array to the database

Parameters:

	$tablename:
	$primarykey_fieldname:
	&$data:

API Tags:

Access:

protected

[ Top ]

__search_records [line 4325]

void __search_records(

$q, [
$params = array()] 
)

Perform a search on the table and weigh/sort the results

Parameters:

	$q:
	$params:

API Tags:

Access:

public

Redefined in descendants as:

oops_content::__search_records() : Perform a search on the table and weigh/sort the results
oops_entry::__search_records() : Perform a search on the table and weigh/sort the results
oops_page::__search_records() : Perform a search on the table and weigh/sort the results

[ Top ]

__set [line 3572]

void __set(

$name, 
$value 
)

Internal setter

Parameters:

	$name:
	$value:

API Tags:

Access:

public

Redefined in descendants as:

oops_content::__set() : Handle URI's in a special way

[ Top ]

__transfer_get [line 3560]

void __transfer_get(

$name 
)

Get the value of a field, but do no conversions on it

Parameters:

$name:

API Tags:

Access:

public

[ Top ]

__transfer_set [line 3546]

void __transfer_set(

$name, 
$value 
)

Set the value of a field, but do no conversions on it

Parameters:

	$name:
	$value:

API Tags:

Access:

public

[ Top ]

__unset [line 3593]

void __unset(

$name 
)

Internal unsetter

Parameters:

$name:

API Tags:

Access:

public

[ Top ]

Class: oops_record

Class oops_record

	pivotx

[ class tree: pivotx ] [ index: pivotx ] [ all elements ]