rvp_php_sdk_user.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_data_object.class.php');   // Make sure that we have the base class in place.

/****************************************************************************************************************************/
class RVP_PHP_SDK_User extends A_RVP_PHP_SDK_Data_Object {
    /************************************************************************************************************************/    
    /*#################################################### INTERNAL METHODS ################################################*/
    /************************************************************************************************************************/
    /***********************/
    protected function _save_data(  $in_args = '',              
                                    $in_payload = NULL,         
                                    $in_new_child_ids = NULL    
                                ) {
        $to_set = [
            'surname' => (isset($this->_object_data->surname) ? $this->_object_data->surname : NULL),
            'middle_name' => (isset($this->_object_data->middle_name) ? $this->_object_data->middle_name : NULL),
            'given_name' => (isset($this->_object_data->given_name) ? $this->_object_data->given_name : NULL),
            'nickname' => (isset($this->_object_data->nickname) ? $this->_object_data->nickname : NULL),
            'prefix' => (isset($this->_object_data->prefix) ? $this->_object_data->prefix : NULL),
            'suffix' => (isset($this->_object_data->suffix) ? $this->_object_data->suffix : NULL),
            'tag7' => (isset($this->_object_data->tag7) ? $this->_object_data->tag7 : NULL),
            'tag8' => (isset($this->_object_data->tag8) ? $this->_object_data->tag8 : NULL),
            'tag9' => (isset($this->_object_data->tag9) ? $this->_object_data->tag9 : NULL),
            ];
        
        // Only God can change login IDs.
        if ($this->_sdk_object->is_main_admin()) {
            if (isset($this->_object_data->associated_login_id)) {
                $to_set['login_id'] = intval($this->_object_data->associated_login_id);
            }
        }
        
        $put_args = '';
        
        foreach ($to_set as $key => $value) {
            if (isset($key) && isset($value)) {
                $put_args .= '&'.$key.'='.urlencode(trim(strval($value)));
            }
        }
        
        $ret = parent::_save_data($put_args.$in_args, NULL, NULL);
        
        return $ret;
    }
    
    /***********************/
    protected function _save_change_record( $in_change_record_object    
                                            ) {
        $ret = false;
        if (isset($in_change_record_object->people->people) && isset($in_change_record_object->people->people->changed_users) && is_array($in_change_record_object->people->people->changed_users) && count($in_change_record_object->people->people->changed_users)) {
            foreach ($in_change_record_object->people->people->changed_users as $changed_person) {
                if ($before = $changed_person->before) {
                    $this->_changed_states[] = new RVP_PHP_SDK_User($this->_sdk_object, $before->id, $before, true);
                    $ret = true;
                }
            }
        }
        
        return $ret;
    }
    
    /***********************/
    protected function _load_data(  $in_force = false,      
                                    $in_details = false,    
                                    $in_parents = false     
                                ) {
        $ret = parent::_load_data($in_force, $in_details, $in_parents);
        
        if ($ret) {
            if (isset($this->_object_data) && isset($this->_object_data->people) && isset($this->_object_data->people->people) && is_array($this->_object_data->people->people) && (1 == count($this->_object_data->people->people))) {
                $this->_object_data = $this->_object_data->people->people[0];
            } else {
                $this->_object_data = NULL;
                $this->_details = false;
            }
        }
        
        return $ret;
    }

    /************************************************************************************************************************/    
    /*#################################################### PUBLIC METHODS ##################################################*/
    /************************************************************************************************************************/
    
    /***********************/
    function __construct(   $in_sdk_object,             
                            $in_id,                     
                            $in_data = NULL,            
                            $in_detailed_data = false   
                        ) {
        parent::__construct($in_sdk_object, $in_id, $in_data, $in_detailed_data, 'people/people');
    }
    
    /***********************/
    function security_tokens() {
        $ret = [];
        
        $this->_load_data(false, true);
        
        if (isset($this->_object_data) && isset($this->_object_data->associated_login) && isset($this->_object_data->associated_login->security_tokens)) {
            $ret = $this->_object_data->associated_login->security_tokens;
        }
        
        return $ret;
    }
    
    /***********************/
    function surname() {
        $ret = NULL;
        
        $this->_load_data(false, true);
        if (isset($this->_object_data) && isset($this->_object_data->surname)) {
            $ret = trim($this->_object_data->surname);
        }
        
        return $ret;
    }
    
    /***********************/
    function set_surname(   $in_new_string_value    
                        ) {
        $ret = false;
        
        $this->_load_data(false, true);
        
        if (isset($this->_object_data)) {
            $this->_object_data->surname = trim(strval($in_new_string_value));
            $ret = $this->save_data();
        }
        
        return $ret;
    }
    
    /***********************/
    function middle_name() {
        $ret = NULL;
        
        $this->_load_data(false, true);
        if (isset($this->_object_data) && isset($this->_object_data->middle_name)) {
            $ret = trim($this->_object_data->middle_name);
        }
        
        return $ret;
    }
    
    /***********************/
    function set_middle_name(   $in_new_string_value    
                            ) {
        $ret = false;
        
        $this->_load_data(false, true);
        
        if (isset($this->_object_data)) {
            $this->_object_data->middle_name = trim(strval($in_new_string_value));
            $ret = $this->save_data();
        }
        
        return $ret;
    }
    
    /***********************/
    function given_name() {
        $ret = NULL;
        
        $this->_load_data(false, true);
        if (isset($this->_object_data) && isset($this->_object_data->given_name)) {
            $ret = trim($this->_object_data->given_name);
        }
        
        return $ret;
    }
    
