system/classes/inforecords.php

<?php
namespace Habari;

abstract class InfoRecords implements URLProperties
{
  // the info array
  protected $__inforecord_array = array();
  // table which contains the info records
  protected $_table_name;
  // name of the primary key in the info record table
  protected $_key_name;
  // value of the primary key - the master record
  protected $_key_value;
  // set to true only when the inforecords have been loaded
  protected $_loaded = false;
  // set to true if any values here have been changed but not saved
  protected $_dirty = false;

  protected $url_args;

  public function __construct( $table_name, $key_name, $key_value = null )
  {
    $this->_table_name = $table_name;
    $this->_key_name = $key_name;
    $this->_key_value = $key_value;
    $this->_loaded = false;
  }

  public function is_key_set()
  {
    return isset( $this->_key_value );
  }

  public function set_key( $metadata_key )
  {
    $this->_key_value = $metadata_key;
  }

  protected function _load()
  {
    if ( $this->_loaded == true ) {
      return;
    }
    if ( empty($this->_key_value) ) {
      return;
    }

    // This InfoRecord is read-only?
    if ( empty($this->_table_name) ) {
      return;
    }

    $result = DB::get_results( '
      SELECT name, value, type
      FROM ' . $this->_table_name . '
      WHERE ' . $this->_key_name . ' = ?',
      array( $this->_key_value )
    );

    foreach ( $result as $result_element ) {
      // XXX is this logic right?
      if ( $result_element->type == 1 ) {
        $this->__inforecord_array[$result_element->name] = array( 'value' => unserialize( $result_element->value ) );
      }
      else {
        $this->__inforecord_array[$result_element->name] = array( 'value' => $result_element->value );
      }
    }

    $this->_loaded = true;
  }

  public function __get ( $name )
  {
    $this->_load();
    if ( ! isset( $this->__inforecord_array[$name] ) ) {
      return false;
    }
    return $this->__inforecord_array[$name]['value'];
  }

  public function getArrayCopy ( ) {
    $this->_load();

    $result = array();
    foreach ( $this->__inforecord_array as $k => $v ) {
      $result[ $k ] = $v['value'];
    }

    return $result;
  }

  public function __set( $name, $value )
  {
    $this->_load();
    $this->__inforecord_array[$name] = array('changed'=>true, 'value'=>$value);
    $this->_dirty = true;
    $self = $this;
    register_shutdown_function(function() use ($self){
      $self->commit();
    });
  }

  public function __isset ( $name )
  {
    $this->_load();
    return isset( $this->__inforecord_array[$name] );
  }

  public function __unset( $name )
  {
    $this->_load();
    if ( isset( $this->__inforecord_array[$name] ) ) {
      DB::delete( $this->_table_name, array ( $this->_key_name => $this->_key_value, "name" => $name ) );
      unset( $this->__inforecord_array[$name] );
      return true;
    }
    return false;
  }

  public function get_url_args()
  {
    if ( !$this->url_args ) {
      $this->_load();
      $this->url_args = array_map( function($element) { return $element['value']; }, $this->__inforecord_array );
    }
    return $this->url_args;
  }

  public function delete_all()
  {
    // This InfoRecord is read-only?
    if ( empty($this->_table_name) ) {
      return false;
    }
    $result = DB::query( '
      DELETE FROM ' . $this->_table_name . '
      WHERE ' . $this->_key_name . ' = ?',
      array( $this->_key_value )
    );
    if ( Error::is_error( $result ) ) {
      $result->out();
      return false;
    }
    $this->__inforecord_array = array();
    return true;
  }

  public function commit( $metadata_key = null )
  {
    if ( isset( $metadata_key ) ) {
      $this->_key_value = $metadata_key;
    }
    // If the info is not already loaded, and the key value is empty,
    // then we don't have enough info to do the commit
    if ( !$this->_loaded && empty($this->_key_value) ) {
      return false;
    }

    // If there were no changes, do nothing and succeed.  Yay!
    if ( !$this->_dirty ) {
      return true;
    }

    foreach ( (array)$this->__inforecord_array as $name=>$record ) {
      if ( isset( $record['changed'] ) && $record['changed'] ) {
        $value = $record['value'];
        if ( is_array( $value ) || is_object( $value ) ) {
          $result = DB::update(
            $this->_table_name,
            array(
              $this->_key_name=>$this->_key_value,
              'name'=>$name,
              'value'=>serialize( $value ),
              'type'=>1
            ),
            array( 'name'=>$name, $this->_key_name=>$this->_key_value )
          );
        }
        else {
          $result = DB::update(
            $this->_table_name,
            array(
              $this->_key_name=>$this->_key_value,
              'name'=>$name,
              'value'=>$value,
              'type'=>0
            ),
            array('name'=>$name, $this->_key_name=> $this->_key_value)
          );
        }

        if ( Error::is_error( $result ) ) {
          $result->out();
        }
        $this->__inforecord_array[$name] = array('value'=>$value);
      }
    }
    $this->_dirty = false;
    return true;
  }

  public function count()
  {
    $this->_load();
    return count( $this->__inforecord_array );
    
  }

}

?>