WebSVN – oidplus – Diff – /trunk/includes/classes/OIDplusDatabaseConnection.class.php

         protected /*bool*/ $connected = false;
         protected /*?bool*/ $html = null;
         protected /*?string*/ $last_query = null;
         protected /*bool*/ $slangDetectionDone = false;
+        /**
+         * @param string $sql
+         * @param array|null $prepared_args
+         * @return OIDplusQueryResult
+         * @throws OIDplusException
+         */
-        protected abstract function doQuery(string $sql, /*?array*/ $prepared_args=null): OIDplusQueryResult;
+        protected abstract function doQuery(string $sql, array $prepared_args=null): OIDplusQueryResult;
+        /**
+         * @return string
+         */
         public abstract function error(): string;
+        /**
+         * @return void
+         */
         public abstract function transaction_begin()/*: void*/;
+        /**
+         * @return void
+         */
         public abstract function transaction_commit()/*: void*/;
+        /**
+         * @return void
+         */
         public abstract function transaction_rollback()/*: void*/;
+        /**
+         * @return bool
+         */
         public abstract function transaction_supported(): bool;
+        /**
+         * @return int
+         */
         public abstract function transaction_level(): int;
+        /**
+         * @return void
+         */
         protected abstract function doConnect()/*: void*/;
+        /**
+         * @return void
+         */
         protected abstract function doDisconnect()/*: void*/;
