Inheritance diagram for A_RVP_PHP_SDK_Object:

Public Member Functions
	__construct ( $in_sdk_object, $in_id, $in_data=NULL, $in_detailed_data=false, $in_plugin_path='baseline')

	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
	_load_data ( $in_force=false, $in_details=false, $in_parents=false)

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

	_save_change_record ( $in_change_record_object)

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

This is an abstract base class for various data objects provided by the SDK. It deals with the "top-level" common data, like the read/write tokens, name and localization code.

This class will provide the history list, links to the SDK object, the basic JSON data object, as well as a bit of state.

It is a generic class that serves both the data and security databases.

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

Constructor & Destructor Documentation

◆ __construct()

__construct	(	$in_sdk_object,
		$in_id,
		$in_data = `NULL`,
		$in_detailed_data = `false`,
		$in_plugin_path = `'baseline'`
	)

The basic constructor for the class. You have the option of "priming" the object with information.

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.
$in_plugin_path	OPTIONAL: This is a path that is added to the server, to fetch data. Default is "baseline."

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

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

Member Function Documentation

◆ _load_data()

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

protected

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

Once it receives the object, it JSON-decodes it, and stores it in the _object_data internal field.

Subclasses will usually overload this, then apply their own filtering to the data after calling this parent method.

Returns: true, if it loaded the data.

Parameters

$in_force	OPTIONAL: Default is false. If true, 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 57 of file a_rvp_php_sdk_object.class.php.

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

◆ _save_data()

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

protected

This actually sends the data through the API to the server, and returns the response object.

Returns: the JSON change object. NULL if not 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	OPTIONAL: Any payload to be asociated with this object. Must be an associative array (['data' => data, 'type' => MIME Type string]).
$in_new_child_ids	IGNORED. Just here to suppress PHP warnings.

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

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

◆ _save_change_record()

_save_change_record ( $in_change_record_object )

abstractprotected

This is called after a successful save. It has the change record[s], and the subclass should take care of parsing that record to save in the object's change record.

It's important that subclasses apply their own parsing, as the response data is different, between people, places and things.

Returns: true, if the save was successful.

Parameters

$in_change_record_object REQUIRED: The change response, as a parsed object.

◆ set_sdk_object()

set_sdk_object ( $in_sdk_object )

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 ( )

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 ( )

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 ( )

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 ( )

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 )

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 ( )

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 )

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 ( )

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`
	)

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 ( )

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 ( )

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 )

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:

a_rvp_php_sdk_object.class.php

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ _load_data()

◆ _save_data()

◆ _save_change_record()

◆ set_sdk_object()

◆ changes()

◆ save_data()

◆ id()

◆ name()

◆ set_name()

◆ lang()

◆ set_lang()

◆ object_access()

◆ set_object_access()

◆ writeable()

◆ last_access()

◆ force_reload()