/web_app/src/fetcher/lmbFetcher.class.php

<?php
/*
 * Limb PHP Framework
 *
 * @link http://limb-project.com
 * @copyright  Copyright &copy; 2004-2009 BIT(http://bit-creative.com)
 * @license    LGPL http://www.gnu.org/copyleft/lesser.html
 */
lmb_require('limb/core/src/lmbCollection.class.php');

/**
 * abstract class lmbFetcher.
 *
 * @package web_app
 * @version $Id: lmbFetcher.class.php 7486 2009-01-26 19:13:20Z pachanga $
 */
abstract class lmbFetcher
{
  protected $decorators = array();
  protected $order_params = array();
  protected $offset = 0;
  protected $limit = 0;

  function __construct()
  {
    $this->_collectDecorators();
  }

  function setOffset($offset)
  {
    $this->offset = $offset;
  }

  function setLimit($limit)
  {
    $this->limit = $limit;
  }

  function setOrder($order)
  {
    if(is_array($order))
    {
      $this->order_params = $order;
      return;
    }
    else
      $this->order_params = self :: extractOrderPairsFromString($order);
  }

  function addDecorator($decorator, $params = array())
  {
    $this->decorators[] = array($decorator, $params);
  }

  protected function _applyDecorators($dataset)
  {
    $toolkit = lmbToolkit :: instance();

    foreach($this->decorators as $decorator_data)
    {
      $class_path = new lmbClassPath($decorator_data[0]);
      $dataset = $class_path->createObject(array($dataset));
      $this->_addParamsToDataset($dataset, $decorator_data[1]);
    }
    return $dataset;
  }

  protected function _addParamsToDataset($dataset, $params)
  {
    foreach($params as $param => $value)
    {
      $method = lmb_camel_case('set_'.$param, false);
      $dataset->$method($value);
    }
  }

  protected function _collectDecorators(){}

  function fetch()
  {
    $res = $this->_createDataSet();

    if(is_array($res))
      $dataset = new lmbCollection($res);
    elseif(is_object($res))
      $dataset = $res;
    else
      $dataset = new lmbCollection();

    $dataset = $this->_applyDecorators($dataset);
    if(is_array($this->order_params) && count($this->order_params))
      $dataset->sort($this->order_params);

    if($this->offset || $this->limit)
    {
      if(!$this->limit)
        $this->limit = $dataset->count();

      $dataset->paginate($this->offset, $this->limit);
    }
    return $dataset;
  }

  function fetchOne()
  {
    $dataset = $this->fetch();
    $dataset->rewind();
    if($dataset->valid())
      return $dataset->current();
  }

  static function extractOrderPairsFromString($order_string)
  {
    $order_items = explode(',', $order_string);
    $order_pairs = array();
    foreach($order_items as $order_pair)
    {
      $arr = explode('=', $order_pair);

      if(isset($arr[1]))
      {
        if(strtolower($arr[1]) == 'asc' || strtolower($arr[1]) == 'desc'
           || strtolower($arr[1]) == 'rand()')
          $order_pairs[$arr[0]] = strtoupper($arr[1]);
        else
          throw new lmbException('Wrong order type', array('order' => $arr[1]));
      }
      else
        $order_pairs[$arr[0]] = 'ASC';
    }

    return $order_pairs;
  }
}