Inheritance diagram for A_CO_DB_Table_Base:

Collaboration diagram for A_CO_DB_Table_Base:

Public Member Functions
	__construct ( $in_db_object=NULL, $in_db_result=NULL)

	set_batch_mode ()

	clear_batch_mode ()

	load_from_db ( $in_db_result)

	id ()

	lock ()

	locked ()

	danger_will_robinson_danger_clear_id ()

	user_can_read ()

	user_can_write ()

	set_read_security_id ($in_new_id)

	set_write_security_id ($in_new_id)

	set_name ($in_new_value)

	delete_from_db ()

	update_db ()

	reload_from_db ()

	get_access_object ()

	get_lang ()

	set_lang ( $in_lang_id=NULL)

Public Attributes
	$class_description
	This is a description of the class (not the instance). More...

	$instance_description
	This is a description that describes the instance. More...

	$last_access
	This is a UNIX epoch date that describes the last modification. The default is UNIX Day Two (in case of UTC timezone issues). More...

	$name
	This is the "object_name" string field. More...

	$read_security_id
	This is a single integer, defining the security ID required to view the record. If it is 0, then it is "open.". More...

	$write_security_id
	This is a single integer, defining the required security token to modify the record. If it is 0, then any logged-in user can modify. More...

	$context
	This is a mixed associative array, containing fields for the object. More...

	$error
	If there is an error, it is contained here, in a LGV_Error instance. More...

Protected Member Functions
	_default_setup ()

	_build_parameter_array ()

	_badger_serialize ( $in_data)

	_badger_unserialize ( $in_data)

	_write_to_db ()

	_seppuku ()

Protected Attributes
	$_db_object
	This is the actual database object that "owns" this instance. It should not be exposed beyond this class or subclasses, thereof. More...

	$_id
	This is the within-table unique ID of this record. More...

	$_batch_mode
	If this is true, then the write_record call will not be made in update_db. It will be done when clear_batch_mode() is called, instead. More...

Detailed Description

This is the abstract base class for All database records used by Badger.

Badger works on a very simple basis. All records, regardless of their ultimate implementation, have the same basic structure.

The data and security database tables each take a slightly different tack from the baseline, but this class describes the baseline, which is common to both tabases and tables.

Definition at line 43 of file a_co_db_table_base.class.php.

Constructor & Destructor Documentation

◆ __construct()

A_CO_DB_Table_Base::__construct	(	$in_db_object = `NULL`,
		$in_db_result = `NULL`
	)

This is the basic constructor.

Parameters

$in_db_object	This is the database instance that "owns" this record.
$in_db_result	This is a database-format associative array that is used to initialize this instance.

Reimplemented in CO_Owner, CO_Security_ID, and CO_Security_Node.

Definition at line 179 of file a_co_db_table_base.class.php.

                                   {
         $this->class_description = '';
         $this->_id = NULL;
         $this->last_access = time();
         $this->read_security_id = 0;
         $this->write_security_id = 0;
         $this->name = NULL;
         $this->context = NULL;
         $this->instance_description = NULL;
         $this->_db_object = $in_db_object;
         $this->error = NULL;
         
         if ($in_db_object) {
             if (!$in_db_result) {
                 $in_db_result = $this->_default_setup();
             }
         
             $this->load_from_db($in_db_result);
         }
     }

References _default_setup(), and load_from_db().

Here is the call graph for this function:

Member Function Documentation

◆ _badger_serialize()

A_CO_DB_Table_Base::_badger_serialize ( $in_data )

protected

This is just a 1-step abstraction for serializing data.

Returns: the serialized data, as a string.

Parameters

$in_data This is the data to be serialized.

Definition at line 109 of file a_co_db_table_base.class.php.

                                           {
         return serialize($in_data);
     }

Referenced by _build_parameter_array().

Here is the caller graph for this function:

◆ _badger_unserialize()

A_CO_DB_Table_Base::_badger_unserialize ( $in_data )

protected

This is just a 1-step abstarction for unserializing data.

Returns: the un-serialized data, in data/object form.

Parameters

$in_data This is the data to be un-serialized.

Definition at line 120 of file a_co_db_table_base.class.php.

                                           {
         return unserialize($in_data);
     }

