a_rvp_php_sdk_data_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__).'/a_rvp_php_sdk_object.class.php');   // Get our base class.

/****************************************************************************************************************************/
abstract class A_RVP_PHP_SDK_Data_Object extends A_RVP_PHP_SDK_Object {
    /************************************************************************************************************************/    
    /*#################################################### INTERNAL METHODS ################################################*/
    /************************************************************************************************************************/
    /***********************/
    protected function _save_data(  $in_args = '',              
                                    $in_payload = NULL,         
                                    $in_new_child_ids = NULL    
                                ) {
        $owner_id = isset($this->_object_data->owner_id) ? intval($this->_object_data->owner_id) : 0;
        $latitude = isset($this->_object_data->raw_latitude) ? floatval($this->_object_data->raw_latitude) : (isset($this->_object_data->latitude) ? floatval($this->_object_data->latitude) : NULL);
        $longitude = isset($this->_object_data->raw_longitude) ? floatval($this->_object_data->raw_longitude) : (isset($this->_object_data->longitude) ? floatval($this->_object_data->longitude) : NULL);
        $fuzz_factor = isset($this->_object_data->fuzz_factor) ? floatval($this->_object_data->fuzz_factor) : NULL;
        $can_see_through_the_fuzz = isset($this->_object_data->can_see_through_the_fuzz) ? intval($this->_object_data->can_see_through_the_fuzz) : NULL;
        
        $put_args = '&owner_id='.$owner_id.(isset($latitude) ? ('&latitude='.$latitude) : '').(isset($longitude) ? ('&longitude='.$longitude) : '').(isset($fuzz_factor) ? '&fuzz_factor='.$fuzz_factor : '').(isset($can_see_through_the_fuzz) ? '&can_see_through_the_fuzz='.$can_see_through_the_fuzz : '');
        
        if (isset($in_new_child_ids) && is_array($in_new_child_ids) && count($in_new_child_ids)) {
            $in_new_child_ids = array_filter(array_map('intval', $in_new_child_ids), function($i) { return 0 != intval($i); });
            if (count($in_new_child_ids)) {
                $put_args .= '&child_ids='.implode(',', $in_new_child_ids);
            }
        }
        
        $payload = isset($in_payload) ? $in_payload : NULL;
        
        $ret = parent::_save_data($put_args.$in_args, $payload);
        
        return $ret;
    }
    
    /************************************************************************************************************************/    
    /*#################################################### PUBLIC METHODS ##################################################*/
    /************************************************************************************************************************/
    
    /***********************/
    function __construct(   $in_sdk_object,                 
                            $in_id,                         
                            $in_data = NULL,                
                            $in_detailed_data = false,      
                            $in_plugin_path = 'baseline'    
                        ) {
        parent::__construct($in_sdk_object, $in_id, $in_data, $in_detailed_data, $in_plugin_path);
    }
    
    /***********************/
    function coords() {
        $ret = NULL;
        
        $this->_load_data();
        
        if (isset($this->_object_data) && isset($this->_object_data->coords)) {
            $temp = explode(',', $this->_object_data->coords);
            if (isset($temp) && is_array($temp) && (1 < count($temp))) {
                $ret = [];
                $ret['latitude'] = floatval($temp[0]);
                $ret['longitude'] = floatval($temp[1]);
            }
        }
                
        return $ret;
    }
    
    /***********************/
    function set_coords(    $in_latitude,   
                            $in_longitude   
                        ) {
        $ret = false;
        
        $this->_load_data(false, true);

        if (isset($this->_object_data)) {
            if ((isset($this->_object_data->raw_latitude) && isset($this->_object_data->raw_longitude)) || (isset($this->_object_data->fuzzy) && $this->_object_data->fuzzy)) {
                $this->_object_data->raw_latitude = $in_latitude;
                $this->_object_data->raw_longitude = $in_longitude;
            } else {
                $this->_object_data->latitude = $in_latitude;
                $this->_object_data->longitude = $in_longitude;
            }
            
            $ret = $this->save_data();
        }
        
        return $ret;
    }
    
    /***********************/
    function distance() {
        $ret = 0;
        
        $this->_load_data(false, true);
        
        if (isset($this->_object_data) && isset($this->_object_data->distance_in_km)) {
            $ret = floatval($this->_object_data->distance_in_km);
        }
                
        return $ret;
    }
    
    /***********************/
    function is_fuzzy() {
        $ret = false;
        
        $this->_load_data(false, true);
        
        if (isset($this->_object_data) && isset($this->_object_data->fuzzy) && $this->_object_data->fuzzy) {
            $ret = true;
        }
                
        return $ret;
    }
    
    /***********************/
    function fuzz_factor() {
        $ret = 0;
        
        $this->_load_data(false, true);
        
        if (isset($this->_object_data) && isset($this->_object_data->fuzz_factor) && floatval($this->_object_data->fuzz_factor)) {
            $ret = floatval($this->_object_data->fuzz_factor);
        }
                
        return $ret;
    }
    