+        /**
+         * @return OIDplusDatabasePlugin|null
+         */
         public function getPlugin()/*: ?OIDplusDatabasePlugin*/ {
                 $res = null;
                 $plugins = OIDplus::getDatabasePlugins();
                 foreach ($plugins as $plugin) {
-                        if (get_class($this) == get_class($plugin::newConnection($this))) {
+                        if (get_class($this) == get_class($plugin::newConnection())) {
                                 return $plugin;
+                        }
+                }
                 return $res;
+        }
+        /**
+         * @return int
+         * @throws OIDplusException
+         */
         public function insert_id(): int {
                 // This is the "fallback" variant. If your database provider (e.g. PDO) supports
                 // a function to detect the last inserted id, please override this
                 // function in order to use that specialized function (since it is usually
                 // more reliable).
                 return $this->getSlang()->insert_id($this);
+        }
+        /**
+         * @param string $sql
+         * @return array[]
+         * @throws OIDplusException
+         */
-        public final function getTable(string $sql) {
+        public final function getTable(string $sql): array {
                 $out = array();
                 $res = $this->query($sql);
                 while ($row = $res->fetch_array()) {
                         $out[] = $row;
+                }
                 return $out;
+        }
+        /**
+         * @param string $sql
+         * @return mixed|null
+         * @throws OIDplusException
+         */
         public final function getScalar(string $sql) {
                 $res = $this->query($sql);
                 $row = $res->fetch_array();
                 return $row ? reset($row) : null;
+        }
+        /**
+         * @param string $sql
+         * @param array|null $prepared_args
+         * @return OIDplusQueryResult
+         * @throws OIDplusException
+         */
         public final function query(string $sql, /*?array*/ $prepared_args=null): OIDplusQueryResult {
                 $query_logfile = OIDplus::baseConfig()->getValue('QUERY_LOGFILE', '');
                 if (!empty($query_logfile)) {
                         $ts = explode(" ",microtime());
+                }
                 return $this->doQuery($sql, $prepared_args);
+        }
+        /**
+         * @return void
+         * @throws OIDplusException
+         */
         public final function connect()/*: void*/ {
                 if ($this->connected) return;
                 $this->beforeConnect();
                 $this->doConnect();
                 $this->connected = true;
                 OIDplus::register_shutdown_function(array($this, 'disconnect'));
                 $this->afterConnectMandatory();
                 $this->afterConnect();
+        }
+        /**
+         * @return void
+         */
         public final function disconnect()/*: void*/ {
                 if (!$this->connected) return;
                 $this->beforeDisconnect();
                 $this->doDisconnect();
                 $this->connected = false;
                 $this->afterDisconnect();
+        }
+        /**
+         * @param string $fieldname
+         * @param string $order
+         * @return string
+         * @throws OIDplusException
+         */
-        public function natOrder($fieldname, $order='asc'): string {
+        public function natOrder(string $fieldname, string $order='asc'): string {
                 $slang = $this->getSlang();
                 if (!is_null($slang)) {
                         return $slang->natOrder($fieldname, $order);
                 } else {
                         $order = strtolower($order);
                         // For (yet) unsupported DBMS, we do not offer natural sort
                         return "$fieldname $order";
+                }
+        }
+        /**
+         * @return void
+         */
         protected function beforeDisconnect()/*: void*/ {}
+        /**
+         * @return void
+         */
         protected function afterDisconnect()/*: void*/ {}
+        /**
+         * @return void
+         */
         protected function beforeConnect()/*: void*/ {}
+        /**
+         * @return void
+         */
         protected function afterConnect()/*: void*/ {}
+        /**
+         * @return void
+         * @throws OIDplusConfigInitializationException
+         * @throws OIDplusException
+         */
         private function afterConnectMandatory()/*: void*/ {
                 // Check if the config table exists. This is important because the database version is stored in it
                 $this->initRequireTables(array('config'));
                 // Do the database tables need an update?
                 // PDO would automatically roll-back. Therefore, we detect the slang right at the beginning,
                 // before any transaction is used.
                 $this->getSlang();
+        }
+        /**
+         * @param string[] $tableNames
+         * @return void
+         * @throws OIDplusConfigInitializationException
+         * @throws OIDplusException
+         */
-        private function initRequireTables($tableNames)/*: void*/ {
+        private function initRequireTables(array $tableNames)/*: void*/ {
                 $msgs = array();
                 foreach ($tableNames as $tableName) {
                         $prefix = OIDplus::baseConfig()->getValue('TABLENAME_PREFIX', '');
                         if (!$this->tableExists($prefix.$tableName)) {
                                 $msgs[] = _L('Table %1 is missing!',$prefix.$tableName);
                 if (count($msgs) > 0) {
                         throw new OIDplusConfigInitializationException(implode("\n\n",$msgs));
+                }
+        }
+        /**
+         * @param string $tableName
+         * @return bool
+         */
-        public function tableExists($tableName): bool {
+        public function tableExists(string $tableName): bool {
                 try {
                         // Attention: This query could interrupt transactions if Rollback-On-Error is enabled
                         $this->query("select 0 from ".$tableName." where 1=0");
                         return true;
                 } catch (\Exception $e) {
                         return false;
+                }
+        }
+        /**
+         * @return bool
+         */
         public function isConnected(): bool {
                 return $this->connected;
+        }
+        /**
+         * @param bool $html
+         * @return void
+         */
-        public function init($html = true)/*: void*/ {
+        public function init(bool $html = true)/*: void*/ {
                 $this->html = $html;
+        }
+        /**
+         * @return string
+         * @throws OIDplusException
+         */
         public function sqlDate(): string {
                 $slang = $this->getSlang();
                 if (!is_null($slang)) {
                         return $slang->sqlDate();
                 } else {
                         return "'" . date('Y-m-d H:i:s') . "'";
+                }
+        }
+        /**
+         * @param bool $mustExist
+         * @return OIDplusSqlSlangPlugin|null
+         * @throws OIDplusConfigInitializationException
+         * @throws OIDplusException
+         */
         protected function doGetSlang(bool $mustExist=true)/*: ?OIDplusSqlSlangPlugin*/ {
                 $res = null;
                 if (OIDplus::baseConfig()->exists('FORCE_DBMS_SLANG')) {
                         $name = OIDplus::baseConfig()->getValue('FORCE_DBMS_SLANG', '');
+                }
                 return $res;
+        }
+        /**
+         * @param bool $mustExist
+         * @return OIDplusSqlSlangPlugin|null
+         * @throws OIDplusConfigInitializationException
+         * @throws OIDplusException
+         */
         public final function getSlang(bool $mustExist=true)/*: ?OIDplusSqlSlangPlugin*/ {
                 static /*?OIDplusSqlSlangPlugin*/ $slangCache = null;
                 if ($this->slangDetectionDone) {
                         return $slangCache;

Subversion Repositories oidplus

oidplus/trunk/includes/classes/OIDplusDatabaseConnection.class.php – Rev 1086 → 1116