energine
[ class tree: energine ] [ index: energine ] [ all elements ]
Packages:
energine


Classes:
core
   AuthUser
   BaseException
   Builder
   Component
   ComponentConfig
   ComponentManager
   ConfigElement
   Control
   Data
   DataDescription
   DBA
   DBWorker
   DirectoryObject
   Document
   DocumentController
   DummyException
   Field
   FieldDescription
   FileObject
   FileSystemObject
   FileUploader
   FormException
   JSONBuilder
   JSONUploadBuilder
   Language
   Mail
   ManufacturerList
   MultiLanguageBuilder
   Object
   Pager
   QAL
   Remover
   Request
   Response
   Saver
   SimpleBuilder
   Sitemap
   SystemException
   Transformer
   Translit
   TreeBuilder
   TreeConverter
   TreeNode
   TreeNodeList
   URI
   User
   UserGroup
   UserSession
   VideoUploader
shop
   Basket
   BasketForm
   BasketList
   CatalogueTree
   CurrencyConverter
   CurrencyEditor
   CurrencySwitcher
   Discounts
   DiscountsEditor
   ManufacturersEditor
   Order
   OrderDetails
   OrderForm
   OrderHistory
   OrderStatus
   OrderStatuses
   ParamValuesEditor
   PriceLoader
   ProductDivisions
   ProductEditor
   ProductList
   ProductParamsEditor
   ProductStatusEditor
   ProductTypeEditor
   UserOrderHistory
share
   BreadCrumbs
   BrotherDivisions
   Button
   ChildDivisions
   Container
   DataSet
   DBDataSet
   DivisionEditor
   Feed
   FeedbackForm
   FeedbackList
   FeedEditor
   FileLibrary
   Grid
   JSONDivBuilder
   LangSwitcher
   LanguageEditor
   Link
   MainMenu
   NewsEditor
   NewsFeed
   Select
   Separator
   SitemapTree
   Submit
   Switcher
   TemplateEditor
   TextBlock
   TextBlockSource
   Toolbar
   TranslationEditor
image
   GalleryEditor
   GalleryFeed
   Image
   ImageManager
misc
   GoogleSitemap
Jevix
user
   LoginForm
   Register
   RestorePassword
   RoleEditor
   UserEditor
   UserProfile
Files:
Jevix.class.php

subpackage core
AuthUser.class.php
BaseException.class.php
Builder.class.php
Component.class.php
ComponentConfig.class.php
ComponentManager.class.php
ConfigElement.class.php
Control.class.php
Data.class.php
DataDescription.class.php
DBA.class.php
DBWorker.class.php
DirectoryObject.class.php
Document.class.php
DocumentController.class.php
Field.class.php
FieldDescription.class.php
FileObject.class.php
FileSystemObject.class.php
FileUploader.class.php
FormException.class.php
ini.func.php
JSONBuilder.class.php
JSONUploadBuilder.class.php
Language.class.php
Mail.class.php
ManufacturerList.class.php
MultiLanguageBuilder.class.php
Object.class.php
Pager.class.php
QAL.class.php
Remover.class.php
Request.class.php
Response.class.php
Saver.class.php
SimpleBuilder.class.php
Sitemap.class.php
SystemException.class.php
Transformer.class.php
Translit.class.php
TreeBuilder.class.php
TreeConverter.class.php
TreeNode.class.php
TreeNodeList.class.php
URI.class.php
User.class.php
UserGroup.class.php
UserSession.class.php
utils.func.php
VideoUploader.class.php

subpackage image
GalleryEditor.class.php
GalleryFeed.class.php
Image.class.php
ImageManager.class.php

subpackage misc
GoogleSitemap.class.php

subpackage share
BreadCrumbs.class.php
BrotherDivisions.class.php
Button.class.php
ChildDivisions.class.php
Container.class.php
DataSet.class.php
DBDataSet.class.php
DivisionEditor.class.php
Feed.class.php
FeedbackForm.class.php
FeedbackList.class.php
FeedEditor.class.php
FileLibrary.class.php
Grid.class.php
JSONDivBuilder.class.php
LangSwitcher.class.php
LanguageEditor.class.php
Link.class.php
MainMenu.class.php
NewsEditor.class.php
NewsFeed.class.php
Select.class.php
Separator.class.php
SitemapTree.class.php
Submit.class.php
Switcher.class.php
TemplateEditor.class.php
TextBlock.class.php
TextBlockSource.class.php
Toolbar.class.php
TranslationEditor.class.php

