Public Method Details |
&dbh |
public object ADOConnection &dbh([ object [unknown] $new_dbh ])
|
|
DB object is stored as a static variable for this method, so you do not need to instantiate this class to call this method / get the current db being used by the site.
|
Parameter |
|
object [unknown] |
$new_dbh |
= >>null<< |
|
ADOConnection |
|
Returns |
object ADOConnection object |
|
print_debug |
public void print_debug(array $msg, string $type)
|
|
This is a tool used by classes that extend this class.
|
Parameter |
|
array |
$msg |
|
|
, etc) to print. |
|
|
string |
$type |
|
|
Warning: documentation is missing. |
|
Returns |
void |
|
trigger_error |
public void trigger_error(string $error_msg, [ constant $error_type, string $error_src ])
|
|
|
Parameter |
|
|
|
constant |
$error_type |
= >>E_USER_WARNING,<< |
|
|
|
|
string |
$error_src |
= >>null<< |
|
The method name or file name of error origination. |
|
Returns |
void |
|
get_pxdb_tables |
public array get_pxdb_tables()
|
|
This is a static lsit of tables that is set every time this function is called. To add additional "hidden" tables to your Syntax instance, add your tablename(s) as the value of to the pxdb_prefs table -- with pref_name = 'pxdb_table', pref_key = '', pref_value='yourtablname'.
|
Returns |
array Tables that are Syntax tables. |
|
get_nonpxdb_tables |
public array get_nonpxdb_tables()
|
|
Calculates the non-f1db tables by the difference between results from get_f1db_tables() and get_tables() methods.
|
Returns |
array The non-f1db tables. |
|
is_table_created |
public boolean is_table_created(string $table)
|
|
|
Parameter |
|
string |
$table |
|
|
The name of the table we are looking for. |
|
Returns |
boolean |
|
create_pick_table |
public boolean create_pick_table( $table)
|
|
|
Parameter |
|
|
$table |
|
|
Warning: documentation is missing. |
|
Returns |
boolean status |
|
get_pxdb_reserved_fields |
public array get_pxdb_reserved_fields()
|
|
This is a static list of columns that is set every time this function is called. To add additional "hidden" columns to your Syntax instance, add your fieldname(s) as the value of to the pxdb_prefs table -- with pref_name = 'pxdb_field', pref_key = '', pref_value='yourtablname'.
|
Returns |
array Tables that are Syntax tables. |
|
plugin_exists |
public boolean plugin_exists(string $type, string $plugin_data)
|
|
|
Parameter |
|
string |
$type |
|
|
The type of plugin (corresponds to filesystem directory) |
|
|
string |
$plugin_data |
|
|
The plugin name (function name) we are looking for. |
|
Returns |
boolean |
|
get_pxdb_www |
public string get_pxdb_www()
|
|
There could be more than one pxdb_www preference -- the first choice is to find one where the key is the current hostname. For example, we could have the following in the database: - pxdb_www [dbasis.syntax.forumone.com] = "/data/pxdb_www" - pxdb_www [mysite.com] = "/pxdb_live"
|
Returns |
string The best match from preferences table. |
|
register_class |
public boolean register_class(string $user_class, string $pxdb_class, [ integer $option ])
|
|
E.g. you may want to customize an authentication class or use a class that extends the records class. IMPORTANT: It is assumed that the class you are registering has the same constructor signature as PxDB equivalent class. ALSO: not all classes will respect user-registered classes -- e.g. for overhead reasons user-defined metadata data classes cannot be registered.
|
Parameter |
|
string |
$user_class |
|
|
The name of your class (e.g. Document) |
|
|
string |
$pxdb_class |
|
|
The name of the pxdb class you are replacing (e.g. pxdb_record) |
|
|
integer |
$option |
= >>0<< |
|
Any class specific indexing option (i.e. provides ability to register many pxdb_record classes indexed by datatype) |
|
Returns |
boolean Success or failure to register |
|
get_class |
public string get_class(string $pxdb_class, [ mixed $option ])
|
|
If not user-specified class is found, then it will return the pxdb class name.
|
Parameter |
|
|
|
|
Returns |
string Class name to use. |
|
parse_plugin |
public array parse_plugin(string $plugin_data)
|
|
|
Parameter |
|
|
Returns |
array Hash with 'script' and 'params' keys. |
|