Public Method Details |
pxdb_typesfield |
public void pxdb_typesfield([ integer $id ])
|
|
|
Parameter |
|
integer |
$id |
= >>null<< |
|
The id of typesfield row. |
|
Returns |
void |
|
read |
public void read()
|
|
|
Returns |
void |
|
load |
public void load()
|
|
Warning: documentation is missing.
|
Returns |
void |
|
get_id |
public void get_id()
|
|
|
Returns |
void |
|
set_id |
public void set_id(integer $id)
|
|
|
Parameter |
|
|
Returns |
void |
|
get_typeid |
public integer get_typeid()
|
|
|
Returns |
integer |
|
set_typeid |
public void set_typeid(integer $typeid)
|
|
|
Parameter |
|
|
Returns |
void |
|
get_relid |
public integer get_relid()
|
|
|
Returns |
integer |
|
set_relid |
public void set_relid(integer $relid)
|
|
|
Parameter |
|
|
Returns |
void |
|
get_otype |
public string get_otype()
|
|
Returns a comma-separated string of related content types (datatypes), so even if you expect only one value to be returned, assume it's a string and check for multiple values.
|
Returns |
string Related datatype or comma-separated list of related datatypes. |
|
set_otype |
public void set_otype(string $otype)
|
|
The argument is a comma-separated string of related content types (datatypes), so don't pass an array if you have multiple content types.
|
Parameter |
|
string |
$otype |
|
|
Related datatype or comma-separated list of related datatypes. |
|
Returns |
void |
|
get_fieldid |
public integer get_fieldid()
|
|
(for non-relationship typesfields, even multiple picks that use the pickrel table)
|
Returns |
integer |
|
set_fieldid |
public void set_fieldid(integer $fieldid)
|
|
(for non-relationship typesfields, even multiple picks that use the pickrel table)
|
Parameter |
|
|
Returns |
void |
|
get_displayname |
public string get_displayname()
|
|
|
Returns |
string |
|
set_displayname |
public void set_displayname(string $displayname)
|
|
|
Parameter |
|
|
Returns |
void |
|
get_description |
public string get_description()
|
|
|
Returns |
string |
|
set_description |
public void set_description(string $description)
|
|
|
Parameter |
|
|
Returns |
void |
|
get_identifier |
public string get_identifier()
|
|
Used to generate accessor function names in autogenerated classes, among other things.
|
Returns |
string |
|
set_identifier |
public void set_identifier(string $identifier)
|
|
Used to generate accessor function names in autogenerated classes, among other things.
|
Parameter |
|
|
Returns |
void |
|
get_autogen |
public string get_autogen()
|
|
|
Returns |
string |
|
set_autogen |
public void set_autogen(string $autogen)
|
|
|
Parameter |
|
|
Returns |
void |
|
get_validator |
public string get_validator()
|
|
|
Returns |
string |
|
set_validator |
public void set_validator(string $validator)
|
|
|
Parameter |
|
|
Returns |
void |
|
get_processor |
public string get_processor()
|
|
|
Returns |
string |
|
set_processor |
public void set_processor(string $processor)
|
|
|
Parameter |
|
|
Returns |
void |
|
get_widget |
public string get_widget()
|
|
|
Returns |
string |
|
set_widget |
public void set_widget(string $widget)
|
|
|
Parameter |
|
|
Returns |
void |
|
get_mul |
public string get_mul()
|
|
|
Returns |
string 'Y' or 'N' |
|
set_mul |
public void set_mul(string $mul)
|
|
|
Parameter |
|
|
Returns |
void |
|
get_req |
public string get_req()
|
|
|
Returns |
string 'Y' or 'N' |
|
set_req |
public void set_req(string $req)
|
|
|
Parameter |
|
|
Returns |
void |
|
get_unique |
public string get_unique()
|
|
|
Returns |
string 'Y' or 'N' |
|
set_unique |
public void set_unique(string $unique)
|
|
|
Parameter |
|
string |
$unique |
|
|
'Y' or 'N' |
|
Returns |
void |
|
get_is_unique |
public string get_is_unique()
|
|
Sheesh.
|
Returns |
string 'Y' or 'N' |
|
set_is_unique |
public void set_is_unique(string $unique)
|
|
Sheesh.
|
Parameter |
|
string |
$unique |
|
|
'Y' or 'N' |
|
Returns |
void |
|
is_multiple |
public boolean is_multiple()
|
|
|
Returns |
boolean |
|
is_required |
public boolean is_required()
|
|
|
Returns |
boolean |
|
is_unique |
public boolean is_unique()
|
|
|
Returns |
boolean |
|
get_field_type |
public string get_field_type()
|
|
|
Returns |
string The field type (either 'relationship' or 'simple') |
|
get_field_metatype |
public string get_field_metatype()
|
|
Determined by the dbfield it uses unless it's a relationship.
|
Returns |
string the Field metatype (e.g. 'ltxt', 'url', 'primaryrel') |
|
arr_available_dbfields |
public array arr_available_dbfields([ string $mask, string $constraint_sql ])
|
|
|
Parameter |
|
string |
$mask |
= >>''<< |
|
The mask to use for fname column. |
|
|
string |
$constraint_sql |
= >>null<< |
|
WHERE-clause SQL to constrain results. |
|
Returns |
array id ,fname of dbfields records found. |
|
get_related_datatypes |
public array get_related_datatypes(integer $relid)
|
|
By convention the dt2 column contains the "related" datatypes. This can include the current datatype if it is so-specified in the relationships table. This has changed now to be for a relid and datatype, if the dt is in dt1, return the dt2 column , if that is empty look in dt2 and return dt1 column
|
Parameter |
|
|
Returns |
array An array of datatypes that are related to current datatype by specified relid. |
|
arr_available_relationships |
public array arr_available_relationships([ string $mask, string $constraint_sql ])
|
|
Also will make sure that relationships define current datatype as dt1 -- since convention is that dt1 is the source object and dt2 is the related object. If you want the relationship to be bi-directional (i.e. you can choose the relationship from either object) then make sure that you define it as such.
|
Parameter |
|
string |
$mask |
= >>''<< |
|
The mask to use for description column. |
|
|
string |
$constraint_sql |
= >>null<< |
|
WHERE-clause SQL to constrain results. |
|
Returns |
array hash of relationships records found. |
|
save |
public integer save()
|
|
|
Returns |
integer ID of newly created or saved record. |
|
delete |
public boolean delete( $id)
|
|
|
Parameter |
|
|
$id |
|
|
Warning: documentation is missing. |
|
Returns |
boolean true /false on success. |
|
get_all_privs |
public array get_all_privs()
|
|
|
Returns |
array Array of privs hash. |
|
get_user_privs |
public Array get_user_privs()
|
|
|
Returns |
Array (2-D) name=>user name, ugid => user id, priv => user privs. |
|
get_group_privs |
public Array get_group_privs()
|
|
|
Returns |
Array (2-D) name=>group name, ugid => group id, priv => group privs.' |
|
revoke_priv |
public boolean revoke_priv( $ugid, $priv)
|
|
By default it uses values in $_imported array, but can also be passed parameters -- for revoking privilegs internally.
|
Parameter |
|
|
$ugid |
|
|
Warning: documentation is missing. |
|
|
|
$priv |
|
|
Warning: documentation is missing. |
|
Returns |
boolean True or False (with warnings) |
|
move |
public void move(string $dir)
|
|
Changes the orderby column for typesfields rows.
Warning: documentation is missing.
|
Parameter |
|
string |
$dir |
|
|
Direction ('up', 'down') to move. |
|
Returns |
void |
|
reorder |
public void reorder()
|
|
Warning: documentation is missing.
|
Returns |
void |
|
is_readable |
public boolean is_readable(object pxdb_user $user)
|
|
|
Parameter |
|
|
Returns |
boolean |
|