RVP_PHP_SDK_User Class Reference

Inheritance diagram for RVP_PHP_SDK_User:

Public Member Functions
	__construct ( $in_sdk_object, $in_id, $in_data=NULL, $in_detailed_data=false)
	security_tokens ()
	surname ()
	set_surname ( $in_new_string_value)
	middle_name ()
	set_middle_name ( $in_new_string_value)
	given_name ()
	set_given_name ( $in_new_string_value)
	nickname ()
	set_nickname ( $in_new_string_value)
	prefix ()
	set_prefix ( $in_new_string_value)
	suffix ()
	set_suffix ( $in_new_string_value)
	tag7 ()
	set_tag7 ( $in_new_string_value)
	tag8 ()
	set_tag8 ( $in_new_string_value)
	tag9 ()
	set_tag9 ( $in_new_string_value)
	associated_login_id ()
	set_associated_login_id ( $in_new_integer_value)
	coords ()
	set_coords ( $in_latitude, $in_longitude)
	distance ()
	is_fuzzy ()
	fuzz_factor ()
	set_fuzz_factor ( $in_new_factor)
	set_can_see_through_the_fuzz ( $in_token_id)
	raw_coords ()
	payload ()
	set_payload ( $in_payload_data)
	children_ids ()
	set_new_children_ids ( $in_child_ids)
	parent_ids ()
	get_hierarchy ()
	set_sdk_object ( $in_sdk_object)
	changes ()
	save_data ()
	id ()
	name ()
	set_name ( $in_new_value)
	lang ()
	set_lang ( $in_new_value)
	object_access ()
	set_object_access ( $in_new_read=NULL, $in_new_write=NULL)
	writeable ()
	last_access ()
	force_reload ( $in_parents=false)

Protected Member Functions
	_save_data ( $in_args='', $in_payload=NULL, $in_new_child_ids=NULL)
	_save_change_record ( $in_change_record_object)
	_load_data ( $in_force=false, $in_details=false, $in_parents=false)

Protected Attributes
	$_sdk_object
	This is the RVP_PHP_SDK object that "owns" this object.
	$_object_id
	This is the server unique ID of this object.
	$_object_data
	This is any data that was associated with this object (parsed JSON).
	$_details
	If true, then the last load was a "show details" load..
	$_plugin_path
	This is a string that is applied to fetches to get the object.
	$_changed_states
	This will contain an array of objects (of whatever class this is), that represent previous object states.

Detailed Description

Definition at line 31 of file rvp_php_sdk_user.class.php.

Constructor & Destructor Documentation

__construct()

__construct	(		$in_sdk_object,
			$in_id,
			$in_data = NULL,
			$in_detailed_data = false
	)

Parameters

$in_sdk_object	REQUIRED: The "owning" SDK object.
$in_id	REQUIRED: The server ID of the object. An integer.
$in_data	OPTIONAL: Parsed JSON Data for the object. Default is NULL.
$in_detailed_data	OPTIONAL: Ignored if $in_data is NULL. Default is false. If true, then the data sent in was in "detailed" format.

Definition at line 127 of file rvp_php_sdk_user.class.php.

                          {
        parent::__construct($in_sdk_object, $in_id, $in_data, $in_detailed_data, 'people/people');
    }

Member Function Documentation

_save_data()

_save_data (   $in_args = '',   $in_payload = NULL,   $in_new_child_ids = NULL  )

protected

Returns

true, if the save was successful.

Parameters

$in_args	OPTIONAL: Default is an empty string. This is any previous arguments. This will be appeneded to the end of the list, so it should begin with an ampersand (&), and be url-encoded.
$in_payload	IGNORED. Just here to suppress PHP warnings.
$in_new_child_ids	IGNORED. Just here to suppress PHP warnings.

Definition at line 39 of file rvp_php_sdk_user.class.php.

                                  {
        $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;
    }

_save_change_record()

_save_change_record (   $in_change_record_object )

protected

This is called after a successful save. It has the change record[s], and we will parse them to save the "before" object.

Returns

true, if the save was successful.

Parameters

$in_change_record_object

REQUIRED: The change response, as a parsed object.

Definition at line 81 of file rvp_php_sdk_user.class.php.

                                              {
        $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;
    }

_load_data()

_load_data (   $in_force = false,   $in_details = false,   $in_parents = false  )

protected

This is the specific "load some data" method. It will send a GET REST request to the API in order to fetch information about this object.