Referenced by load_from_db().

Here is the caller graph for this function:

◆ _build_parameter_array()

A_CO_DB_Table_Base::_build_parameter_array ( )

protected

This builds up the basic section of the instance database record. It should be overloaded, and the parent called before adding new fields.

Returns: an associative array, in database record form.

Reimplemented in CO_Security_Login, CO_LL_Location, CO_Security_Node, and CO_Main_DB_Record.

Definition at line 83 of file a_co_db_table_base.class.php.

                                                 {
         $ret = Array();
         
         if ($this instanceof CO_Security_ID) {
             $this->write_security_id = -1;          // These always have a -1
             $this->read_security_id = $this->id();  // These always have their own ID set as the read ID
         }
             
         $ret['id'] = $this->id();
         $ret['access_class'] = strval(get_class($this));
         $ret['last_access'] = strval(date('Y-m-d H:i:s'));
         $ret['read_security_id'] = intval($this->read_security_id);
         $ret['write_security_id'] = intval($this->write_security_id);
         $name = trim(strval($this->name));
         $ret['object_name'] = $name ? $name : NULL;
         $ret['access_class_context'] = $this->context ? $this->_badger_serialize($this->context) : NULL;   // If we have a context, then we serialize it for the DB.
         
         return $ret;
     }

References $name, _badger_serialize(), and id().

Referenced by _write_to_db().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _default_setup()

A_CO_DB_Table_Base::_default_setup ( )

protected

This is called to populate the object fields for this class with default values. These use the SQL table tags.

This should be subclassed, and the parent should be called before applying specific instance properties.

Returns: An associative array, simulating a database read.

Reimplemented in CO_Security_Login, CO_LL_Location, CO_Security_Node, and CO_Main_DB_Record.

Definition at line 67 of file a_co_db_table_base.class.php.

                                         {
         return Array(   'id'                    => 0,
                         'last_access'           => 86400,   // Default is first UNIX day.
                         'object_name'           => '',
                         'read_security_id'      => 0,
                         'write_security_id'     => 0,
                         'access_class_context'  => NULL
                         );
     }

Referenced by __construct().

Here is the caller graph for this function:

◆ _seppuku()

A_CO_DB_Table_Base::_seppuku ( )

protected

This function deletes this object's record from the database.

It should be noted that a successful seppuku means the instance is no longer viable, and the ID is set to 0, which makes it a new record (if saved).

Definition at line 161 of file a_co_db_table_base.class.php.

                                   {
         $ret = false;
         
         if ($this->id() && isset($this->_db_object)) {
             $ret = $this->_db_object->delete_record($this->id());
             if ($ret) {
                 $this->_id = 0; // Make sure we have no more ID. If anyone wants to re-use this instance, it needs to become a new record.
             }
         }
         
         return $ret;
     }

Referenced by delete_from_db().

Here is the caller graph for this function:

◆ _write_to_db()

A_CO_DB_Table_Base::_write_to_db ( )

protected

This is the fundamental database write function. It's a "trigger," and the state of the instance is what is written. If the 'id' field is 0, then a new databse row is created.

This calls the _build_parameter_array() function to create a database-format associative array that is interpreted into SQL by the "owning" database object.

Returns: false if there was an error. Otherwise, it returns the ID of the element just written (or created).

Definition at line 133 of file a_co_db_table_base.class.php.

                                       {
         $ret = false;
         
         if (isset($this->_db_object)) {
             $params = $this->_build_parameter_array();
             
             if (isset($params) && is_array($params) && count($params)) {
                 $ret = $this->_db_object->write_record($params);
                 $this->error = $this->get_access_object()->error;
                 if ((1 < intval($ret)) && !$this->error) {
                     $this->_id = intval($ret);
                     if ($this instanceof CO_Security_ID) {
                         $this->read_security_id = $this->id();  // These always have their own ID set as the read ID
                         $this->write_security_id = -1;          // These always have a -1
                     }
                 }
             }
         }
         
         return $ret;
     }

References _build_parameter_array(), get_access_object(), and id().

Referenced by CO_Security_Login\delete_from_db(), and update_db().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ clear_batch_mode()

A_CO_DB_Table_Base::clear_batch_mode ( )

