tco_collection.interface.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_classes_class_dir().'/co_ll_location.class.php');
 
/***************************************************************************************************************************/
trait tCO_Collection {
    protected $_container;      
    
    /***********************/
    protected function _scrub() {
        if (isset($this->context['children_ids'])) {
            $children_ids = $this->context['children_ids'];
        
            if (isset($children_ids) && is_array($children_ids) && count($children_ids)) {
                $new_ids = Array();
                foreach ($children_ids as $id) {
                    $id = intval($id); // Belt and suspenders.
                    if ($this->get_access_object()->item_exists($id)) {
                        $new_ids[] = $id;
                    }
                }
                $new_ids = array_unique($new_ids);
                sort($new_ids);
                $this->context['children_ids'] = $new_ids;
                $this->update_db();
            }
        } else {
            $this->_container = Array();
        }
    }
    
    /***********************/
    protected function _set_up_container() {
        if (isset($this->context['children_ids'])) {
            $children_ids = $this->context['children_ids'];
        
            if (isset($children_ids) && is_array($children_ids) && count($children_ids)) {
                $this->_container = $this->get_access_object()->get_multiple_data_records_by_id($children_ids);
            }
        }
    }
    
    /***********************/
    public function reload_collection() {
        $this->_scrub();    // Garbage collection.
        $this->_set_up_container();
    }
    
    /***********************/
    public function insertElement(  $in_element,            
                                    $in_before_index = -1,  
                                    $dont_update = false    
                                ) {
        $ret = false;
        
        if ($in_element instanceof A_CO_DB_Table_Base) {
            if ($this->user_can_write() ) { // You cannot add to a collection if you don't have write privileges.
                if (!(method_exists($in_element, 'insertElement') && $this->areYouMyDaddy($in_element))) {   // Make sure that a collection isn't already in the woodpile somewhere.
                    $id = intval($in_element->id());
                    if (!isset($this->_container) || !is_array($this->_container)) {
                        $this->_container = [];
                    }
                
                    if (!isset($this->context['children_ids']) || !is_array($this->context['children_ids'])) {
                        $this->context['children_ids'] = [];
                    }
                    
                    if (!in_array($id, $this->context['children_ids'])) {
                        if ((-1 == $in_before_index) || (NULL == $in_before_index) || !isset($in_before_index)) {
                            $in_before_index = count($this->_container);
                        }
                
                        $before_array = Array();
                
                        if ($in_before_index) {
                            $before_array = array_slice($this->_container, 0, $in_before_index, false);
                        }
                
                        $after_array = Array();
                
                        if ($in_before_index < count($this->_container)) {
                            $end_count = count($this->_container) - $in_before_index;
                            $after_array = array_slice($this->_container, $end_count, false);
                        }
                
                        $element_array = Array($in_element);
                
                        $merged = array_merge($before_array, $element_array, $after_array);
                
                        $this->_container = $merged;
                
                        $ret = true;
                        if (!isset($this->context['children_ids'])) {
                            $this->context['children_ids'] = Array();
                        }
                
                        $ids = array_map('intval', $this->context['children_ids']);
                        if (!in_array($id, $ids)) {
                            $ids[] = $id;
                            $ids = array_unique($ids);
                            sort($ids);
                            $this->context['children_ids'] = $ids;
                        }
                    }
                }
        
                if ($ret && !$dont_update) {
                    $ret = $this->update_db();
                }
            } else {
                $this->error = new LGV_Error(   CO_CHAMELEON_Lang_Common::$co_collection_error_code_user_not_authorized,
                                                CO_CHAMELEON_Lang::$co_collection_error_name_user_not_authorized,
                                                CO_CHAMELEON_Lang::$co_collection_error_desc_user_not_authorized);
            }
        }
        
        return $ret;
    }
    