Returns

true, if it loaded the data.

Parameters

$in_force	OPTIONAL: If true (default is false), then the load will happen, even if we already have the data.
$in_details	OPTIONAL: Default is false. If true, then the load will be a "show details" load, which could bring in a great deal more data.
$in_parents	OPTIONAL: Default is false. If true, then the load will be a "show details" load, AND it will get the "parents," which can be a time-consuming operation. This will also "force" a load.

Definition at line 102 of file rvp_php_sdk_user.class.php.

                                  {
        $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;
    }

security_tokens()

security_tokens

(

)

This requires a "detailed" load.

Returns

an array of integer (security tokens) that comprise the "pool" for this user (assuming it has a login).

Definition at line 141 of file rvp_php_sdk_user.class.php.

                               {
        $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;
    }

surname()

surname

(

)

This requires a "detailed" load.

Returns

a string, with the user surname.

Definition at line 159 of file rvp_php_sdk_user.class.php.

                       {
        $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;
    }

set_surname()

set_surname

(

$in_new_string_value

)

This requires a "detailed" load.

Returns

true, if the operation succeeded.

Parameters

$in_new_string_value

REQUIRED: The new value

Definition at line 176 of file rvp_php_sdk_user.class.php.

                          {
        $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;
    }

middle_name()

middle_name

(

)

This requires a "detailed" load.

Returns

a string, with the user middle name.

Definition at line 196 of file rvp_php_sdk_user.class.php.

                           {
        $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;
    }

set_middle_name()

set_middle_name

(

$in_new_string_value

)

This requires a "detailed" load.

Returns

true, if the operation succeeded.

Parameters

$in_new_string_value

REQUIRED: The new value

Definition at line 213 of file rvp_php_sdk_user.class.php.

                              {
        $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;
    }

given_name()

given_name

(

)

This requires a "detailed" load.

Returns

a string, with the user given (first) name.

Definition at line 233 of file rvp_php_sdk_user.class.php.

                          {
        $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;
    }

set_given_name()

set_given_name

(

$in_new_string_value

)

This requires a "detailed" load.

Returns

true, if the operation succeeded.

Parameters

$in_new_string_value

REQUIRED: The new value

Definition at line 250 of file rvp_php_sdk_user.class.php.

                              {
        $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;
    }

nickname()

nickname

(

)

This requires a "detailed" load.

Returns

a string, with the user nickname.

Definition at line 270 of file rvp_php_sdk_user.class.php.

                        {
        $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;
    }

set_nickname()

set_nickname

(

$in_new_string_value

)

This requires a "detailed" load.

Returns

true, if the operation succeeded.

Parameters

$in_new_string_value

REQUIRED: The new value

Definition at line 287 of file rvp_php_sdk_user.class.php.

                          {
        $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;
    }

prefix()

prefix

(

)

This requires a "detailed" load.

Returns

a string, with the user prefix.

Definition at line 307 of file rvp_php_sdk_user.class.php.

                      {
        $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;
    }

set_prefix()

set_prefix

(

$in_new_string_value

)

This requires a "detailed" load.

Returns

true, if the operation succeeded.

Parameters

$in_new_string_value

REQUIRED: The new value

Definition at line 324 of file rvp_php_sdk_user.class.php.

                          {
        $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;
    }

suffix()

suffix

(

)

This requires a "detailed" load.

Returns

a string, with the user suffix.

Definition at line 344 of file rvp_php_sdk_user.class.php.

                      {
        $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;
    }

set_suffix()

set_suffix

(

$in_new_string_value

)

This requires a "detailed" load.

Returns

true, if the operation succeeded.

Parameters

$in_new_string_value

REQUIRED: The new value

Definition at line 361 of file rvp_php_sdk_user.class.php.

                          {
        $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;
    }

tag7()

tag7

(

)

This requires a detailed string load.

Returns

the string value of Tag 7, or NULL.

Definition at line 381 of file rvp_php_sdk_user.class.php.

                    {
        $ret = NULL;
        
        $this->_load_data(false, true);
        
        if (isset($this->_object_data)) {
            $ret = $this->_object_data->tag7;
        }
        
        return $ret;
    }

set_tag7()

set_tag7

(

$in_new_string_value

)

This sets the value of tag 7.

Returns

true, if the operation suceeded.

Parameters

$in_new_string_value