subpackage shop
Basket.class.php
BasketForm.class.php
BasketList.class.php
CatalogueTree.class.php
CurrencyConverter.class.php
CurrencyEditor.class.php
CurrencySwitcher.class.php
Discounts.class.php
DiscountsEditor.class.php
ManufacturersEditor.class.php
Order.class.php
OrderDetails.class.php
OrderForm.class.php
OrderHistory.class.php
OrderStatus.class.php
OrderStatuses.class.php
ParamValuesEditor.class.php
PriceLoader.class.php
ProductDivisions.class.php
ProductEditor.class.php
ProductList.class.php
ProductParamsEditor.class.php
ProductStatusEditor.class.php
ProductTypeEditor.class.php
UserOrderHistory.class.php

subpackage user
LoginForm.class.php
Register.class.php
RestorePassword.class.php
RoleEditor.class.php
UserEditor.class.php
UserProfile.class.php

Class: DBA

Source Location: /framework/DBA.class.php

Class Overview

Object
   |
   --DBA

Database Abstraction Layer.


Author(s):

  • 1m.dm

Variables

Constants

Methods

Child classes:

QAL
Query Abstraction Layer.

Inherited Constants

Class: Object

Object::CONFIG_DIR
Object::CONFIG_FILE

Inherited Variables

Class: Object

Object::$executionTime
Object::$systemConfig
Object::$values

Inherited Methods

Class: Object

Object::__construct()
Пустой конструктор
Object::getConfigValue()
Нестатический метод-обёртка над Object::_getConfigValue - для удобства использования внутри производных классов.
Object::getTimer()
Возвращает значение счетчика времени выполнения.
Object::resetTimer()
Сбрасывает счетчик времени, возвращает предыдущее значение счетчика
Object::startTimer()
Запускает счетчик времени выполнения.
Object::stopTimer()
Останавливает счетчик времени выполнения.
Object::_getConfigValue()
Возвращает значение указанного параметра конфигурации.

Class Details

[line 23]
Database Abstraction Layer.



Tags:

author:  1m.dm
abstract:  


[ Top ]

Class Variables

$lastQuery =

[line 35]



Tags:

var:  последний запрос к БД
access:  protected

Type:   string


[ Top ]

$lastResult =

[line 41]



Tags:

var:  результат последнего запроса к БД
access:  protected

Type:   mixed


[ Top ]

$pdo =

[line 29]



Tags:

var:  экземпляр класса PDO (PHP Data Objects)
access:  protected

Type:   PDO


[ Top ]


Class Methods

method beginTransaction [line 305]

boolean beginTransaction( )

Стартует транзакцию.



Tags:

access:  public


[ Top ]

constructor __construct [line 131]

void __construct( string $dsn, string $username, string $password, $driverOptions, [ $charset = 'utf8'])

Конструктор класса.



Tags:

access:  public


Overridden in child classes as:

QAL::__construct()
Конструктор класса.

Overrides Object::__construct() (Пустой конструктор)

Parameters:

string   $dsn   Data Source Name для подключения к БД
string   $username   имя пользователя
string   $password   пароль
array   $driverOptions   специфические параметры драйвера БД
   $charset  

[ Top ]

method commit [line 315]

boolean commit( )

Выполняет (commit) транзакцию.



Tags:

access:  public


[ Top ]

method constructQuery [line 507]

string constructQuery( $args)

Формирует строку запроса к БД.



Tags:

see:  DBA::selectRequest()
see:  DBA::modifyRequest()
access:  private


Parameters:

array   $args   массив аргументов, переданных в методы selectRequest и modifyRequest

[ Top ]

method convertType [line 430]

string convertType( string $mysqlType)

Конвертирует тип данных из описания БД (MySQL) в наш, системный тип.



Tags:

access:  private


Parameters:

string   $mysqlType  

[ Top ]

method getColumnsInfo [line 347]

array getColumnsInfo( string $tableName)

Возвращает информацию о колонках таблицы $tableName в виде массива:

array( 'columnName' => array( 'type' => тип колонки, 'length' => длина, 'nullable' => принимает ли значение NULL?, 'key' => описание ключа колонки (если есть), 'default' => значение по-умолчанию, 'index'=> тип индекса ) )




Tags:

staticvar:  $columnsInfo $columnsInfo: - кеш полей таблицы
access:  public


Parameters:

string   $tableName  

[ Top ]

method getForeignKeyInfo [line 405]