    /***********************/
    public function insertElements( $in_element_array,      
                                    $in_before_index = -1   
                                ) {
        $ret = false;
        
        if ($this->user_can_write() ) { // You cannot add to a collection if you don't have write privileges.
            $i_have_a_daddy = false;
            
            if (is_array($in_element_array) && count($in_element_array)) {
                foreach ($in_element_array as $element) {
                    // We can't insert nested collections.
                    if (method_exists($element, 'insertElement') && $this->areYouMyDaddy($element)) {
                        $i_have_a_daddy = true;
                        break;
                    }
                }
            }
            
            if (!$i_have_a_daddy) { // DON'T CROSS THE STREAMS!
                if (!isset($this->_container) || !is_array($this->_container)) {
                    $this->_container = Array();
                }
                
                if ((-1 == $in_before_index) || (NULL == $in_before_index) || !isset($in_before_index)) {
                    $in_before_index = count($this->_container);
                }
                
                $before_array = Array();
                
                if ($in_before_index) {
                    $before_array = array_slice($this->_container, 0, $in_before_index, false);
                }
                
                $after_array = Array();
                
                if ($in_before_index < count($this->_container)) {
                    $end_count = count($this->_container) - $in_before_index;
                    $after_array = array_slice($this->_container, $end_count, false);
                }
                
                if (!isset($in_element_array) || !is_array($in_element_array) || !count($in_element_array)) {
                    $in_element_array = [];
                }
                
                $merged = array_merge($before_array, $in_element_array, $after_array);
                
                $unique  = array();
                
                if (is_array($merged) && count($merged)) {
                    foreach ($merged as $current) {
                        if (!in_array($current, $unique)) {
                            $unique[] = $current;
                        }
                    }
                }
                
                $this->_container = $unique;
                
                $ret = true;
            
                if (!isset($this->context['children_ids'])) {
                    $this->context['children_ids'] = Array();
                }
                
                foreach ($in_element_array as $element) {
                    $id = intval($element->id());
                    $ids = array_map('intval', $this->context['children_ids']);
                    if (!in_array($id, $ids)) {
                        $ids[] = $id;
                        $ids = array_unique($ids);
                        sort($ids);
                        $this->context['children_ids'] = $ids;
                    }
                }
            }
        
            if ($ret) {
                $ret = $this->update_db();
            }
        } else {
            $this->error = new LGV_Error(   CO_CHAMELEON_Lang_Common::$co_collection_error_code_user_not_authorized,
                                            CO_CHAMELEON_Lang::$co_collection_error_name_user_not_authorized,
                                            CO_CHAMELEON_Lang::$co_collection_error_desc_user_not_authorized);
        }
        
        return $ret;
    }
    
    /***********************/
    public function deleteElements( $in_first_index,    
                                    $in_deletion_length 
                                ) {
        $ret = false;
        
        if ($this->user_can_write() ) { // You cannot add to a collection if you don't have write privileges.
            $element_ids = Array(); // We will keep track of which IDs we delete, so we can delete them from our context variable.
            
            // If negative, we're going backwards.
            if (0 > $in_deletion_length) {
                $in_deletion_length = abs($in_deletion_length);
                $in_first_index -= ($in_deletion_length - 1);
                $in_first_index = max(0, $in_first_index);  // Make sure we stay within the lane markers.
            }
            
            $last_index_plus_one = min(count($this->_container), $in_first_index + $in_deletion_length);
        
            // We simply record the IDs of each of the elements we'll be deleting.
            for ($i = $in_first_index; $i < $last_index_plus_one; $i++) {
                $element = $this->_container[$i];
                $element_ids[] = $element->id();
            }
            
            if ($in_deletion_length == count($element_ids)) {  // Belt and suspenders. Make sure we are actually deleting the requested elements.
                $new_container = Array();
                
                // We build a new container that doesn't have the deleted elements.
                foreach ($this->_container as $element) {
                    $element_id = $element->id();
                    
                    if (!in_array($element_id, $element_ids)) {
                        $new_container[] = $element_id;
                    }
                }
                
                $new_list = Array();
                
                // We build a new list that doesn't have the deleted element IDs.
                while ($element_id = array_shift($this->context['children_ids'])) {
                    if (!in_array($element_id, $element_ids)) {
                        $new_list[] = $element_id;
                    }
                }
                
                $new_list = array_unique($new_list);
                sort($new_list);
                $this->context['children_ids'] = $new_list;
                
                $ret = $this->update_db();
                if (!$this->_batch_mode) {
                    $this->_scrub();
                }
            }
        } else {
            $this->error = new LGV_Error(   CO_CHAMELEON_Lang_Common::$co_collection_error_code_user_not_authorized,
                                            CO_CHAMELEON_Lang::$co_collection_error_name_user_not_authorized,
                                            CO_CHAMELEON_Lang::$co_collection_error_desc_user_not_authorized);
        }
        
        return $ret;
    }
    