REQUIRED: The new string value to be set. If empty, then the tag is cleared.

Definition at line 399 of file rvp_php_sdk_user.class.php.

                      {
        $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;
    }

tag8()

tag8

(

)

This requires a detailed string load.

Returns

the string value of Tag 8, or NULL.

Definition at line 419 of file rvp_php_sdk_user.class.php.

                    {
        $ret = NULL;
        
        $this->_load_data(false, true);
        
        if (isset($this->_object_data)) {
            $ret = $this->_object_data->tag8;
        }
        
        return $ret;
    }

set_tag8()

set_tag8

(

$in_new_string_value

)

This sets the value of tag 8.

Returns

true, if the operation suceeded.

Parameters

$in_new_string_value

REQUIRED: The new string value to be set. If empty, then the tag is cleared.

Definition at line 437 of file rvp_php_sdk_user.class.php.

                      {
        $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;
    }

tag9()

tag9

(

)

This requires a detailed string load.

Returns

the string value of Tag 9, or NULL.

Definition at line 457 of file rvp_php_sdk_user.class.php.

                    {
        $ret = NULL;
        
        $this->_load_data(false, true);
        
        if (isset($this->_object_data)) {
            $ret = $this->_object_data->tag9;
        }
        
        return $ret;
    }

set_tag9()

set_tag9

(

$in_new_string_value

)

This sets the value of tag 9.

Returns

true, if the operation suceeded.

Parameters

$in_new_string_value

REQUIRED: The new string value to be set. If empty, then the tag is cleared.

Definition at line 475 of file rvp_php_sdk_user.class.php.

                      {
        $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;
    }

associated_login_id()

associated_login_id

(

)

This requires a detailed string load.

NOTE: It is possible for the user data to actually have the entire associated login as part of its data, so, in that case, we extract the login ID directly from that data.

Returns

an integer, with the associated login ID, or NULL.

Definition at line 497 of file rvp_php_sdk_user.class.php.

                                   {
        $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;
    }

set_associated_login_id()

set_associated_login_id

(

$in_new_integer_value

)

This sets the value of the associated login ID.

Returns

true, if the operation suceeded.

Parameters

$in_new_integer_value

REQUIRED: The new login ID value.

Definition at line 517 of file rvp_php_sdk_user.class.php.

                                      {
        $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;
    }

coords()

coords ( )

inherited

This requires a load, but not a "detailed" load.

Returns

an associative array ('latitude' => float, 'longitude' => float), with the long/lat coordinates of the object, or NULL, if there are no long/lat coordinates.

Definition at line 91 of file a_rvp_php_sdk_data_object.class.php.

                      {
        $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;
    }

set_coords()

set_coords (   $in_latitude,   $in_longitude  )

inherited

This sets the new long/lat value. This sets the "real" value (or "raw" value), if the record is "fuzzed," so subsequent checks of the regular long/lat may show different results.

Returns

true, if it worked.

Parameters

$in_latitude	REQUIRED: The new latitude value, in degrees.
$in_longitude	REQUIRED: The new longitude value, in degrees.

Definition at line 114 of file a_rvp_php_sdk_data_object.class.php.

                          {
        $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;
    }

distance()

distance ( )

inherited

This requires a a "detailed" load.

Returns

the distance, if provided. Otherwise, it returns 0.

Definition at line 142 of file a_rvp_php_sdk_data_object.class.php.

                        {
        $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;
    }

is_fuzzy()

is_fuzzy ( )

inherited

This requires a "detailed" load.

Returns

true, if the object declares that it is "fuzzy" (has location obfuscation).

Definition at line 160 of file a_rvp_php_sdk_data_object.class.php.

                        {
        $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;
    }

fuzz_factor()

fuzz_factor ( )

inherited

This requires a "detailed" load.

Returns

a floating-point value, with the "fuzz factor" (in kilometers). You need to be logged in as an ID that has either write or "can see through the fuzz" capability on this record, or you get 0.

Definition at line 178 of file a_rvp_php_sdk_data_object.class.php.

                           {
        $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;
    }

set_fuzz_factor()

set_fuzz_factor (   $in_new_factor )

inherited

Sets a new "fuzz factor." Setting to 0 or NULL turns off location obfuscation. Any positive floating-point number is the "fuzz radius," in kilometers, of the obfuscation. Long/lat returned in the normal coords() call will be obfuscated. If the user has the rights to "see through the fuzz," calls to raw_coords() will return accurate results (otherwise, they will return NULL).

