gy-doc-code
[ class tree: gy-doc-code ] [ index: gy-doc-code ] [ all elements ]

Source for file Db.php

Documentation is available at Db.php

  1. <?php
  2.  
  3. namespace Gy\Core\AbstractClasses;
  4.  
  5. if (!defined("GY_CORE"&& (GY_CORE !== true)) die"gy: err include core" );
  6.  
  7. /** abstract class work database
  8.  * 
  9.  * 
  10.  */
  11. abstract class Db
  12. {
  13.     /** connect() - create connect in database
  14.      * @param string $host - адрис хоста
  15.      * @param string $user - логин
  16.      * @param string $pass - пароль
  17.      * @param string $nameDb - имя БД
  18.      * @param string $port - порт
  19.      * @return resurs, false
  20.      */
  21.     abstract public function connect($host$user$pass$nameDb$port);
  22.  
  23.     /** query()  - out query in database
  24.      * @param $db - resurs (create self::connect()), $query - string query
  25.      * @return false or object result query
  26.      */
  27.     abstract public function query($query)// запрос к db
  28.  
  29.     /**  close() - close connect database
  30.      * @param $db - resurs (create self::connect())
  31.      * @return true - ok OR false - not ok
  32.      */
  33.     abstract public function close()// закрыть подключение к db
  34.  
  35.     //abstract public function select();
  36.  
  37.     /**
  38.      * fetch - получить порцию (строку) данных, после выполнения запроса в БД
  39.      * @param $res - результат отработки запроса в БД
  40.      * @return array 
  41.     */
  42.     abstract public function fetch($res);
  43.  
  44.     /**
  45.      * fetchAll - тоже что и fetch только в получит всё в виде массива
  46.      *     что будет ключём можно указать, либо false тогда вернёт массив
  47.      *     с ключами по порядку
  48.      * @param $res - результат отработки запроса в БД
  49.      * @param string $key - строка либо false, это что будет ключём в массиве
  50.      *      (по умолчанию id записи)
  51.      * @return array 
  52.     */
  53.     abstract public function fetchAll($res$key 'id');
  54.  
  55.     // TODO в функции ниже добавить параметры сортировки 
  56.     
  57.     /**
  58.      * selectDb - запрос типа select. на получение данных
  59.      * @param $db - resurs (create self::connect())
  60.      * @param string $tableName - имя таблици
  61.      * @param array $propertys - параметры (какие поля вернуть или * - все)
  62.      * @param array $where - условия запроса, массив специальной структуры в виде
  63.      *      дерева (может не быть)
  64.      * @return false or object result query
  65.      */
  66.     abstract public function selectDb($tableName$propertys$where array());
  67.  
  68.     /**
  69.      * insertDb - вставка, добавление новых строк в базу данных
  70.      * @param string $tableName - имя таблици
  71.      * @param array $propertys - параметры (поле = значение)
  72.      * @return false or object result query
  73.      */
  74.     abstract public function insertDb($tableName$propertys);
  75.  
  76.     /**
  77.      * updateDb - обновить поле таблици
  78.      * @param string $tableName - имя таблици
  79.      * @param array $propertys - параметры (поле = значение)
  80.      * @param array $where - условия запроса, массив специальной структуры
  81.      *      в виде дерева (может не быть)
  82.      * @return false or object result query
  83.      */
  84.     abstract public function updateDb($tableName$propertys$where array());
  85.  
  86.     /**
  87.      * createTable - создать таблицу в базе данных
  88.      * @param string $tableName - имя таблици
  89.      * @param array $propertys - параметры
  90.      *      (приер  login varchar(50), name varchar(50) ...)
  91.      * @return false or object result query
  92.      */
  93.     abstract public function createTable($tableName$propertys);
  94.  
  95.     /**
  96.      * deleteDb - удаление строк из таблици
  97.      * @param string $tableName - имя таблици
  98.      * @param array $where - условия запроса, что удалять
  99.      * @return boolean 
  100.      */
  101.     abstract public function deleteDb($tableName$where);
  102. }

Documentation generated on Sat, 27 Apr 2024 11:17:29 +0300 by phpDocumentor 1.4.3