BAOBAB
CO_Owner Class Reference
Inheritance diagram for CO_Owner:
Collaboration diagram for CO_Owner:

Public Member Functions

 __construct ( $in_db_object=NULL, $in_db_result=NULL)
 
 load_from_db ( $in_db_result)
 
- Public Member Functions inherited from A_CO_DB_Table_Base
 set_batch_mode ()
 
 clear_batch_mode ()
 
 id ()
 
 lock ()
 
 locked ()
 
 danger_will_robinson_danger_clear_id ()
 
 user_can_read ()
 
 user_can_write ()
 
 set_read_security_id ($in_new_id)
 
 set_write_security_id ($in_new_id)
 
 set_name ($in_new_value)
 
 delete_from_db ()
 
 update_db ()
 
 reload_from_db ()
 
 get_access_object ()
 
 get_lang ()
 
 set_lang ( $in_lang_id=NULL)
 
- Public Member Functions inherited from tCO_Owner
 adopt_child ( $in_object_to_own)
 
 count ()
 
 children_ids ()
 
 children ()
 
 generic_search ( $in_search_parameters=NULL, $page_size=0, $initial_page=0, $and_writeable=false, $count_only=false, $ids_only=false)
 

Additional Inherited Members

- Public Attributes inherited from A_CO_DB_Table_Base
 $class_description
 This is a description of the class (not the instance). More...
 
 $instance_description
 This is a description that describes the instance. More...
 
 $last_access
 This is a UNIX epoch date that describes the last modification. The default is UNIX Day Two (in case of UTC timezone issues). More...
 
 $name
 This is the "object_name" string field. More...
 
 $read_security_id
 This is a single integer, defining the security ID required to view the record. If it is 0, then it is "open.". More...
 
 $write_security_id
 This is a single integer, defining the required security token to modify the record. If it is 0, then any logged-in user can modify. More...
 
 $context
 This is a mixed associative array, containing fields for the object. More...
 
 $error
 If there is an error, it is contained here, in a LGV_Error instance. More...
 
- Public Attributes inherited from tCO_Owner
 $my_owner_id = NULL
 This is the ID We will use for the "owner." If left NULL, then the instance ID is used instead. More...
 
- Protected Member Functions inherited from A_CO_DB_Table_Base
 _default_setup ()
 
 _build_parameter_array ()
 
 _badger_serialize ( $in_data)
 
 _badger_unserialize ( $in_data)
 
 _write_to_db ()
 
 _seppuku ()
 
- Protected Attributes inherited from A_CO_DB_Table_Base
 $_db_object
 This is the actual database object that "owns" this instance. It should not be exposed beyond this class or subclasses, thereof. More...
 
 $_id
 This is the within-table unique ID of this record. More...
 
 $_batch_mode
 If this is true, then the write_record call will not be made in update_db. It will be done when clear_batch_mode() is called, instead. More...
 
- Protected Attributes inherited from tCO_Owner
 $_cached_ids = NULL
 This will contain our "owned" IDs after we load. More...
 

Detailed Description

Definition at line 34 of file co_owner.class.php.

Constructor & Destructor Documentation

◆ __construct()

CO_Owner::__construct (   $in_db_object = NULL,
  $in_db_result = NULL 
)

Constructor (Initializer)

< Forces a cache load.

Parameters
$in_db_objectThe database object for this instance.
$in_db_resultThe database row for this instance (associative array, with database keys).

Reimplemented from A_CO_DB_Table_Base.

Definition at line 41 of file co_owner.class.php.

44  {
45  parent::__construct($in_db_object, $in_db_result);
46  $this->class_description = "This is an 'Owner' Class for general items.";
47  $this->children_ids();

Member Function Documentation

◆ load_from_db()

CO_Owner::load_from_db (   $in_db_result)

This function sets up this instance, according to the DB-formatted associative array passed in.

Returns
true, if the instance was able to set itself up to the provided array.
Parameters
$in_db_resultThis is an associative array, formatted as a database row response.

Reimplemented from A_CO_DB_Table_Base.

Definition at line 55 of file co_owner.class.php.

57  {
58  $ret = parent::load_from_db($in_db_result);
59 
60  $this->class_description = "This is an 'Owner' Class for general items.";
61  $this->instance_description = $this->name;
$name
This is the "object_name" string field.