    /***********************/
    public function deleteElement(  $in_index   
                                ) {
        return $this->deleteElements($in_index, 1);
    }
    
    /***********************/
    public function deleteThisElement(  $in_element 
                                    ) {
        $ret = false;
        $index = $this->indexOfThisElement($in_element);
        
        if (false !== $index) {
            $ret = $this->deleteElement(intval($index));
        }
        
        return $ret;
    }
        
    /***********************/
    public function appendElement(  $in_element             
                                ) {
        return $this->insertElement($in_element, -1);
    }
    
    /***********************/
    public function appendElements( $in_element_array       
                                ) {
        return $this->insertElements($in_element_array, -1);
    }
    
    /***********************/
    public function deleteAllChildren() {
        if ($this->user_can_write() ) { // You cannot delete from a collection if you don't have write privileges.
            $new_list = [];
        
            if (isset($this->context['children_ids']) && is_array($this->context['children_ids']) && count($this->context['children_ids'])) {
                foreach ($this->context['children_ids'] as $child_id) {
                    // We save items in the list that we can't see.
                    if ($this->get_access_object()->item_exists($child_id) && !$this->get_access_object()->can_i_see_this_data_record($child_id)) {
                        $new_list[] = $child_id;
                    }
                }
            }
        
            $this->_children = Array();
            $this->context['children_ids'] = $new_list;
            return $this->update_db();
        }
        
        return false;
    }
    
    /***********************/
    public function indexOfThisElement(  $in_element    
                                        ) {
        return array_search($in_element, $this->children());
    }
    
    /***********************/
    public function whosYourDaddy(  $in_element 
                                ) {
        $ret = NULL;
        $id = intval($in_element->id());
        
        $ret_array = $this->recursiveMap(function($instance, $hierarchy_level, $parent){
                $id = intval($instance->id());
                return Array($id, $parent);
            });
        
        if (isset($ret_array) && is_array($ret_array) && count($ret_array)) {
            $ret = Array();
            foreach ($ret_array as $item) {
                if ($item[0] == $id) {
                    $ret[] = $item[1];
                }
            }
        }
        
        return $ret;
    }
    
    /***********************/
    public function areYouMyDaddy(  $in_element,            
                                    $full_hierachy = true   
                                ) {
        $ret = false;
        
        $children = $this->children();
        
        if (isset($children) && is_array($children) && count($children)) {
            foreach ($children as $object) {
                if ($object == $in_element) {
                    $ret = true;
                    break;
                } else {
                    if ($full_hierachy && method_exists($object, 'areYouMyDaddy')) {
                        if ($object->areYouMyDaddy($in_element)) {
                            $ret = true;
                            break;
                        }
                    }
                }
            }
        }
        
        return $ret;
    }
        
    /***********************/
    public function map(    $in_function    
                        ) {
        $ret = Array();
        
        $children = $this->children();
        
        foreach ($children as $child) {
            $result = $in_function($child);
            $ret[] = $result;
        }
        
        return self::class;
    }
    