Calling this clears batch mode. It also sees if we were in batch mode previously, in which case, we call the write function.

returns true, if the write function was called and successful.

Definition at line 216 of file a_co_db_table_base.class.php.

                                        {
         $ret = false;
         
         $call_update = $this->_batch_mode;
         $this->_batch_mode = false;
         if ($call_update) {
             $ret = $this->update_db();
             if (method_exists($this, '_scrub')) {
                 $this->_scrub();
             }
         }
         
         return $ret;
     }

References $_batch_mode, and update_db().

Here is the call graph for this function:

◆ danger_will_robinson_danger_clear_id()

A_CO_DB_Table_Base::danger_will_robinson_danger_clear_id ( )

VERY DANGEROUS! This only exists as a utility for the deleter. It has to be public, because PHP does not allow "friend" classes.

DON'T CALL THIS!

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

                                                            {
         $this->_id = 0;
     }

◆ delete_from_db()

A_CO_DB_Table_Base::delete_from_db ( )

This is the public database record deleter.

This checks to make sure the user has write permission before deleting.

Returns: true, if the deletion was successful.

Reimplemented in CO_Security_Login.

Definition at line 444 of file a_co_db_table_base.class.php.

                                      {
         if ($this->user_can_write()) {
             return $this->_seppuku();
         } else {
             return false;
         }
     }

References _seppuku(), and user_can_write().

Here is the call graph for this function:

◆ get_access_object()

A_CO_DB_Table_Base::get_access_object ( )

Returns: the access object for this instance.

Definition at line 494 of file a_co_db_table_base.class.php.

                                         {
         $db_object = $this->_db_object;
         
         if (isset($db_object)) {
             return $db_object->access_object;
         }
         
         return NULL;
     }

References $_db_object.

Here is the caller graph for this function:

◆ get_lang()

A_CO_DB_Table_Base::get_lang ( )

Returns: a string, with the language ID for this login.

Reimplemented in CO_User_Collection, and CO_Security_Login.

Definition at line 508 of file a_co_db_table_base.class.php.

                                {
         $ret = CO_Config::$lang;
         
         // We replace the default only if we have a valid lang value.
         if (isset($this->context['lang']) && trim($this->context['lang'])) {
             $ret = strtolower(trim($this->context['lang']));    // Should be unneccessary, but belt and suspenders...
         }
         
         return $ret;
     }

References $lang.

◆ id()

A_CO_DB_Table_Base::id ( )

Simple accessor for the ID.

Returns: the integer ID of the instance.

Definition at line 299 of file a_co_db_table_base.class.php.

                          {
         return $this->_id;
     }

References $_id.

Referenced by CO_Security_ID\__construct(), _build_parameter_array(), _write_to_db(), CO_Security_Login\is_god(), load_from_db(), and CO_Security_ID\load_from_db().

Here is the caller graph for this function:

◆ load_from_db()

A_CO_DB_Table_Base::load_from_db ( $in_db_result )

This function sets up this instance, according to the DB-formatted associative array passed in.

This should be subclassed, and the parent should be called before applying specific instance properties.

Returns: true, if the instance was able to set itself up to the provided array.

Parameters

$in_db_result This is an associative array, formatted as a database row response.

Reimplemented in CO_Security_Login, CO_Security_ID, CO_Login_Manager, CO_Cobra_Login, CO_User_Collection, CO_US_Place_Collection, CO_Place_Collection, CO_Owner, CO_KeyValue_CO_Collection, CO_Collection, CO_LL_Location, and CO_Main_DB_Record.

