co_keyvalue_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(dirname(__FILE__).'/co_collection.class.php');
 
/***************************************************************************************************************************/
class CO_KeyValue_CO_Collection extends CO_Collection {
    
    /***********************************************************************************************************************/
    /***********************/
    public function __construct(    $in_db_object = NULL,   
                                    $in_db_result = NULL,   
                                    $in_key = NULL,         
                                    $in_value = NULL        
                                ) {
        parent::__construct($in_db_object, $in_db_result);
        $this->class_description = "This is a class for doing \"key/value\" storage.";
        
        if (NULL != $in_key) {
            $this->set_key($in_key, $value);
        } elseif (NULL != $in_value) {
            $this->set_value($in_key, $value);
        }
    }
 
    /***********************/
    public function load_from_db(   $in_db_result   
                                    ) {
        $ret = parent::load_from_db($in_db_result);
        
        if ($ret) {
            $this->class_description = "This is a class for doing \"key/value\" storage.";
            $this->instance_description = $this->name;
        }
        
        return $ret;
    }
    
    /***********************/
    function set_key(   $in_key,            
                        $in_value = NULL    
                    ) {
        $ret = false;
        
        if ($this->user_can_write()) { //< Must have write access
            // We need to make sure that the key doesn't already exist, or if it does, that the object associated with it is us. Must be writeable.
            $instance_list = $this->get_access_object()->generic_search(Array('access_class' => get_class($this), 'tags' => Array($in_key)));
        
            if (!isset($instance_list) || !is_array($instance_list) || !count($instance_list) || (1 == count($instance_list) && ($instance_list[0] === $this))) {
                // If there is no change, then we don't do anything, and report a success.
                if (isset($instance_list) && is_array($instance_list) && (1 == count($instance_list) && ($instance_list[0] === $this))) {
                    $ret = true;
                } else {
                    $ret = $this->set_tag(0, $in_key);   // We assume that our claim to be writeable is true. If not, this will fail. Remember we are untrusting bastards.
                }
                
                if ($ret && (NULL != $in_value)) {
                    return $this->set_value($in_value);
                }
            }
        } else {
            $this->error = new LGV_Error(   CO_CHAMELEON_Lang_Common::$co_key_value_error_code_user_not_authorized,
                                            CO_CHAMELEON_Lang::$co_key_value_error_name_user_not_authorized,
                                            CO_CHAMELEON_Lang::$co_key_value_error_desc_user_not_authorized);
        }
        
        return $ret;
    }
    
    /***********************/
    function get_key() {
        return $this->tags[0];
    }
    
    /***********************/
    function get_value() {
        return $this->get_payload();
    }
    
    /***********************/
    function get_key_value_array() {
        return Array($this->get_key(), $this->get_value());
    }
    
    /***********************/
    function get_key_value_assoc() {
        return Array($this->get_key() => $this->get_value());
    }
    
    /***********************/
    function set_value( $in_value
                        ) {
        $ret = false;
        
        if ($this->user_can_write()) { //< Must have write access
            $ret = $this->set_payload($in_value);
        } else {
            $this->error = new LGV_Error(   CO_CHAMELEON_Lang_Common::$co_key_value_error_code_user_not_authorized,
                                            CO_CHAMELEON_Lang::$co_key_value_error_name_user_not_authorized,
                                            CO_CHAMELEON_Lang::$co_key_value_error_desc_user_not_authorized);
        }
        
        return $ret;
    }
};