Returns

true, if it worked.

Parameters

$in_new_factor

REQUIRED: The new "fuzz factor" value. 0 or NULL will turn off location obfuscation.

Definition at line 198 of file a_rvp_php_sdk_data_object.class.php.

                              {
        $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;
    }

set_can_see_through_the_fuzz()

set_can_see_through_the_fuzz (   $in_token_id )

inherited

Sets a new "fuzz factor." Setting to 0 or NULL turns off location obfuscation. Any positive floating-point number is the "fuzz radius," in kilometers, of the obfuscation. Long/lat returned in the normal coords() call will be obfuscated. If the user has the rights to "see through the fuzz," calls to raw_coords() will return accurate results (otherwise, they will return NULL).

Returns

true, if it worked.

Parameters

$in_token_id

REQUIRED: The new token for the "see clearly" IDs. 0 will clear this field.

Definition at line 221 of file a_rvp_php_sdk_data_object.class.php.

                                          {
        $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;
    }

raw_coords()

raw_coords ( )

inherited

This requires a "detailed" load.

Returns

the "raw" coordinates for a "fuzzy" location, assuming the current login has rights to them. If not, it returns NULL.

Definition at line 242 of file a_rvp_php_sdk_data_object.class.php.

                          {
        $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;
    }

payload()

payload ( )

inherited

This requires a "detailed" load.

Returns

an associative array ('data' => binary data string, 'type' => string MIME type), containing the data in the payload, and its type. The data is not Base64-encoded.

Definition at line 262 of file a_rvp_php_sdk_data_object.class.php.

                       {
        $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;
    }

set_payload()

set_payload (   $in_payload_data )

inherited

This adds (or removes) a payload from this object. It figures out the data type on its own.

Returns

true, if the operation succeeds.

Parameters

$in_payload_data

REQUIRED (can be NULL). This is the data to set as the instance payload. It should NOT be Base64 encoded.

Definition at line 291 of file a_rvp_php_sdk_data_object.class.php.

                          {
        $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;
    }

children_ids()

children_ids ( )

inherited

This requires a "detailed" load.

Returns

an associative array ('people' => integer array of IDs, 'places' => integer array of IDs, and 'things' => integer array of IDs), containing the IDs of any "child" objects for this object.

Definition at line 327 of file a_rvp_php_sdk_data_object.class.php.

                            {
        $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;
    }

set_new_children_ids()

set_new_children_ids (   $in_child_ids )

inherited

This sets new child object IDs for this object.

Returns

true, if the operation succeeded.

Parameters

$in_child_ids

REQUIRED: The new children IDs. We do not separate these into different classes of ID. It's a simple integer array. This is a "delta" array. That means that what it contains are CHANGES. You ADD children by indicating positive integers. You DELETE children by indicating negative integers. If your login does not have the ability to read (write is not necessary) the child ID, then that ID is ignored. If the ID to be deleted is not in the record, then it is ignored.

Definition at line 349 of file a_rvp_php_sdk_data_object.class.php.

                                  {
        $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;
    }

parent_ids()

parent_ids ( )

inherited

This requires a "detailed and parents" load.

NOTE:** Calling this can incur a fairly significant performance penalty!

Returns

an associative array ('people' => integer array of IDs, 'places' => integer array of IDs, and 'things' => integer array of IDs), containing the IDs of any "parent" objects for this object.

Definition at line 377 of file a_rvp_php_sdk_data_object.class.php.

                          {
        $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;
    }

get_hierarchy()

get_hierarchy ( )

inherited

This requires a detailed data load.

This returns a recursive hierarchy of instances for this object. It returns actual object instances; not IDs, using a simple tuple.

Returns

an associative array. One element will be 'object', and will refer to this object. If the object has child objects, then there will be a 'children' array of more of these nodes. Leaf nodes will contain only 'object' elements.

Definition at line 401 of file a_rvp_php_sdk_data_object.class.php.

                             {
        $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;
    }

set_sdk_object()

set_sdk_object (   $in_sdk_object )

inherited

Simple accessor to set the "owning" SDK object.

Parameters

$in_sdk_object

REQUIRED: The "owning" SDK object.

Definition at line 148 of file a_rvp_php_sdk_object.class.php.

                              {
        $this->_sdk_object = $in_sdk_object;    // This is the RVP_PHP_SDK object that "owns" this user.
    }