    /***********************/
    public function recursiveMap(   $in_function,               
                                    $in_hierarchy_level = 0,    
                                    $in_parent_object = NULL,   
                                    $loop_stopper = Array()     
                                ) {
        $in_hierarchy_level = intval($in_hierarchy_level);
        $ret = Array($in_function($this, $in_hierarchy_level, $in_parent_object));
        $children = $this->children();
        
        foreach ($children as $child) {
            if (method_exists($child, 'recursiveMap')) {
                if (!in_array($child->id(), $loop_stopper)) {
                    $loop_stopper[] = $child->id();
                    $result = $child->recursiveMap($in_function, ++$in_hierarchy_level, $this, $loop_stopper);
                }
            } else {
                $result = Array($in_function($child, ++$in_hierarchy_level, $this));
            }
            $ret = array_merge($ret, $result);
        }
        
        return $ret;
    }
    
    /***********************/
    public function count(  $is_recursive = false   
                        ) {
        $children = $this->children();
        $my_count = 0;
        
        if (isset($children) && is_array($children)) {
            $my_count = count($children);
        
            if ($is_recursive) {
                foreach ($children as $child) {
                    if (method_exists($child, 'count')) {
                        $my_count += $child->count($is_recursive);
                    }
                }
            }
        }
        
        return $my_count;
    }
    
    /***********************/
    public function children() {
        if (!isset($this->_container) || !$this->_container || (!count($this->_container))) {
            $this->_scrub();
            $this->_set_up_container();
        }
        return $this->_container;
    }
    
    /***********************/
    public function children_ids(   $in_raw = false    
                                ) {
        $ret = [];
        if ($in_raw && $this->get_access_object()->god_mode()) {   // God gets it all.
            if (isset($this->context['children'])) {
                return (array_map('intval', explode(',', $this->context['children'])));
            } else {
                return [];
            }
        }
        
        $this->_scrub();
        if (isset($this->context['children_ids']) && is_array($this->context['children_ids']) && count ($this->context['children_ids'])) {
            $ids = $this->context['children_ids'];
            if ($this->get_access_object()->god_mode()) {   // God gets it all.
                $ret = $ids;
            } else {
                foreach ($ids as $id) {
                    if ($this->get_access_object()->item_exists($id, true)) {
                        $ret[] = intval($id);
                    }
                }
            }
        }
        
        return $ret;
    }
        
    /***********************/
    public function set_children_ids(   $in_new_ids 
                                    ) {
        $ret = false;
        
        if ($this->get_access_object()->god_mode()) {
            $this->_children = Array();
            $this->context['children'] = implode(',', $in_new_ids);
            unset($this->context['children_ids']);
            $ret = $this->update_db();
        }
        
        return $ret;
    }
 
    /***********************/
    public function who_are_my_parents() {
        $ret = [];
        
        $result = $this->get_access_object()->generic_search(Array('access_class' => Array('%_Collection%', 'use_like' => 1)));
        
        if (isset($result) && is_array($result) && count($result)) {
            foreach ($result as $object) {
                if (($object instanceof CO_Main_DB_Record) && method_exists($object, 'areYouMyDaddy')) {
                    if ($object->areYouMyDaddy($this, false)) {
                        $ret[] = $object;
                    }
                }
            }
        }
        
        return $ret;
    }
    
    /***********************/
    public function getHierarchy(   $loop_stopper = Array()     
                                    ) {
        $this->_scrub();
        
        $instance = Array('object' => $this);
        
        if (method_exists($this, 'children') && count($this->children())) {
            $children = $this->children();
            $instance['children'] = Array();
        
            foreach ($children as $child) {
                if (method_exists($child, 'getHierarchy')) {
                    if (!in_array($child->id(), $loop_stopper)) {
                        $loop_stopper[] = $child->id();
                        $instance['children'][] = $child->getHierarchy($loop_stopper);
                    }
                } else {
                    $instance['children'][] = Array('object' => $child);
                }
            }
        }
        
        return $instance;
    }
}