X-Git-Url: http://git.polytechnique.org/?a=blobdiff_plain;f=classes%2Fplfilter.php;h=609c1cc576d4817e3392d8bdbef7dc0c145afd7e;hb=1623168586bac6073585130fc2aa864345463ac6;hp=ed0e039ecba5463c60dc0b241aacc73e2409087b;hpb=9a122520bc4c6547f6506a0cd35e49737809b1c4;p=platal.git diff --git a/classes/plfilter.php b/classes/plfilter.php index ed0e039..609c1cc 100644 --- a/classes/plfilter.php +++ b/classes/plfilter.php @@ -1,6 +1,6 @@ count)) { + if (!is_null($this->count) && $this->count != 0) { if (!is_null($this->from) && $this->from != 0) { return XDB::format('LIMIT {?}, {?}', (int)$this->from, (int)$this->count); } else { @@ -42,119 +45,124 @@ class PlLimit return ''; } } +// }}} -class PlSqlJoin +// {{{ class PlFilterOrder +/** Base class for ordering results of a query. + * Parameters for the ordering must be given to the constructor ($desc for a + * descending order). + * The getSortTokens function is used to get actual ordering part of the query. + */ +abstract class PlFilterOrder implements PlExportable { - private $mode; - private $table; - private $condition; - - const MODE_LEFT = 'LEFT'; - const MODE_RIGHT = 'RIGHT'; - const MODE_INNER = 'INNER'; - - public function __construct($mode, $table, $condition) + protected $desc = false; + public function __construct($desc = false) { - if ($mode != self::MODE_LEFT && $mode != self::MODE_RIGHT && $mode != self::MODE_INNER) { - Platal::page()->kill("Join mode error : unknown mode $mode"); - return; - } - $this->mode = $mode; - $this->table = $table; - $this->condition = $condition; + $this->desc = $desc; + $this->_tokens = null; } - public function mode() + protected function buildExport($type) { - return $this->mode; + $export = array('type' => $type); + if ($this->desc) { + $export['order'] = 'desc'; + } + return $export; } - public function table() + public function export() { - return $this->table; + throw new Exception("This instance is not exportable"); } - public function condition() + public function toggleDesc() { - return $this->condition; + $this->desc = !$this->desc; } - /** Replace all "metas" in the condition with their translation. - * $ME always becomes the alias of the table - * @param $key The name the joined table will have in the final query - * @param $joinMetas An array of meta => conversion to apply to the condition - */ - public function replaceJoinMetas($key, $joinMetas = array()) + public function setDescending($desc = true) { - $joinMetas['$ME'] = $key; - return str_replace(array_keys($joinMetas), $joinMetas, $this->condition); + $this->desc = $desc; } - /** Create a join command from an array of PlSqlJoin - * @param $joins The list of 'join' to convert into an SQL query - * @param $joinMetas An array of ('$META' => 'conversion') to apply to the joins. - */ - public static function formatJoins(array $joins, array $joinMetas) + public function buildSort(PlFilter $pf) { - $str = ''; - foreach ($joins as $key => $join) { - if (! ($join instanceof PlSqlJoin)) { - Platal::page()->kill("Error: not a join: $join"); - } - $mode = $join->mode(); - $table = $join->table(); - $str .= ' ' . $mode . ' JOIN ' . $table . ' AS ' . $key; - if ($join->condition() != null) { - $str .= ' ON (' . $join->replaceJoinMetas($key, $joinMetas) . ')'; + $sel = $this->getSortTokens($pf); + $this->_tokens = $sel; + if (!is_array($sel)) { + $sel = array($sel); + } + if ($this->desc) { + foreach ($sel as $k => $s) { + $sel[$k] = $s . ' DESC'; } - $str .= "\n"; } - return $str; + return $sel; } + + /** This function must return the tokens to use for ordering + * @param $pf The PlFilter whose results must be ordered + * @return The name of the field to use for ordering results + */ + abstract protected function getSortTokens(PlFilter $pf); } +// }}} -abstract class PlFilterOrder +// {{{ class PlFilterGroupableOrder +/** Extension of a PlFilterOrder, for orders where the value on which ordering + * is done could be used for grouping results (promo, country, ...) + */ +abstract class PlFilterGroupableOrder extends PlFilterOrder { - protected $desc = false; - public function __construct($desc = false) + /** This function will be called when trying to retrieve groups; + * the returned token will be used to group the values. + * It will always be called AFTER getSortTokens(). + */ + public function getGroupToken(PlFilter $pf) { - $this->desc = $desc; + return $this->_tokens; } +} +// }}} - public function toggleDesc() - { - $this->desc = !$desc; - } +// {{{ class PFO_Random +class PFO_Random extends PlFilterOrder +{ + private $seed = null; - public function setDescending($desc = true) + public function __construct($seed = null, $desc = false) { - $this->desc = $desc; + parent::__construct($desc); + $this->seed = $seed; } - public function buildSort(PlFilter &$pf) + protected function getSortTokens(PlFilter $pf) { - $sel = $this->getSortTokens($pf); - if (!is_array($sel)) { - $sel = array($sel); - } - if ($this->desc) { - foreach ($sel as $k => $s) { - $sel[$k] = $s . ' DESC'; - } + if ($this->seed == null) { + return 'RAND()'; + } else { + return XDB::format('RAND({?})', $this->seed); } - return $sel; } -// abstract protected function getSortTokens(&$pf); + public function export() + { + $export = array('type' => 'random',); + if ($this->seed !== null) + $export['seed'] = $this->seed; + return $export; + } } +// }}} // {{{ interface PlFilterCondition -interface PlFilterCondition +interface PlFilterCondition extends PlExportable { const COND_TRUE = 'TRUE'; const COND_FALSE = 'FALSE'; - public function buildCondition(PlFilter &$pf); + public function buildCondition(PlFilter $pf); } // }}} @@ -163,16 +171,21 @@ abstract class PFC_OneChild implements PlFilterCondition { protected $child; - public function __construct(&$child = null) + public function __construct($child = null) { if (!is_null($child) && ($child instanceof PlFilterCondition)) { $this->setChild($child); } } - public function setChild(PlFilterCondition &$cond) + public function setChild(PlFilterCondition $cond) + { + $this->child = $cond; + } + + public function export() { - $this->child =& $cond; + return array('child' => $this->child->export()); } } // }}} @@ -184,17 +197,21 @@ abstract class PFC_NChildren implements PlFilterCondition public function __construct() { - $children = func_get_args(); - foreach ($children as &$child) { - if (!is_null($child) && ($child instanceof PlFilterCondition)) { - $this->addChild($child); + $this->addChildren(pl_flatten(func_get_args())); + } + + public function addChildren(array $conds) + { + foreach ($conds as $cond) { + if (!is_null($cond) && ($cond instanceof PlFilterCondition)) { + $this->addChild($cond); } } } - public function addChild(PlFilterCondition &$cond) + public function addChild(PlFilterCondition $cond) { - $this->children[] =& $cond; + $this->children[] = $cond; } protected function catConds(array $cond, $op, $fallback) @@ -207,33 +224,52 @@ abstract class PFC_NChildren implements PlFilterCondition return '(' . implode(') ' . $op . ' (', $cond) . ')'; } } + + public function export() + { + $export = array(); + foreach ($this->children as $child) { + $export[] = $child->export(); + } + return array('children' => $export); + } } // }}} // {{{ class PFC_True class PFC_True implements PlFilterCondition { - public function buildCondition(PlFilter &$uf) + public function buildCondition(PlFilter $uf) { return self::COND_TRUE; } + + public function export() + { + return array('type' => 'true'); + } } // }}} // {{{ class PFC_False class PFC_False implements PlFilterCondition { - public function buildCondition(PlFilter &$uf) + public function buildCondition(PlFilter $uf) { return self::COND_FALSE; } + + public function export() + { + return array('type' => 'false'); + } } // }}} // {{{ class PFC_Not class PFC_Not extends PFC_OneChild { - public function buildCondition(PlFilter &$uf) + public function buildCondition(PlFilter $uf) { $val = $this->child->buildCondition($uf); if ($val == self::COND_TRUE) { @@ -244,20 +280,27 @@ class PFC_Not extends PFC_OneChild return 'NOT (' . $val . ')'; } } + + public function export() + { + $export = parent::export(); + $export['type'] = 'not'; + return $export; + } } // }}} // {{{ class PFC_And class PFC_And extends PFC_NChildren { - public function buildCondition(PlFilter &$uf) + public function buildCondition(PlFilter $uf) { if (empty($this->children)) { return self::COND_FALSE; } else { $true = self::COND_FALSE; $conds = array(); - foreach ($this->children as &$child) { + foreach ($this->children as $child) { $val = $child->buildCondition($uf); if ($val == self::COND_TRUE) { $true = self::COND_TRUE; @@ -270,20 +313,26 @@ class PFC_And extends PFC_NChildren return $this->catConds($conds, 'AND', $true); } } + + public function export() { + $export = parent::export(); + $export['type'] = 'and'; + return $export; + } } // }}} // {{{ class PFC_Or class PFC_Or extends PFC_NChildren { - public function buildCondition(PlFilter &$uf) + public function buildCondition(PlFilter $uf) { if (empty($this->children)) { return self::COND_TRUE; } else { $true = self::COND_TRUE; $conds = array(); - foreach ($this->children as &$child) { + foreach ($this->children as $child) { $val = $child->buildCondition($uf); if ($val == self::COND_TRUE) { return self::COND_TRUE; @@ -296,28 +345,52 @@ class PFC_Or extends PFC_NChildren return $this->catConds($conds, 'OR', $true); } } + + public function export() { + $export = parent::export(); + $export['type'] = 'or'; + return $export; + } } // }}} - -abstract class PlFilter +// {{{ class PlFilter +abstract class PlFilter implements PlExportable { /** Filters objects matching the PlFilter * @param $objects The objects to filter * @param $limit The portion of the matching objects to show */ - public abstract function filter(array $objects, PlLimit &$limit); + public abstract function filter(array $objects, $limit = null); - public abstract function setCondition(PlFilterCondition &$cond); + public abstract function setCondition(PlFilterCondition $cond); - public abstract function addSort(PlFilterOrder &$sort); + public abstract function addSort(PlFilterOrder $sort); public abstract function getTotalCount(); + /** Whether this PlFilter can return grouped results through + * $this->getGroups(); + */ + public abstract function hasGroups(); + + /** Used to retrieve value/amount resulting from grouping by the first + * given order. + */ + public abstract function getGroups(); + /** Get objects, selecting only those within a limit * @param $limit The portion of the matching objects to select */ - public abstract function get(PlLimit &$limit); + public abstract function get($limit = null); + + /** Get ids, selecting only those within a limit + * @param $limit The portion of the matching objects to select + */ + public function getIds($limit = null) + { + return $this->get($limit); + } /** PRIVATE FUNCTIONS */ @@ -345,5 +418,7 @@ abstract class PlFilter } } +// }}} +// vim:set et sw=4 sts=4 sws=4 foldmethod=marker enc=utf-8: ?>