co_user_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.
 
CO_Config::require_extension_class('tco_collection.interface.php');
require_once(CO_Config::db_class_dir().'/co_main_db_record.class.php');
 
$lang = CO_Config::$lang;
 
global $g_lang_override;    // This allows us to override the configured language at initiation time.
 
if (isset($g_lang_override) && $g_lang_override && file_exists(CO_Config::lang_class_dir().'/'.$g_lang_override.'.php')) {
    $lang = $g_lang_override;
}
 
$lang_file = CO_Config::badger_lang_class_dir().'/'.$lang.'.php';
$lang_common_file = CO_Config::badger_lang_class_dir().'/common.inc.php';
 
if ( !defined('LGV_LANG_CATCHER') ) {
    define('LGV_LANG_CATCHER', 1);
}
 
require_once($lang_file);
require_once($lang_common_file);
 
/***************************************************************************************************************************/
class CO_User_Collection extends CO_LL_Location {
    use tCO_Collection; // These are the built-in collection methods.
 
    private $_login_object = NULL;  
 
    /***********************/
    protected function _load_login() {
        $ret = false;
        // Tag 0 contains the ID of the user login (in the security DB) for this user.
        $login_id = isset($this->tags()[0]) ? intval($this->tags()[0]) : 0;
        
        if (0 < $login_id) {
            $my_login_object = $this->get_access_object()->get_single_security_record_by_id($login_id);
            
            if (isset($my_login_object) && ($my_login_object instanceof CO_Security_Login)) {
                $this->_login_object = $my_login_object;
                $ret = true;
            } elseif (!($my_login_object instanceof CO_Security_Login)) {
                $this->error = new LGV_Error(   CO_CHAMELEON_Lang_Common::$user_error_code_invalid_class,
                                                CO_CHAMELEON_Lang::$user_error_name_invalid_class,
                                                CO_CHAMELEON_Lang::$user_error_desc_invalid_class,
                                                __FILE__,
                                                __LINE__,
                                                __METHOD__
                                            );
            } else {
                $this->error = new LGV_Error(   CO_CHAMELEON_Lang_Common::$user_error_code_user_not_authorized,
                                                CO_CHAMELEON_Lang::$user_error_name_user_not_authorized,
                                                CO_CHAMELEON_Lang::$user_error_desc_user_not_authorized,
                                                __FILE__,
                                                __LINE__,
                                                __METHOD__
                                            );
            }
        } else {
            $this->error = new LGV_Error(   CO_CHAMELEON_Lang_Common::$user_error_code_invalid_id,
                                            CO_CHAMELEON_Lang::$user_error_name_invalid_id,
                                            CO_CHAMELEON_Lang::$user_error_desc_invalid_id,
                                            __FILE__,
                                            __LINE__,
                                            __METHOD__
                                        );
        }
        
        return $ret;
    }
    
    /***********************************************************************************************************************/
    /***********************/
    public function __construct(    $in_db_object = NULL,   
                                    $in_db_result = NULL,   
                                    $in_owner_id = NULL,    
                                    $in_tags_array = NULL   
                                ) {
        
        $this->_container = Array();
        $this->_login_object = NULL;
        
        parent::__construct($in_db_object, $in_db_result, $in_owner_id, $in_tags_array);
        
        $this->class_description = "This is a 'Collection' Class for Users.";
    }
    
    /***********************/
    public function load_from_db(   $in_db_result   
                                    ) {
        $ret = parent::load_from_db($in_db_result);
        
        $this->class_description = "This is a 'Collection' Class for Users.";
     
        $this->_set_up_container();
    }
    
    /***********************/
    public function get_login_instance() {
        if (!($this->_login_object instanceof CO_Security_Login)) {
            $this->_load_login();
        }
        
        return $this->_login_object;
    }
    
    /***********************/
    public function has_login() {
        return (intval($this->tags()[0]) > 0);
    }
    
    /***********************/
    public function has_login_i_cant_see() {
        $this->get_login_instance();
        return (!($this->_login_object instanceof CO_Security_Login) && (isset($this->tags()[0]) && intval($this->tags()[0])));
    }
    
    /***********************/
    public function is_god() {
        $tags = $this->tags();
        
        return isset($tags) && is_array($tags) && count($tags) && (0 < intval($tags[0])) && (intval($tags[0]) == CO_Config::god_mode_id());
    }
    
    /***********************/
    public function is_manager() {
        if (!$this->is_god() && !isset($this->_login_object)) {
            $this->_load_login();
        }
 
        return $this->is_god() || (isset($this->_login_object) && ($this->_login_object instanceof CO_Login_Manager));
    }
    
