* This class defines entire lists mechanism for classes that represents records set from OTServ database. All child classes only have to define {@link OTS_Base_List::init() init() method} to set table info for queries. *
- * + * ** Table on which list will operate has to contain integer "id" field and single row representing class has to support loading by this filed as key. *
- * + * ** This class is mostly usefull when you create own extensions for POT code. *
- * + * * @package POT * @version 0.1.5 * @property-write int $limit Sets LIMIT clause. @@ -40,7 +40,7 @@ abstract class OTS_Base_List implements IOTS_DAO, Iterator, Countable { /** * Database connection. - * + * * @var PDO * @version 0.1.5 */ @@ -48,35 +48,35 @@ abstract class OTS_Base_List implements IOTS_DAO, Iterator, Countable /** * Limit for SELECT query. - * + * * @var int */ private $limit = false; /** * Offset for SELECT query. - * + * * @var int */ private $offset = false; /** * WHERE clause filter. - * + * * @var OTS_SQLFilter */ private $filter = null; /** * List of sorting criteriums. - * + * * @var array */ private $orderBy = array(); /** * Query results. - * + * * @var array * @version 0.1.5 */ @@ -84,21 +84,21 @@ abstract class OTS_Base_List implements IOTS_DAO, Iterator, Countable /** * Default table name for queries. - * + * * @var string */ protected $table; /** * Class of generated objects. - * + * * @var string */ protected $class; /** * Sets database connection handler. - * + * * @version 0.1.0 */ public function __construct() @@ -114,11 +114,11 @@ abstract class OTS_Base_List implements IOTS_DAO, Iterator, Countable /** * Magic PHP5 method. - * + * ** Allows object serialisation. *
- * + * * @return array List of properties that should be saved. */ public function __sleep() @@ -128,7 +128,7 @@ abstract class OTS_Base_List implements IOTS_DAO, Iterator, Countable /** * Magic PHP5 method. - * + * ** Allows object unserialisation. *
@@ -138,43 +138,13 @@ abstract class OTS_Base_List implements IOTS_DAO, Iterator, Countable $this->db = POT::getInstance()->getDBHandle(); } -/** - * Magic PHP5 method. - * - *- * Allows object importing from {@link http://www.php.net/manual/en/function.var-export.php var_export()}. - *
- * - * @version 0.1.3 - * @param array $properties List of object properties. - */ - public static function __set_state($properties) - { - // deletes database handle - if( isset($properties['db']) ) - { - unset($properties['db']); - } - - // initializes new object with current database connection - $object = new self(); - - // loads properties - foreach($properties as $name => $value) - { - $object->$name = $value; - } - - return $object; - } - /** * Sets LIMIT clause. - * + * ** Reduces amount of seleced rows up to given number. *
- * + * * @param int|bool $limit Limit for SELECT (false to reset). */ public function setLimit($limit = false) @@ -191,11 +161,11 @@ abstract class OTS_Base_List implements IOTS_DAO, Iterator, Countable /** * Sets OFFSET clause. - * + * ** Moves starting rows of selected set to given position. *
- * + * * @param int|bool $offset Offset for SELECT (false to reset). */ public function setOffset($offset = false) @@ -212,11 +182,11 @@ abstract class OTS_Base_List implements IOTS_DAO, Iterator, Countable /** * Returns current row. - * + * ** Returns object of class which handle single row representation. Object is initialised with ID of current position in result cursor. *
- * + * * @version 0.1.3 * @return OTS_Base_DAO Current row. */ @@ -230,7 +200,7 @@ abstract class OTS_Base_List implements IOTS_DAO, Iterator, Countable /** * Select rows from database. - * + * * @throws PDOException On PDO operation error. */ public function rewind() @@ -248,7 +218,7 @@ abstract class OTS_Base_List implements IOTS_DAO, Iterator, Countable /** * Current cursor position. - * + * * @return mixed Array key. */ public function key() @@ -258,7 +228,7 @@ abstract class OTS_Base_List implements IOTS_DAO, Iterator, Countable /** * Checks if there are any rows left. - * + * * @return bool Does next row exist. */ public function valid() @@ -268,7 +238,7 @@ abstract class OTS_Base_List implements IOTS_DAO, Iterator, Countable /** * Returns number of rows on list in current criterium. - * + * * @version 0.1.5 * @return int Number of rows. * @throws PDOException On PDO operation error. @@ -280,11 +250,11 @@ abstract class OTS_Base_List implements IOTS_DAO, Iterator, Countable /** * Sets filter on list. - * + * ** Call without argument to reset filter. *
- * + * * @param OTS_SQLFilter|null $filter Filter for list. */ public function setFilter(OTS_SQLFilter $filter = null) @@ -302,15 +272,15 @@ abstract class OTS_Base_List implements IOTS_DAO, Iterator, Countable /** * Appends sorting rule. - * + * ** First parameter may be of type string, then it will be used as literal field name, or object of {@link OTS_SQLField OTS_SQLField class}, then it's representation will be used as qualiffied SQL identifier name. *
- * + * ** Note: Since 0.0.7 version $field parameter can be instance of {@link OTS_SQLField OTS_SQLField class}. *
- * + * * @version 0.0.7 * @param OTS_SQLField|string $field Field name. * @param int $order Sorting order (ascending by default). @@ -341,7 +311,7 @@ abstract class OTS_Base_List implements IOTS_DAO, Iterator, Countable /** * Returns SQL query for SELECT. - * + * * @version 0.1.5 * @param bool $count Shows if the SQL should be generated for COUNT() variant. * @return string SQL query part. @@ -363,7 +333,7 @@ abstract class OTS_Base_List implements IOTS_DAO, Iterator, Countable /** * Returns generic SQL query that can be adaptated by child classes. - * + * * @version 0.1.5 * @since 0.1.5 * @param array $fields Fields to be selected. @@ -402,7 +372,7 @@ abstract class OTS_Base_List implements IOTS_DAO, Iterator, Countable } // ORDER BY clause - if(isset($count) || empty($this->orderBy) ) + if(empty($this->orderBy) ) { $orderBy = ''; } @@ -432,7 +402,7 @@ abstract class OTS_Base_List implements IOTS_DAO, Iterator, Countable /** * Magic PHP5 method. - * + * * @version 0.1.0 * @since 0.1.0 * @param string $name Property name.