    /***********************/
    function set_given_name(    $in_new_string_value    
                            ) {
        $ret = false;
        
        $this->_load_data(false, true);
        
        if (isset($this->_object_data)) {
            $this->_object_data->given_name = trim(strval($in_new_string_value));
            $ret = $this->save_data();
        }
        
        return $ret;
    }
    
    /***********************/
    function nickname() {
        $ret = NULL;
        
        $this->_load_data(false, true);
        if (isset($this->_object_data) && isset($this->_object_data->nickname)) {
            $ret = trim($this->_object_data->nickname);
        }
        
        return $ret;
    }
    
    /***********************/
    function set_nickname(  $in_new_string_value    
                        ) {
        $ret = false;
        
        $this->_load_data(false, true);
        
        if (isset($this->_object_data)) {
            $this->_object_data->nickname = trim(strval($in_new_string_value));
            $ret = $this->save_data();
        }
        
        return $ret;
    }
    
    /***********************/
    function prefix() {
        $ret = NULL;
        
        $this->_load_data(false, true);
        if (isset($this->_object_data) && isset($this->_object_data->prefix)) {
            $ret = trim($this->_object_data->prefix);
        }
        
        return $ret;
    }
    
    /***********************/
    function set_prefix(    $in_new_string_value    
                        ) {
        $ret = false;
        
        $this->_load_data(false, true);
        
        if (isset($this->_object_data)) {
            $this->_object_data->prefix = trim(strval($in_new_string_value));
            $ret = $this->save_data();
        }
        
        return $ret;
    }
    
    /***********************/
    function suffix() {
        $ret = NULL;
        
        $this->_load_data(false, true);
        if (isset($this->_object_data) && isset($this->_object_data->suffix)) {
            $ret = trim($this->_object_data->suffix);
        }
        
        return $ret;
    }
    
    /***********************/
    function set_suffix(    $in_new_string_value    
                        ) {
        $ret = false;
        
        $this->_load_data(false, true);
        
        if (isset($this->_object_data)) {
            $this->_object_data->suffix = trim(strval($in_new_string_value));
            $ret = $this->save_data();
        }
        
        return $ret;
    }
    
    /***********************/
    function tag7() {
        $ret = NULL;
        
        $this->_load_data(false, true);
        
        if (isset($this->_object_data)) {
            $ret = $this->_object_data->tag7;
        }
        
        return $ret;
    }
    
    /***********************/
    function set_tag7(  $in_new_string_value    
                    ) {
        $ret = false;
        
        $this->_load_data(false, true);
        
        if (isset($this->_object_data)) {
            $this->_object_data->tag7 = trim(strval($in_new_string_value));
            $ret = $this->save_data();
        }
        
        return $ret;
    }
    
    /***********************/
    function tag8() {
        $ret = NULL;
        
        $this->_load_data(false, true);
        
        if (isset($this->_object_data)) {
            $ret = $this->_object_data->tag8;
        }
        
        return $ret;
    }
    
    /***********************/
    function set_tag8(  $in_new_string_value    
                    ) {
        $ret = false;
        
        $this->_load_data(false, true);
        
        if (isset($this->_object_data)) {
            $this->_object_data->tag8 = trim(strval($in_new_string_value));
            $ret = $this->save_data();
        }
        
        return $ret;
    }
    
    /***********************/
    function tag9() {
        $ret = NULL;
        
        $this->_load_data(false, true);
        
        if (isset($this->_object_data)) {
            $ret = $this->_object_data->tag9;
        }
        
        return $ret;
    }
    
    /***********************/
    function set_tag9(  $in_new_string_value    
                    ) {
        $ret = false;
        
        $this->_load_data(false, true);
        
        if (isset($this->_object_data)) {
            $this->_object_data->tag9 = trim(strval($in_new_string_value));
            $ret = $this->save_data();
        }
        
        return $ret;
    }
    
    /***********************/
    function associated_login_id() {
        $ret = NULL;
        
        $this->_load_data(false, true);

        if (isset($this->_object_data) && isset($this->_object_data->associated_login->id)) {
            $ret = intval($this->_object_data->associated_login->id);
        } elseif (isset($this->_object_data) && isset($this->_object_data->associated_login_id)) {
            $ret = intval($this->_object_data->associated_login_id);
        }
        
        return $ret;
    }
    
    /***********************/
    function set_associated_login_id(   $in_new_integer_value   
                                    ) {
        $ret = false;
        
        if ($this->_sdk_object->is_main_admin()) {  // Only God can change login IDs.
            $login_object = $this->_sdk_object->get_login_info($in_new_integer_value);
        
            if ($login_object instanceof RVP_PHP_SDK_Login) {
                if (0 == $login_object->user_object_id()) { // We can only associate a login that is not associated with another user.
                    $this->_load_data(false, true);
        
                    if (isset($this->_object_data)) {
                        $this->_object_data->associated_login_id = intval($in_new_integer_value);
                        $ret = $this->save_data();
                    }
                } else {
                    $this->_sdk_object->set_error(_ERR_LOGIN_HAS_USER__);
                }
            } else {
                $this->_sdk_object->set_error(_ERR_INVALID_PARAMETERS__);
            }
        } else {
            $this->_sdk_object->set_error(_ERR_NOT_AUTHORIZED__);
        }
        
        return $ret;
    }
};