use standard SplObserver
[m6w6/pq-gateway] / lib / pq / Gateway / Table.php
index ebab838bf672b8c01f2229720644a617038a17f0..42977dc0d6c9d7b555afe9c42e5283a2246b5319 100644 (file)
@@ -2,15 +2,27 @@
 
 namespace pq\Gateway;
 
+use \pq\Query\Expr as QueryExpr;
 use \pq\Query\Writer as QueryWriter;
+use \pq\Query\Executor as QueryExecutor;
 
-class Table
+class Table implements \SplSubject
 {
        /**
         * @var \pq\Connection
         */
        public static $defaultConnection;
        
+       /**
+        * @var callable
+        */
+       public static $defaultResolver;
+       
+       /**
+        * @var \pq\Gateway\Table\CacheInterface
+        */
+       public static $defaultMetadataCache;
+       
        /**
         * @var \pq\Connection
         */
@@ -27,17 +39,85 @@ class Table
        protected $rowset = "\\pq\\Gateway\\Rowset";
        
        /**
-        * @var \pq\Query\Writer
+        * @var \pq\Query\WriterIterface
         */
        protected $query;
+       
+       /**
+        * @var \pq\Query\ExecutorInterface
+        */
+       protected $exec;
+       
+       /**
+        * @var \pq\Gateway\Table\Identity
+        */
+       protected $identity;
+       
+       /**
+        * @var \pq\Gateway\Table\Attributes
+        */
+       protected $attributes;
+       
+       /**
+        * @var \pq\Gateway\Table\Relations
+        */
+       protected $relations;
+       
+       /**
+        * @var \pq\Gateway\Table\CacheInterface
+        */
+       protected $metadataCache;
+       
+       /**
+        * @var \SplObjectStorage
+        */
+       protected $observers;
+       
+       /**
+        * @param string $table
+        * @return \pq\Gateway\Table
+        */
+       public static function resolve($table) {
+               if ($table instanceof Table) {
+                       return $table;
+               }
+               if (is_callable(static::$defaultResolver)) {
+                       if (($resolved = call_user_func(static::$defaultResolver, $table))) {
+                               return $resolved;
+                       }
+               }
+               return new Table($table);
+       }
 
        /**
         * @param string $name
         * @param \pq\Connection $conn
+        * @param array $dependents
         */
-       function __construct($name, \pq\Connection $conn = null) {
-               $this->name = $name;
+       function __construct($name = null, \pq\Connection $conn = null) {
+               if (isset($name)) {
+                       $this->name = $name;
+               } elseif (!isset($this->name)) {
+                       throw new \InvalidArgumentException("Table must have a name");
+               }
                $this->conn = $conn ?: static::$defaultConnection ?: new \pq\Connection;
+               $this->observers = new \SplObjectStorage;
+       }
+       
+       /**
+        * Get the complete PostgreSQL connection string
+        * @return string
+        */
+       function __toString() {
+               return sprintf("postgresql://%s:%s@%s:%d/%s?%s#%s",
+                       $this->conn->user,
+                       $this->conn->pass,
+                       $this->conn->host,
+                       $this->conn->port,
+                       $this->conn->db,
+                       $this->conn->options,
+                       $this->getName()
+               );
        }
        
        /**
@@ -73,7 +153,103 @@ class Table
         * @return \pq\Query\WriterInterface
         */
        function getQueryWriter() {
-               return $this->query ?: new QueryWriter;
+               if (!$this->query) {
+                       $this->query = new QueryWriter;
+               }
+               return $this->query;
+       }
+       
+       /**
+        * Set the query executor
+        * @param \pq\Query\ExecutorInterface $exec
+        * @return \pq\Gateway\Table
+        */
+       function setQueryExecutor(\pq\Query\ExecutorInterface $exec) {
+               $this->exec = $exec;
+               return $this;
+       }
+       
+       /**
+        * Get the query executor
+        * @return \pq\Query\ExecutorInterface
+        */
+       function getQueryExecutor() {
+               if (!$this->exec) {
+                       $this->exec = new QueryExecutor($this->conn);
+               }
+               return $this->exec;
+       }
+       
+       /**
+        * Get the metadata cache
+        * @return \pq\Gateway\Table\CacheInterface
+        */
+       function getMetadataCache() {
+               if (!isset($this->metadatCache)) {
+                       $this->metadataCache = static::$defaultMetadataCache ?: new Table\StaticCache;
+               }
+               return $this->metadataCache;
+       }
+       
+       /**
+        * Set the metadata cache
+        * @param \pq\Gateway\Table\CacheInterface $cache
+        */
+       function setMetadataCache(Table\CacheInterface $cache) {
+               $this->metadataCache = $cache;
+               return $this;
+       }
+       
+       /**
+        * Get the primary key
+        * @return \pq\Gateway\Table\Identity
+        */
+       function getIdentity() {
+               if (!isset($this->identity)) {
+                       $this->identity = new Table\Identity($this);
+               }
+               return $this->identity;
+       }
+       
+       function getAttributes() {
+               if (!isset($this->attributes)) {
+                       $this->attributes = new Table\Attributes($this);
+               }
+               return $this->attributes;
+       }
+       
+       /**
+        * Get foreign key relations
+        * @param string $to fkey
+        * @return \pq\Gateway\Table\Relations|stdClass
+        */
+       function getRelations($to = null) {
+               if (!isset($this->relations)) {
+                       $this->relations = new Table\Relations($this);
+               }
+               if (isset($to)) {
+                       if (!isset($this->relations->$to)) {
+                               return null;
+                       }
+                       return $this->relations->$to;
+               }
+               return $this->relations;
+       }
+       
+       /**
+        * Check whether a certain relation exists
+        * @param string $name
+        * @param string $table
+        * @return bool
+        */
+       function hasRelation($name, $table = null) {
+               if (!($rel = $this->getRelations($name))) {
+                       return false;
+               }
+               if (!isset($table)) {
+                       return true;
+               }
+               return isset($rel->$table);
        }
        
        /**
@@ -90,15 +266,51 @@ class Table
                return $this->name;
        }
 
+       /**
+        * Attach an observer
+        * @param \SplObserver
+        * @return \pq\Gateway\Table
+        */
+       function attach(\SplObserver $observer) {
+               $this->observers->attach($observer);
+               return $this;
+       }
+       
+       /**
+        * Detach an observer
+        * @param \SplObserver
+        * @return \pq\Gateway\Table
+        */
+       function detach(\SplObserver $observer) {
+               $this->observers->attach($observer);
+               return $this;
+       }
+
+       /**
+        * Implements \SplSubject
+        */
+       function notify(\pq\Gateway\Row $row = null, $event = null, array &$where = null) {
+               foreach ($this->observers as $observer) {
+                       $observer->update($this, $row, $event, $where);
+               }
+       }
+       
        /**
         * Execute the query
-        * @param \pq\Query\Writer $query
+        * @param \pq\Query\WriterInterface $query
         * @return mixed
         */
        protected function execute(QueryWriter $query) {
-               $result = $query->exec($this->conn);
-               
-               if ($result->status != \pq\Result::TUPLES_OK) {
+               return $this->getQueryExecutor()->execute($query, array($this, "onResult"));
+       }
+
+       /**
+        * Retreives the result of an executed query
+        * @param \pq\Result $result
+        * @return mixed
+        */
+       public function onResult(\pq\Result $result = null) {
+               if ($result && $result->status != \pq\Result::TUPLES_OK) {
                        return $result;
                }
                
@@ -111,16 +323,17 @@ class Table
                
                return $result;
        }
-
+       
        /**
         * Find rows in the table
         * @param array $where
         * @param array|string $order
         * @param int $limit
         * @param int $offset
-        * @return \pq\Result
+        * @param string $lock
+        * @return mixed
         */
-       function find(array $where = null, $order = null, $limit = 0, $offset = 0) {
+       function find(array $where = null, $order = null, $limit = 0, $offset = 0, $lock = null) {
                $query = $this->getQueryWriter()->reset();
                $query->write("SELECT * FROM", $this->conn->quoteName($this->name));
                if ($where) {
@@ -132,7 +345,98 @@ class Table
                if ($limit) {
                        $query->write("LIMIT", $limit);
                }
-               $query->write("OFFSET", $offset);
+               if ($offset) {
+                       $query->write("OFFSET", $offset);
+               }
+               if ($lock) {
+                       $query->write("FOR", $lock);
+               }
+               return $this->execute($query);
+       }
+       
+       /**
+        * Get the child rows of a row by foreign key
+        * @param \pq\Gateway\Row $foreign
+        * @param string $name optional fkey name
+        * @param string $order
+        * @param int $limit
+        * @param int $offset
+        * @return mixed
+        */
+       function of(Row $foreign, $name = null, $order = null, $limit = 0, $offset = 0) {
+               // select * from $this where $this->$foreignColumn = $foreign->$referencedColumn
+               
+               if (!isset($name)) {
+                       $name = $foreign->getTable()->getName();
+               }
+               
+               if (!$foreign->getTable()->hasRelation($name, $this->getName())) {
+                       return $this->onResult(null);
+               }
+               $rel = $foreign->getTable()->getRelations($name)->{$this->getName()};
+               
+               return $this->find(
+                       array($rel->foreignColumn . "=" => $foreign->{$rel->referencedColumn}),
+                       $order, $limit, $offset
+               );
+       }
+       
+       /**
+        * Get the parent rows of a row by foreign key
+        * @param \pq\Gateway\Row $me
+        * @param string $foreign
+        * @param string $order
+        * @param int $limit
+        * @param int $offset
+        * @return mixed
+        */
+       function by(Row $me, $foreign, $order = null, $limit = 0, $offset = 0) {
+               // select * from $foreign where $foreign->$referencedColumn = $me->$foreignColumn
+               
+               if (!$this->hasRelation($foreign, $this->getName())) {
+                       return $this->onResult(null);
+               }
+               $rel = $this->getRelations($foreign)->{$this->getName()};
+               
+               return static::resolve($rel->referencedTable)->find(
+                       array($rel->referencedColumn . "=" => $me->{$rel->foreignColumn}),
+                       $order, $limit, $offset
+               );
+       }
+       
+       /**
+        * Get rows dependent on other rows by foreign keys
+        * @param array $relations
+        * @param array $where
+        * @param string $order
+        * @param int $limit
+        * @param int $offset
+        * @return mixed
+        */
+       function with(array $relations, array $where = null, $order = null, $limit = 0, $offset = 0) {
+               $qthis = $this->conn->quoteName($this->getName());
+               $query = $this->getQueryWriter()->reset();
+               $query->write("SELECT", "$qthis.*", "FROM", $qthis);
+               foreach ($relations as $relation) {
+                       $query->write("JOIN", $relation->foreignTable)->write("ON")->criteria(
+                               array(
+                                       "{$relation->referencedTable}.{$relation->referencedColumn}=" => 
+                                               new QueryExpr("{$relation->foreignTable}.{$relation->foreignColumn}")
+                               )
+                       );
+               }
+               if ($where) {
+                       $query->write("WHERE")->criteria($where);
+               }
+               if ($order) {
+                       $query->write("ORDER BY", $order);
+               }
+               if ($limit) {
+                       $query->write("LIMIT", $limit);
+               }
+               if ($offset) {
+                       $query->write("OFFSET", $offset);
+               }
                return $this->execute($query);
        }
 
@@ -140,7 +444,7 @@ class Table
         * Insert a row into the table
         * @param array $data
         * @param string $returning
-        * @return \pq\Result
+        * @return mixed
         */
        function create(array $data = null, $returning = "*") {
                $query = $this->getQueryWriter()->reset();
@@ -150,7 +454,7 @@ class Table
                        $params = array();
                        foreach ($data as $key => $val) {
                                $query->write($first ? "(" : ",", $key);
-                               $params[] = $query->param($val);
+                               $params[] = $query->param($val, $this->getAttributes()->getColumn($key)->type);
                                $first and $first = false;
                        }
                        $query->write(") VALUES (", $params, ")");
@@ -169,14 +473,15 @@ class Table
         * @param array $where
         * @param array $data
         * @param string $returning
-        * @retunr \pq\Result
+        * @retunr mixed
         */
        function update(array $where, array $data, $returning = "*") {
                $query = $this->getQueryWriter()->reset();
                $query->write("UPDATE", $this->conn->quoteName($this->name));
                $first = true;
                foreach ($data as $key => $val) {
-                       $query->write($first ? "SET" : ",", $key, "=", $query->param($val));
+                       $query->write($first ? "SET" : ",", $key, "=", 
+                               $query->param($val, $this->getAttributes()->getColumn($key)->type));
                        $first and $first = false;
                }
                $query->write("WHERE")->criteria($where);
@@ -190,7 +495,7 @@ class Table
         * Delete rows from the table
         * @param array $where
         * @param string $returning
-        * @return pq\Result
+        * @return mixed
         */
        function delete(array $where, $returning = null) {
                $query = $this->getQueryWriter()->reset();