Definition at line 239 of file a_co_db_table_base.class.php.

                                   {
         $ret = false;
         $this->last_access = max(86400, time());    // Just in case of badly-set clocks in the server.
         
         if (isset($this->_db_object) && isset($in_db_result) && isset($in_db_result['id']) && intval($in_db_result['id'])) {
             $ret = true;
             $this->_id = intval($in_db_result['id']);
             
             if (isset($in_db_result['last_access'])) {
                 $date_from_db = date_create_from_format('Y-m-d H:i:s', $in_db_result['last_access']);
                 $timestamp = date_timestamp_get($date_from_db);
                 $this->last_access = max(86400, $timestamp);
             }
         
             if (isset($in_db_result['read_security_id']) && intval($in_db_result['read_security_id'])) {
                 $this->read_security_id = intval($in_db_result['read_security_id']);
             }
             
             if ($this instanceof CO_Security_ID) {
                 $this->write_security_id = -1;          // These always have a -1
                 if ($this->id()) {
                     $this->read_security_id = $this->id();   // These always have their own ID set as the read ID
                 }
             } else {
                 if (isset($in_db_result['write_security_id'])) {
                     $this->write_security_id = intval($in_db_result['write_security_id']);
                 } else {
                     $this->write_security_id = $this->read_security_id ? -1 : intval($this->write_security_id);  // Writing is completely blocked if we have read security, but no write security specified.
                 }
             }
             
             if (isset($in_db_result['object_name'])) {
                 $this->name = strval($in_db_result['object_name']);
             }
             
             if (isset($in_db_result['access_class_context'])) {
                 $serialized_context = trim(strval($in_db_result['access_class_context']));
                 if (isset($serialized_context) && $serialized_context) {
                     $serialized_context = stripslashes($serialized_context);
                     $temp_context = $this->_badger_unserialize($serialized_context);
     
                     if ($temp_context) {
                         $this->context = $temp_context;
                     }
                 }
             }
         }
         
         $this->class_description = 'Abstract Base Class for Records -Should never be instantiated.';
  
         return $ret;
     }

References _badger_unserialize(), and id().

Referenced by __construct(), and reload_from_db().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ lock()

A_CO_DB_Table_Base::lock ( )

Locks the resource by setting the read_security_id column to -2.

Returns: an integer; the previous contents of the read_security_id column.

Definition at line 309 of file a_co_db_table_base.class.php.

                            {
         return $this->_db_object->lock_record($this->id());
     }

◆ locked()

A_CO_DB_Table_Base::locked ( )

Returns: true, if the record is currently locked.

Definition at line 317 of file a_co_db_table_base.class.php.

                              {
         return $this->read_security_id == -2;
     }

◆ reload_from_db()

A_CO_DB_Table_Base::reload_from_db ( )

This gets the object data from the database, using the instance's ID, and reloads everything. It throws out the current state, and replaces it with the one stored in the database.

Returns: true, if successful

Definition at line 479 of file a_co_db_table_base.class.php.

                                      {
         $ret = false;
         $db_result = $this->_db_object->get_single_raw_row_by_id($this->id());
         $this->error = $this->get_access_object()->error;
         if (!isset($this->error) || !$this->error) {
             $ret = $this->load_from_db($db_result);
         }
         
         return $ret;
     }

References get_access_object(), and load_from_db().

Referenced by CO_Security_Login\add_personal_token_from_current_login(), and CO_Security_Login\remove_personal_token_from_this_login().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ set_batch_mode()

A_CO_DB_Table_Base::set_batch_mode ( )

Calling this sets the object into "batch mode," where we don't call the write function (we're saving it up).

Definition at line 206 of file a_co_db_table_base.class.php.

                                      {
         $this->_batch_mode = true;
     }

◆ set_lang()

A_CO_DB_Table_Base::set_lang ( $in_lang_id = NULL )

Returns: true, if the set was successful.

Parameters

$in_lang_id The lang ID. This is not used for the low-level error handlers (which use the server setting). It is used to determine higher-level strings.

Reimplemented in CO_Security_Login.

Definition at line 523 of file a_co_db_table_base.class.php.

                               {
         $ret = false;
         
         if ($this->user_can_write()) {
             $this->context['lang'] = strtolower(trim(strval($in_lang_id)));
             $ret = $this->update_db();
         }
         
         return $ret;
     }

References update_db(), and user_can_write().

Here is the call graph for this function:

◆ set_name()

A_CO_DB_Table_Base::set_name ( $in_new_value )

Setter Accessor for the Object Name. Also updates the DB.

Returns: true, if a DB update was successful.

Parameters

$in_new_value The new value

Definition at line 424 of file a_co_db_table_base.class.php.

                               {
         $ret = false;
         
         if (isset($in_new_value)) {
             $this->name = strval($in_new_value);
             $ret = $this->update_db();
         }
         
         return $ret;
     }

References update_db().

