co_collection.class.php

Go to the documentation of this file.

<?php
/***************************************************************************************************************************/
defined( 'LGV_DBF_CATCHER' ) or die ( 'Cannot Execute Directly' );  // Makes sure that this file is in the correct context.
 
require_once(CO_Config::db_class_dir().'/co_main_db_record.class.php');
CO_Config::require_extension_class('tco_collection.interface.php');
 
/***************************************************************************************************************************/
class CO_Collection extends CO_LL_Location {
    use tCO_Collection; // These are the built-in collection methods.
    
    /***********************************************************************************************************************/
    /***********************/
    public function __construct(    $in_db_object = NULL,           
                                    $in_db_result = NULL,           
                                    $in_owner_id = NULL,            
                                    $in_tags_array = NULL           
                                ) {
        
        $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.";
    }
 
    /***********************/
    public function load_from_db(   $in_db_result   
                                    ) {
        $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 function delete_from_db( $with_extreme_prejudice = false 
                                    ) {
        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();
    }
};