    /***********************/
    public function set_tags(   $in_tags_array  
                            ) {
        $ret = false;
        
        if (isset($in_tags_array) && is_array($in_tags_array) && count($in_tags_array) && (11 > count($in_tags_array))) {
            // We cannot assign a user we don't have write permissions for
            $id_pool = $this->get_access_object()->get_security_ids();
            $tag0 = intval($in_tags_array[0]);
            if ($this->get_access_object()->god_mode() || ((isset($id_pool) && is_array($id_pool) && count($id_pool) && ((0 == $tag0) || in_array($tag0, $id_pool))))) {
                $ret = parent::set_tags($in_tags_array);
            }
        }
        
        return $ret;
    }
    
    /***********************/
    public function set_tag(    $in_tag_index,  
                                $in_tag_value   
                            ) {
        $ret = false;
        
        $in_tag_index = intval($in_tag_index);
        
        if ((10 > $in_tag_index) && $this->user_can_write()) {
            // We cannot assign a user we don't have write permissions for
            $id_pool = $this->get_access_object()->get_security_ids();
            if ($this->get_access_object()->god_mode() || ((isset($id_pool) && is_array($id_pool) && count($id_pool) && ((0 <= $in_tag_index) || in_array(intval($in_tag_value), $id_pool))))) {
                $ret = parent::set_tag($in_tag_index, $in_tag_value);
            }
        }
        
        return $ret;
    }
    
    /***********************/
    public function get_surname() {
        return isset($this->_tags[1]) ? $this->_tags[1] : '';
    }
    
    /***********************/
    public function set_surname(    $in_surname 
                                ) {
        return $this->set_tag(1, $in_surname);
    }
    
    /***********************/
    public function get_middle_name() {
        return isset($this->_tags[2]) ? $this->_tags[2] : '';
    }
    
    /***********************/
    public function set_middle_name(    $in_middle_name 
                                ) {
        return $this->set_tag(2, $in_middle_name);
    }
    
    /***********************/
    public function get_given_name() {
        return isset($this->_tags[3]) ? $this->_tags[3] : '';
    }
    
    /***********************/
    public function set_given_name( $in_given_name 
                                    ) {
        return $this->set_tag(3, $in_given_name);
    }
    
    /***********************/
    public function get_prefix() {
        return isset($this->_tags[4]) ? $this->_tags[4] : '';
    }
    
    /***********************/
    public function set_prefix( $in_prefix  
                                ) {
        return $this->set_tag(4, $in_prefix);
    }
    
    /***********************/
    public function get_suffix() {
        return isset($this->_tags[5]) ? $this->_tags[5] : '';
    }
    
    /***********************/
    public function set_suffix( $in_suffix  
                                ) {
        return $this->set_tag(5, $in_suffix);
    }
    
    /***********************/
    public function get_nickname() {
        return isset($this->_tags[6]) ? $this->_tags[6] : '';
    }
    
    /***********************/
    public function set_nickname(   $in_nickname    
                                ) {
        return $this->set_tag(6, $in_nickname);
    }
    
    /***********************/
    public function set_login(  $in_login_id_integer    
                                ) {
        $ret = parent::user_can_write();
        $in_login_id_integer = intval($in_login_id_integer);
        // Further check to make sure that the current login is a manager.
        if ($ret && ($this->get_access_object()->god_mode() || ($this->get_access_object()->get_login_item() instanceof CO_Login_Manager))) {
            $login_item = $this->get_access_object()->get_login_item($in_login_id_integer);
            
            if ((0 == $in_login_id_integer) || ($login_item instanceof CO_Security_Login)) {
                $tag0 = (0 == $in_login_id_integer) ? NULL : strval(intval($in_login_id_integer));
                
                $ret = $this->set_tag(0, $tag0);
                
                if ($ret) { // Make sure that we'll get a fresh login next time.
                    $this->_login_object = NULL;
                }
            }
        } else {
            $this->error = new LGV_Error(   CO_CHAMELEON_Lang_Common::$user_error_code_user_not_authorized,
                                            CO_CHAMELEON_Lang::$user_error_name_user_not_authorized,
                                            CO_CHAMELEON_Lang::$user_error_desc_user_not_authorized,
                                            __FILE__,
                                            __LINE__,
                                            __METHOD__
                                        );
        }
        
        return $ret;
    }
    
    /***********************/
    public function get_lang() {
        $ret = parent::get_lang();
        
        if (!isset($this->context['lang'])) {
            $login_object = $this->get_login_instance();
            if (isset($login_object) && ($login_object instanceof CO_Security_Login)) {
                $ret = $login_object->get_lang();
            }
        }
        
        return $ret;
    }
    
    /***********************/
    public function delete_from_db( $with_extreme_prejudice = false,    
                                    $delete_login_object_too = 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();
                }
            }
        }
        
        // Again, we won't return false if this fails, but we will fetch the error.
        if ($delete_login_object_too) {
            $login_object = $this->get_login_instance();
        
            if (isset($login_object) && $login_object->user_can_write()) {
                $login_object->delete_from_db();
                $this->error = $login_object->error;
            }
        }
        
        return parent::delete_from_db();
    }
};