<?php 

/**
 * 
 * If a dimension uses this method then users MUST HAVE permissions over the 
 * object's members of this dimension in order to see the object, 
 * no matter if user has permissions over other members of other dimensions.
 */
define('DIMENSION_PERMISSION_QUERY_METHOD_MANDATORY', 'mandatory');
/**
 * 
 * If a dimension uses this method then users may not have permissions over the 
 * object's members of this dimension but he/she can see it because it has
 * permissions over other object's members of other dimensions.
 */
define('DIMENSION_PERMISSION_QUERY_METHOD_NOT_MANDATORY', 'not_mandatory');

  /**
  * BaseDimensions class
  *
  * @author Diego Castiglioni <diego.castiglioni@fengoffice.com>
  */
  abstract class BaseDimensions extends DataManager {
  
    /**
    * Column name => Column type map
    *
    * @var array
    * @static
    */
    static private $columns = array(
    	'id' => DATA_TYPE_INTEGER, 
    	'code' => DATA_TYPE_STRING,
    	'name' => DATA_TYPE_STRING, 
    	'is_root' => DATA_TYPE_BOOLEAN, 
    	'is_manageable' => DATA_TYPE_BOOLEAN, 
    	'allows_multiple_selection' => DATA_TYPE_BOOLEAN, 
    	'defines_permissions' => DATA_TYPE_BOOLEAN, 	
    	'is_system' => DATA_TYPE_BOOLEAN,
    	'is_default' => DATA_TYPE_BOOLEAN,
    	'default_order' => DATA_TYPE_INTEGER,
    	'options' => DATA_TYPE_STRING,
    	'permission_query_method' => DATA_TYPE_STRING,
    	'is_required' => DATA_TYPE_BOOLEAN,
    );
  
    /**
    * Construct
    *
    * @return BaseDimensions 
    */
    function __construct() {
      parent::__construct('Dimension', 'dimensions', true);
    } // __construct
    
    // -------------------------------------------------------
    //  Description methods
    // -------------------------------------------------------
    
    /**
    * Return array of object columns
    *
    * @access public
    * @param void
    * @return array
    */
    function getColumns() {
      return array_keys(self::$columns);
    } // getColumns
    
    /**
    * Return column type
    *
    * @access public
    * @param string $column_name
    * @return string
    */
    function getColumnType($column_name) {
      if(isset(self::$columns[$column_name])) {
        return self::$columns[$column_name];
      } else {
        return DATA_TYPE_STRING;
      } // if
    } // getColumnType
    
    /**
    * Return array of PK columns. If only one column is PK returns its name as string
    *
    * @access public
    * @param void
    * @return array or string
    */
    function getPkColumns() {
      return 'id';
    } // getPkColumns
    
    /**
    * Return name of first auto_incremenent column if it exists
    *
    * @access public
    * @param void
    * @return string
    */
    function getAutoIncrementColumn() {
      return 'id';
    } // getAutoIncrementColumn
    
    // -------------------------------------------------------
    //  Finders
    // -------------------------------------------------------
    
    /**
    * Do a SELECT query over database with specified arguments
    *
    * @access public
    * @param array $arguments Array of query arguments. Fields:
    * 
    *  - one - select first row
    *  - conditions - additional conditions
    *  - order - order by string
    *  - offset - limit offset, valid only if limit is present
    *  - limit
    * 
    * @return one or Dimensions objects
    * @throws DBQueryError
    */
    function find($arguments = null) {
      if(isset($this) && instance_of($this, 'Dimensions')) {
        return parent::find($arguments);
      } else {
        return Dimensions::instance()->find($arguments);
      } // if
    } // find
    
    /**
    * Find all records
    *
    * @access public
    * @param array $arguments
    * @return one or Dimensions objects
    */
    function findAll($arguments = null) {
      if(isset($this) && instance_of($this, 'Dimensions')) {
        return parent::findAll($arguments);
      } else {
        return Dimensions::instance()->findAll($arguments);
      } // if
    } // findAll
    
    /**
    * Find one specific record
    *
    * @access public
    * @param array $arguments
    * @return Dimension 
    */
    function findOne($arguments = null) {
      if(isset($this) && instance_of($this, 'Dimensions')) {
        return parent::findOne($arguments);
      } else {
        return Dimensions::instance()->findOne($arguments);
      } // if
    } // findOne
    
    /**
    * Return object by its PK value
    *
    * @access public
    * @param mixed $id
    * @param boolean $force_reload If true cache will be skipped and data will be loaded from database
    * @return Dimension 
    */
    function findById($id, $force_reload = false) {
      if(isset($this) && instance_of($this, 'Dimensions')) {
        return parent::findById($id, $force_reload);
      } else {
        return Dimensions::instance()->findById($id, $force_reload);
      } // if
    } // findById
    
    /**
    * Return number of rows in this table
    *
    * @access public
    * @param string $conditions Query conditions
    * @return integer
    */
    function count($condition = null) {
      if(isset($this) && instance_of($this, 'Dimensions')) {
        return parent::count($condition);
      } else {
        return Dimensions::instance()->count($condition);
      } // if
    } // count
    
    /**
    * Delete rows that match specific conditions. If $conditions is NULL all rows from table will be deleted
    *
    * @access public
    * @param string $conditions Query conditions
    * @return boolean
    */
    function delete($condition = null) {
      if(isset($this) && instance_of($this, 'Dimensions')) {
        return parent::delete($condition);
      } else {
        return Dimensions::instance()->delete($condition);
      } // if
    } // delete
    
    /**
    * This function will return paginated result. Result is an array where first element is 
    * array of returned object and second populated pagination object that can be used for 
    * obtaining and rendering pagination data using various helpers.
    * 
    * Items and pagination array vars are indexed with 0 for items and 1 for pagination
    * because you can't use associative indexing with list() construct
    *
    * @access public
    * @param array $arguments Query argumens (@see find()) Limit and offset are ignored!
    * @param integer $items_per_page Number of items per page
    * @param integer $current_page Current page number
    * @return array
    */
    function paginate($arguments = null, $items_per_page = 10, $current_page = 1, $count = null) {
      if(isset($this) && instance_of($this, 'Dimensions')) {
        return parent::paginate($arguments, $items_per_page, $current_page);
      } else {
        return Dimensions::instance()->paginate($arguments, $items_per_page, $current_page);
      } // if
    } // paginate
    
    /**
    * Return manager instance
    *
    * @return Dimensions 
    */
    static function instance() {
      static $instance;
      if(!instance_of($instance, 'Dimensions')) {
        $instance = new Dimensions();
      } // if
      return $instance;
    } // instance
  
  } // BaseDimensions 

?>