Here is the call graph for this function:

◆ set_read_security_id()

A_CO_DB_Table_Base::set_read_security_id ( $in_new_id )

Setter Accessor for the Read Security ID. Also updates the DB.

This checks to make sure the user has write permission before changing the ID.

Returns: true, if a DB update was successful.

Parameters

$in_new_id The new value

Definition at line 388 of file a_co_db_table_base.class.php.

                                           {
         $ret = false;
         if ($this->user_can_write() && isset($in_new_id)) {
             $this->read_security_id = intval($in_new_id);
             $ret = $this->update_db();
         }
         
         return $ret;
     }

References update_db(), and user_can_write().

Here is the call graph for this function:

◆ set_write_security_id()

A_CO_DB_Table_Base::set_write_security_id ( $in_new_id )

Setter Accessor for the Write Security ID. Also updates the DB.

This checks to make sure the user has write permission before changing the ID.

Returns: true, if a DB update was successful.

Parameters

$in_new_id The new value

Definition at line 407 of file a_co_db_table_base.class.php.

                                           {
         $ret = false;
         if ($this->user_can_write() && isset($in_new_id)) {
             $this->write_security_id = intval($in_new_id);
             $ret = $this->update_db();
         }
         
         return $ret;
     }

References update_db(), and user_can_write().

Here is the call graph for this function:

◆ update_db()

A_CO_DB_Table_Base::update_db ( )

This is a "trigger" to update the database with the current instance state.

This checks to make sure the user has write permission before saving.

Returns: true, if a DB update was successful.

Reimplemented in CO_LL_Location.

Definition at line 460 of file a_co_db_table_base.class.php.

                                 {
         if (!$this->id() || $this->user_can_write()) {
             if (!$this->_batch_mode) {
                 return $this->_write_to_db();
             } else {
                 return true;
             }
         } else {
             return false;
         }
     }

References _write_to_db(), and user_can_write().

Referenced by CO_Security_Login\add_id(), CO_Security_Login\clear_api_key(), clear_batch_mode(), CO_Security_Login\set_ids(), set_lang(), CO_Security_Login\set_lang(), set_name(), CO_Main_DB_Record\set_owner_id(), CO_Security_Login\set_password_from_cleartext(), CO_Main_DB_Record\set_payload(), CO_Security_Login\set_personal_ids(), set_read_security_id(), CO_Main_DB_Record\set_tag(), CO_Main_DB_Record\set_tags(), and set_write_security_id().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ user_can_read()

A_CO_DB_Table_Base::user_can_read ( )

Returns: true, if the current logged-in user has read permission on this record.

Reimplemented in CO_Security_ID.

Definition at line 335 of file a_co_db_table_base.class.php.

                                     {
         $ret = false;
         
         $ids = $this->get_access_object()->get_security_ids();
         
         $my_read_item = intval($this->read_security_id);
         $my_write_item = intval($this->write_security_id);
         
         if ((0 == $my_read_item) || $this->get_access_object()->god_mode()) {
             $ret = true;
         } else {
             if (isset($ids) && is_array($ids) && count($ids)) {
                 $ret = in_array($my_read_item, $ids) || in_array($my_write_item, $ids);
             }
         }
         
         if (!$ret && $this->get_access_object()->get_login_id()) {
             $ret = (1 == $my_read_item);  // Logged-in users can read 1s.
         }
         
         return $ret;
     }

References get_access_object().

Here is the call graph for this function:

◆ user_can_write()

A_CO_DB_Table_Base::user_can_write ( )

Returns: true, if the current logged-in user has write permission on this record.

Reimplemented in CO_Security_Login.

Definition at line 362 of file a_co_db_table_base.class.php.

                                      {
         $ret = false;
         
         $ids = $this->get_access_object()->get_security_ids();
         
         $my_write_item = intval($this->write_security_id);
         // We can never edit unless we are logged in.
         if (((isset($ids) && is_array($ids) && count($ids)) && (0 == $my_write_item)) || $this->get_access_object()->god_mode()) {
             $ret = true;
         } else {
             if (isset($ids) && is_array($ids) && count($ids)) {
                 $ret = in_array($my_write_item, $ids);
             }
         }
         
         return $ret;
     }