changes()

changes ( )

inherited

Returns

an array of instances, representing the "before" state of this object, prior to any changes made. It should be noted that the lifetime of these changes are dependent on the lifetime of this instance.

Definition at line 157 of file a_rvp_php_sdk_object.class.php.

                       {
        return isset($this->_changed_states) ? $this->_changed_states : [];
    }

save_data()

save_data ( )

inherited

Returns

true, if the save was successful.

Definition at line 165 of file a_rvp_php_sdk_object.class.php.

                         {
        $ret = false;
        
        $ret = $this->_save_change_record($this->_save_data());
        
        return $ret;
    }

id()

id ( )

inherited

Returns

the integer ID of the object; unique in the object's database.

Definition at line 177 of file a_rvp_php_sdk_object.class.php.

                  {
        return $this->_object_id;
    }

name()

name ( )

inherited

This requires a load, but not a "detailed" load.

Returns

the string name of the object. This is the generic "object_name" column that all records have.

Definition at line 187 of file a_rvp_php_sdk_object.class.php.

                    {
        $ret = NULL;
        
        $this->_load_data();

        if (isset($this->_object_data) && isset($this->_object_data->name)) {
            $ret = $this->_object_data->name;
        }
        
        return $ret;
    }

set_name()

set_name (   $in_new_value )

inherited

This sets the name of the object.

Returns

true, if the save worked.

Parameters

$in_new_value

REQUIRED: A new value for the name.

Definition at line 205 of file a_rvp_php_sdk_object.class.php.

                          {
        $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;
    }

lang()

lang ( )

inherited

This requires a load, but not a "detailed" load.

Returns

the string for the object's "lang" (language code) field.

Definition at line 226 of file a_rvp_php_sdk_object.class.php.

                    {
        $ret = NULL;
        
        $this->_load_data();
        
        if (isset($this->_object_data) && isset($this->_object_data->lang)) {
            $ret = $this->_object_data->lang;
        }
        
        return $ret;
    }

set_lang()

set_lang (   $in_new_value )

inherited

This sets the language ID of the object.

Returns

true, if the save worked.

Parameters

$in_new_value

REQUIRED: A new value for the language ID.

Definition at line 244 of file a_rvp_php_sdk_object.class.php.

                          {
        $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;
    }

object_access()

object_access ( )

inherited

This requires a load, but not a "detailed" load.

Returns

an associative array ('read' => integer, 'write' => integer), with the tokens for the object. The tokens will only be available if they are visible to the current user, or NULL, if there are no tokens (should never happen).

Definition at line 265 of file a_rvp_php_sdk_object.class.php.

                             {
        $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;
    }

set_object_access()

set_object_access (   $in_new_read = NULL,   $in_new_write = NULL  )

inherited

This sets the read and write tokens of the object.

The current login must have at least read access to each of the tokens. If a token is NULL, then the token is not changed.

Returns

true, if the save worked.

Parameters

$in_new_read	OPTIONAL: A new read token. Default is NULL (no change).
$in_new_write	OPTIONAL: A new write token. Default is NULL (no change).

Definition at line 303 of file a_rvp_php_sdk_object.class.php.

                                  {
        $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;
    }

writeable()

writeable ( )

inherited

This requires a load, but not a "detailed" load.

Returns

true, if the current login can write/modify this object.

Definition at line 326 of file a_rvp_php_sdk_object.class.php.

                         {
        $ret = false;
        
        $this->_load_data();
        
        if (isset($this->_object_data) && isset($this->_object_data->writeable) && $this->_object_data->writeable) {
            $ret = true;
        }
        
        return $ret;
    }

last_access()

last_access ( )

inherited

This requires a load, but not a "detailed" load.

Returns

the last access date, as a timedate integer.

Definition at line 344 of file a_rvp_php_sdk_object.class.php.

                           {
        $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;
    }

force_reload()

force_reload (   $in_parents = false )

inherited

This forces at least a detailed load.

This reloads the information, refreshing the object, if necessary.

Returns

true, if successful.

Parameters

$in_parents

OPTIONAL: Default is false. If true, then the parent info is also loaded.

Definition at line 364 of file a_rvp_php_sdk_object.class.php.

                          {
        return $this->_load_data(true, true, $in_parents);
    }

---

The documentation for this class was generated from the following file:

• rvp_php_sdk_user.class.php