    /***********************/
    function set_fuzz_factor(   $in_new_factor  
                            ) {
        $this->_load_data(false, true);
        
        $this->_object_data->fuzz_factor = $in_new_factor;
        
        $ret = $this->save_data();
    
        if ($ret) { // We force a reload, because fuzz.
            $this->_load_data(true, true);
        }
        
        return $ret;
    }
    
    /***********************/
    function set_can_see_through_the_fuzz(  $in_token_id    
                                        ) {
        $this->_load_data(false, true);
        
        $this->_object_data->can_see_through_the_fuzz = $in_token_id;
        
        $ret = $this->save_data();
    
        if ($ret) { // We force a reload, because fuzz.
            $this->_load_data(true, true);
        }
        
        return $ret;
    }
    
    /***********************/
    function raw_coords() {
        $ret = NULL;
        
        $this->_load_data(false, true);
        
        if (isset($this->_object_data) && isset($this->_object_data->raw_latitude) && isset($this->_object_data->raw_longitude)) {
            $ret = [];
            $ret['latitude'] = floatval($this->_object_data->raw_latitude);
            $ret['longitude'] = floatval($this->_object_data->raw_longitude);
        }
                
        return $ret;
    }
    
    /***********************/
    function payload() {
        $ret = NULL;
        
        $this->_load_data(false, true);
        
        if (isset($this->_object_data) && isset($this->_object_data->payload)) {
            $payload_data = base64_decode($this->_object_data->payload);
            
            // We make sure that this was already Base64 before decoding.
            if (base64_encode(base64_decode($payload_data)) == $payload_data) {
                $payload_data = base64_decode($payload_data);
            }
            
            $ret = ['data' => $payload_data];
            
            if (isset($this->_object_data->payload_type)) {
                $ret['type'] = str_replace(';base64', '', $this->_object_data->payload_type);
            }
        }
        
        return $ret;
    }
    
    /***********************/
    function set_payload(   $in_payload_data    
                        ) {
        $payload = NULL;
        $args = '';
        
        // We figure out the payload type by uploading to a file, then checking the file type.
        if ($in_payload_data) {
            $temp_file = tempnam(sys_get_temp_dir(), 'RVP');  
            file_put_contents($temp_file , $in_payload_data);
            $finfo = finfo_open(FILEINFO_MIME_TYPE);  
            $content_type = finfo_file($finfo, $temp_file);
            unlink($temp_file);
            $this->_object_data->payload_type = $content_type;
            $payload = ['data' => $in_payload_data, 'type' => $content_type];
        } else {
            $args = '&remove_payload';
        }
        
        // We circumvent our caller for this one.
        $ret = $this->_save_change_record(self::_save_data($args, $payload));
        
        if ($ret) {
            $ret = $this->_load_data(true, true);
        } else {
            $this->_load_data(true, true);
        }
        
        return $ret;
    }
    
    /***********************/
    function children_ids() {
        $ret = [];
        
        $this->_load_data(false, true);
        
        if (isset($this->_object_data) && isset($this->_object_data->children)) {
            $child_data = (array)$this->_object_data->children;

            if (count($child_data)) {
                $ret = $child_data;
            }
        }
        
        return $ret;
    }
    
    /***********************/
    function set_new_children_ids(  $in_child_ids   
                                ) {
        $ret = false;
        // We circumvent our caller for this one.
        $ret = $this->_save_change_record(self::_save_data('', NULL, $in_child_ids));
        
        if ($ret) {
            $ret = $this->force_reload();
        } else {    // If there was an error, then we don't send back the result (it may also be an error).
            $this->force_reload();
        }
        return $ret;
    }
    
    /***********************/
    function parent_ids() {
        $ret = NULL;
        
        $this->_load_data(false, true, true);
        
        if (isset($this->_object_data) && isset($this->_object_data->parents)) {
            $parent_data = $this->_object_data->parents;

            if (isset($parent_data) && is_array($parent_data) && count($parent_data)) {
                $ret = $parent_data;
            }
        }
        
        return $ret;
    }
    
    /***********************/
    function get_hierarchy() {
        $ret = ['object' => $this];
        
        $this->_load_data(false, true);
        
        if (isset($this->_object_data) && isset($this->_object_data->children)) {
            $child_data = (array)$this->_object_data->children;
            
            if (count($child_data)) {
                $ret['children'] = [];
                foreach ($child_data as $plugin) {
                    if (count($plugin)) {
                        $objects = $this->_sdk_object->get_objects($plugin);
                
                        if (is_array($objects) && count($objects)) {
                            foreach ($objects as $object) {
                                if (method_exists($object, 'get_hierarchy')) {
                                    $ret['children'][] = $object->get_hierarchy();
                                }
                            }
                        }
                    }
                }
            }
        }
        
        return $ret;
    }
};