mixed getForeignKeyInfo( string $tableName, string $fieldName)

Возвращает информацию о внешнем ключе поля $fieldName таблицы $tableName

в виде массива array( 'tableName' => имя таблицы, 'fieldName' => имя поля ) или false, если $tableName.$fieldName не является первичным ключем.




Tags:

staticvar:  $foreignKeyInfo $columnsInfo: кеш результатов
access:  private


Parameters:

string   $tableName   имя таблицы
string   $fieldName   имя поля

[ Top ]

method getLastError [line 296]

string getLastError( )

Возвращает последнюю ошибку



Tags:

access:  public


[ Top ]

method getLastRequest [line 276]

string getLastRequest( )

Возвращает последний запрос к БД.



Tags:

access:  public


[ Top ]

method getLastResult [line 286]

mixed getLastResult( )

Возвращает результат последнего запроса к БД.



Tags:

access:  public


[ Top ]

method getTranslationTablename [line 487]

mixed getTranslationTablename( string $tableName)

Возвращает для таблицы $tableName имя таблицы с переводами, если такая существует. В противном случае возвращает false.



Tags:

access:  public


Parameters:

string   $tableName  

[ Top ]

method modifyRequest [line 232]

mixed modifyRequest( string $query)

Выполняет модифицирующую (INSERT, UPDATE, DELETE) операцию в БД.

Если количество аргументов метода больше 1, тогда $query трактуется как строка формата подобно функции printf, а дополнительные аргументы экранируются и помещаются на место меток (placeholder) строки $query.

Возвращает в результате:

  1. Последний сгенерированный ID для поля типа AUTO_INCREMENT, или
  2. true, если запрос выполнен успешно;
2. false, в случае неудачи.




Tags:

see:  printf()
access:  public


Parameters:

string   $query  

[ Top ]

method quote [line 266]

string quote( string $string)

Ставит кавычки вокруг входной строки (если необходимо) и экранирует специальные символы внутри входной строки.



Tags:

access:  public


Parameters:

string   $string  

[ Top ]

method rollback [line 325]

boolean rollback( )

Откатывает транзакцию.



Tags:

access:  public


[ Top ]

method selectRequest [line 164]

mixed selectRequest( string $query, mixed $var,)

Выполняет SELECT-запрос к БД.

Если количество аргументов метода больше 1, тогда $query трактуется как строка формата подобно функции printf, а дополнительные аргументы экранируются и помещаются на место меток (placeholder) строки $query.

Возвращает в результате:

  1. Массив вида array( rowID => array(fieldName => fieldValue, ...) ) если запрос исполнился успешно и вернул какие-либо строки;
  2. true, если запрос исполнился успешно, но не вернул ни одной строки;
  3. false, если при выполнении запроса произошла ошибка.




Tags:

see:  printf()
access:  public


Parameters:

string   $query   SELECT-запрос к БД
mixed   $var,   ...

[ Top ]

Class Constants

COLTYPE_BLOB =  'BLOB'

[line 96]

Бинарные данные


[ Top ]

COLTYPE_DATE =  'DATE'

[line 60]

Дата


[ Top ]

COLTYPE_DATETIME =  'DATETIME'

[line 75]

Дата и время


[ Top ]

COLTYPE_FLOAT =  'FLOAT'

[line 55]

Число с плавающей точкой


[ Top ]

COLTYPE_INTEGER =  'INT'

[line 50]

Целое число


[ Top ]

COLTYPE_STRING =  'VARCHAR'

[line 80]

Строка


[ Top ]

COLTYPE_STRING1 =  'STRING'

[line 85]

Типы строк только для внутреннего использования. Без комментариев :)


[ Top ]

COLTYPE_STRING2 =  'VAR_STRING'

[line 86]


[ Top ]

COLTYPE_TEXT =  'TEXT'

[line 91]

Текст


[ Top ]

COLTYPE_TIME =  'TIME'

[line 65]

Время


[ Top ]

COLTYPE_TIMESTAMP =  'TIMESTAMP'

[line 70]

Timestamp


[ Top ]

ERR_BAD_REQUEST =  'ERR_DATABASE_ERROR'

[line 101]

Ошибки


[ Top ]

INDEX =  'MUL'

[line 119]

Индекс


[ Top ]

PRIMARY_INDEX =  'PRI'

[line 107]

Первичный индекс


[ Top ]

UNIQUE_INDEX =  'UNI'

[line 113]

Уникальный индекс


[ Top ]


В создании документации нам помог: phpDocumentor