a_rvp_php_sdk_object.class.php

<?php
/***************************************************************************************************************************/
defined( 'RVP_PHP_SDK_ACCESS' ) or die ( 'Cannot Execute Directly' );   // Makes sure that this file is in the correct context.

require_once(dirname(__FILE__).'/rvp_php_sdk.class.php');   // Make sure that we have the main SDK class in place.

/****************************************************************************************************************************/
abstract class A_RVP_PHP_SDK_Object {
    protected   $_sdk_object;       
    protected   $_object_id;        
    protected   $_object_data;      
    protected   $_details;          
    protected   $_plugin_path;      
    protected   $_changed_states;   
    
    /************************************************************************************************************************/    
    /*#################################################### INTERNAL METHODS ################################################*/
    /************************************************************************************************************************/
    /***********************/
    protected function _load_data(  $in_force = false,      
                                    $in_details = false,    
                                    $in_parents = false     
                                ) {
        $ret = false;
        
        if ($in_force || $in_parents || (NULL == $this->_object_data) || ($in_details && !$this->_details)) {
            $this->_details = $in_details;
            $fetched_data = $this->_sdk_object->fetch_data('json/'.$this->_plugin_path.'/'.$this->_object_id, $in_details ? 'show_details'.($in_parents ? '&show_parents' : '') : NULL);
            $this->_object_data = (NULL != $fetched_data) ? json_decode($fetched_data) : NULL;
            $ret = (NULL != $this->_object_data);
        }
        
        return $ret;
    }
    
    /***********************/
    protected function _save_data(  $in_args = '',              
                                    $in_payload = NULL,         
                                    $in_new_child_ids = NULL    
                                ) {
        $ret = NULL;
        $put_args = '';
        
        $name = isset($this->_object_data->name) ? $this->_object_data->name : NULL;
        $lang = isset($this->_object_data->lang) ? $this->_object_data->lang : NULL;
        $read_token = isset($this->_object_data->read_token) ? intval($this->_object_data->read_token) : NULL;
        $write_token = isset($this->_object_data->write_token) ? ((0 < intval($this->_object_data->write_token)) ? intval($this->_object_data->write_token) : $this->_sdk_object->my_info()['login']->id()) : NULL;
        
        if (isset($name)) {
            $put_args .= '&name='.urlencode($name);
        }
        
        if (isset($lang)) {
            $put_args .= '&lang='.urlencode($lang);
        }
        
        if (isset($read_token)) {
            $put_args .= '&read_token='.intval($read_token);
        }
        
        if (isset($write_token)) {
            $put_args .= '&write_token='.intval($write_token);
        }
        
        $result = json_decode($this->_sdk_object->put_data('/json/'.$this->_plugin_path.'/'.$this->id(), $put_args.$in_args, $in_payload));
        
        return $result;
    }
    
    /***********************/
    protected abstract function _save_change_record(    $in_change_record_object    
                                                    );
    
    /************************************************************************************************************************/    
    /*#################################################### PUBLIC METHODS ##################################################*/
    /************************************************************************************************************************/
    /***********************/
    function __construct(   $in_sdk_object,                 
                            $in_id,                         
                            $in_data = NULL,                
                            $in_detailed_data = false,      
                            $in_plugin_path = 'baseline'    
                        ) {
        $this->_object_id = $in_id;
        $this->_object_data = $in_data;
        $this->_details = (NULL != $in_data) ? $in_detailed_data : false;
        $this->_plugin_path = $in_plugin_path;
        $this->_changed_states = [];
        $this->set_sdk_object($in_sdk_object);
    }
    
    /***********************/
    function set_sdk_object(    $in_sdk_object  
                            ) {
        $this->_sdk_object = $in_sdk_object;    // This is the RVP_PHP_SDK object that "owns" this user.
    }
    
    /***********************/
    function changes() {
        return isset($this->_changed_states) ? $this->_changed_states : [];
    }
    
    /***********************/
    function save_data() {
        $ret = false;
        
        $ret = $this->_save_change_record($this->_save_data());
        
        return $ret;
    }
    
    /***********************/
    function id() {
        return $this->_object_id;
    }
    
    /***********************/
    function name() {
        $ret = NULL;
        
        $this->_load_data();

        if (isset($this->_object_data) && isset($this->_object_data->name)) {
            $ret = $this->_object_data->name;
        }
        
        return $ret;
    }
    
    /***********************/
    function set_name(  $in_new_value   
                        ) {
        $ret = false;
        
        $this->_load_data(false, true);

        if (isset($this->_object_data)) {
            $this->_object_data->name = $in_new_value;
            
            $ret = $this->save_data();
        }
        
        return $ret;
    }
    
    /***********************/
    function lang() {
        $ret = NULL;
        
        $this->_load_data();
        
        if (isset($this->_object_data) && isset($this->_object_data->lang)) {
            $ret = $this->_object_data->lang;
        }
        
        return $ret;
    }
    
    /***********************/
    function set_lang(  $in_new_value   
                        ) {
        $ret = false;
        
        $this->_load_data(false, true);

        if (isset($this->_object_data)) {
            $this->_object_data->lang = $in_new_value;
            
            $ret = $this->save_data();
        }
        
        return $ret;
    }
    
    /***********************/
    function object_access() {
        $ret = NULL;
        $read_token = NULL;
        $write_token = NULL;
        
        $this->_load_data();
        
        if (isset($this->_object_data) && isset($this->_object_data->read_token)) {
            $read_token = intval($this->_object_data->read_token);
        }
        
        if (isset($this->_object_data) && isset($this->_object_data->write_token)) {
            $write_token = intval($this->_object_data->write_token);
        }
        
        if ($read_token || $write_token) {
            $ret = [];
            
            if ($read_token) {
                $ret['read'] = $read_token;
            }
            
            if ($write_token) {
                $ret['write'] = $write_token;
            }
        }
        
        return $ret;
    }
    
    /***********************/
    function set_object_access( $in_new_read = NULL,    
                                $in_new_write = NULL    
                                ) {
        $ret = false;
        
        $this->_load_data(false, true);

        if (isset($this->_object_data)) {
            $this->_object_data->read_token = isset($in_new_read) ? intval($in_new_read) : $this->_object_data->read_token;
            $this->_object_data->write_token = isset($in_new_write) ? intval($in_new_write) : $this->_object_data->write_token;
            
            $ret = $this->save_data();
        }
        
        return $ret;
    }
    
    /***********************/
    function writeable() {
        $ret = false;
        
        $this->_load_data();
        
        if (isset($this->_object_data) && isset($this->_object_data->writeable) && $this->_object_data->writeable) {
            $ret = true;
        }
        
        return $ret;
    }
    
    /***********************/
    function last_access() {
        $ret = NULL;
        
        $this->_load_data();
        
        if (isset($this->_object_data) && isset($this->_object_data->last_access)) {
            $ret = strtotime($this->_object_data->last_access);
        }
        
        return $ret;
    }
    
    /***********************/
    function force_reload(  $in_parents = false 
                        ) {
        return $this->_load_data(true, true, $in_parents);
    }
};