Inheritance diagram for CO_Collection:

Collaboration diagram for CO_Collection:

Public Member Functions
	__construct ( $in_db_object=NULL, $in_db_result=NULL, $in_owner_id=NULL, $in_tags_array=NULL)

	load_from_db ( $in_db_result)

	delete_from_db ( $with_extreme_prejudice=false)

Public Member Functions inherited from CO_LL_Location
	__construct ( $in_db_object=NULL, $in_db_result=NULL, $in_owner_id=NULL, $in_tags_array=NULL, $in_longitude=NULL, $in_latitude=NULL, $in_fuzz_factor=NULL, $in_can_see_through_the_fuzz=NULL)

	update_db ()

	set_longitude ( $in_new_value)

	set_latitude ( $in_new_value)

	fuzz_factor ()

	is_fuzzy ()

	set_fuzz_factor ( $in_new_value)

	raw_longitude ()

	raw_latitude ()

	longitude ()

	latitude ()

	set_can_see_through_the_fuzz ( $in_id)

	can_see_through_the_fuzz ()

	i_can_see_clearly_now ()

Public Member Functions inherited from CO_Main_DB_Record
	set_owner_id ( $in_new_id)

	set_tags ( $in_tags_array)

	set_tag ( $in_tag_index, $in_tag_value)

	get_payload ()

	set_payload ( $in_payload)

	owner_id ()

	tags ()

Public Member Functions inherited from A_CO_DB_Table_Base
	__construct ( $in_db_object=NULL, $in_db_result=NULL)

	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 ()

	reload_from_db ()

	get_access_object ()

	get_lang ()

	set_lang ( $in_lang_id=NULL)

Public Member Functions inherited from tCO_Collection
	reload_collection ()

	insertElement ( $in_element, $in_before_index=-1, $dont_update=false)

	insertElements ( $in_element_array, $in_before_index=-1)

	deleteElements ( $in_first_index, $in_deletion_length)

	deleteElement ( $in_index)

	deleteThisElement ( $in_element)

	appendElement ( $in_element)

	appendElements ( $in_element_array)

	deleteAllChildren ()

	indexOfThisElement ( $in_element)

	whosYourDaddy ( $in_element)

	areYouMyDaddy ( $in_element, $full_hierachy=true)

	map ( $in_function)

	recursiveMap ( $in_function, $in_hierarchy_level=0, $in_parent_object=NULL, $loop_stopper=Array())

	count ( $is_recursive=false)

	children ()

	children_ids ( $in_raw=false)

	set_children_ids ( $in_new_ids)

	who_are_my_parents ()

	getHierarchy ( $loop_stopper=Array())

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...

Static Public Attributes inherited from CO_Main_DB_Record
static	$s_table_name = 'co_data_nodes'

Protected Member Functions inherited from CO_LL_Location
	_default_setup ()

	_build_parameter_array ()

	_km_per_degree ()

	_fuzz_me ()

Protected Member Functions inherited from A_CO_DB_Table_Base
	_badger_serialize ( $in_data)

	_badger_unserialize ( $in_data)

	_write_to_db ()

	_seppuku ()

Protected Member Functions inherited from tCO_Collection
	_scrub ()

	_set_up_container ()

Protected Attributes inherited from CO_LL_Location
	$_longitude

	$_latitude

Protected Attributes inherited from CO_Main_DB_Record
	$_owner_id

	$_tags

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_Collection
	$_container
	This contains instances of the records referenced by the IDs stored in the object. More...

Detailed Description

This is a generic collection class.

Definition at line 35 of file co_collection.class.php.

Constructor & Destructor Documentation

◆ __construct()

CO_Collection::__construct	(	$in_db_object = `NULL`,
		$in_db_result = `NULL`,
		$in_owner_id = `NULL`,
		$in_tags_array = `NULL`
	)

Constructor (Initializer)

Parameters

$in_db_object	The database object for this instance.
$in_db_result	The database row for this instance (associative array, with database keys).
$in_owner_id	The ID of the object (in the database) that "owns" this instance.
$in_tags_array	The tags to be assigned to this object.

Reimplemented from CO_Main_DB_Record.

Reimplemented in CO_KeyValue_CO_Collection.

Definition at line 42 of file co_collection.class.php.

                                   {
         
         $this->_container = Array();
  
         parent::__construct($in_db_object, $in_db_result, $in_owner_id, $in_tags_array);
         $this->class_description = "This is a 'Generic Collection' Class.";

Member Function Documentation

◆ delete_from_db()

CO_Collection::delete_from_db ( $with_extreme_prejudice = false )

We override this, because we want to see if we can possibly delete children objects.

Returns: true, if the deletion was successful.

Parameters

$with_extreme_prejudice If true (Default is false), then we will attempt to delete all contained children. Remember that this could cause problems if other collections can see the children!

Definition at line 82 of file co_collection.class.php.

                                       {
         if ($with_extreme_prejudice && $this->user_can_write()) {
             // We don't error-check this on purpose, as it's a given that there might be issues, here. This is a "due dilligence" thing.
             $user_items_to_delete = $this->children();
             
             foreach ($user_items_to_delete as $child) {
                 if ($child->user_can_write()) {
                     $child->delete_from_db();
                 }
             }
         }
         
         return parent::delete_from_db();

◆ load_from_db()

CO_Collection::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_result This is an associative array, formatted as a database row response.

Reimplemented from CO_LL_Location.

Reimplemented in CO_KeyValue_CO_Collection.

Definition at line 60 of file co_collection.class.php.

                                       {
         $ret = parent::load_from_db($in_db_result);
         
         if ($ret) {
             $count = 0;
             if (isset($this->context['children_ids']) && is_array($this->context['children_ids'])) {
                 $count = count($this->context['children_ids']);
             }
         
             $this->class_description = "This is a 'Generic Collection' Class.";
             $this->instance_description = isset($this->name) && $this->name ? "$this->name" : "Generic Collection Object";
         }
     
         return $ret;

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ delete_from_db()

◆ load_from_db()