Context Navigation

DBARRAY_ASSOC	Тип массива результата SQL запроса: Ассоциативный ключ
DBARRAY_BOTH	Тип массива результата SQL запроса: Числовой и Ассоциативный ключ
DBARRAY_NUM	Тип массива результата SQL запроса: Числовой
ERROR_CONNECT	Ошибка - Связь с базой данных не установлена
ERROR_EXECUTE_QUERY	Ошибка в SQL запросе, текст ошибки в $errorText
ERROR_SELECT_DB	Ошибка - База данных $database не найдена

[ Top ]

Property Summary

string	$connection	Ссылка коннекта к БД
string	$database	Имя базы
integer	$error	Номер ошибки
string	$errorText	Текст ошибки
array	$fetchtypes	Массив констант используемых в fetch_array
string	$prefix	Префикс таблиц
integer	$querycount	Количество выполненых SQL запросов за текущую сессию
bool	$readonly	Режим "Только для чтения".
CMSRegistry	$registry	Ядро платформы BrickCMS
string	$sql	Последний обработанный SQL запрос к базе данных

[ Top ]

Method Summary

CMSDatabase	CMSDatabase()	Конструктор
integer	affected_rows()	Вернуть кол-во задействованных строк в последнем запросе insert/replace/update
void	affected_rows_pt()
void	ClearError()
void	client_encoding()
void	client_encoding_pt()
void	close()
void	close_pt()
void	connect()	Установка соединения с базой данных
void	connect_pt()
void	&execute_query_pt()
void	fetch_array()	Выбирает строку из результата запроса и возвращает значения из этой строки в виде массива
void	fetch_array_pt()
void	fetch_field()
void	fetch_field_pt()
void	fetch_row()
void	fetch_row_pt()
void	field_name()
void	field_name_pt()
bool	free_result()	Освободить всю память связанную с указанным результатом запроса
void	free_result_pt()
integer	insert_id()	Функция возвращает идентификатор добавленной записи выполненого последнего SQL запроса insert
void	insert_id_pt()
bool	IsError()	Если возникла ошибка в процессе работы с базой данных, то вернет TRUE
integer	num_fields()	Вернуть кол-во полей таблицы из указанного результата SQL запроса
void	num_fields_pt()
integer	num_rows()	Вернуть кол-во записей из результата SQL запроса
void	num_rows_pt()
integer	query()	Выполнить SQL запрос
mixed	&query_first()	Функция возвращает первую запись из SQL запроса в виде ассоциативного массива
integer	query_read()	Выполнить SQL запрос на чтение
integer	query_write()	Выполнить SQL запрос на запись.
void	reConnect()
bool	select_db()	Выбрать базу данных
void	select_db_pt()
void	SetError()
void	system_query()
void	system_query_pt()

[ Top ]

Properties

string $connection = null [line 42]

Ссылка коннекта к БД

API Tags:

Access:

public

[ Top ]

string $database = "" [line 35]

Имя базы

API Tags:

Access:

public

[ Top ]

integer $error = 0 [line 55]

Номер ошибки

API Tags:

Access:

public

[ Top ]

string $errorText = '' [line 61]

Текст ошибки

API Tags:

Access:

public

[ Top ]

array $fetchtypes = array() [line 84]

Массив констант используемых в fetch_array

API Tags:

Access:

public

Redefined in descendants as:

CMSMySqlDB::$fetchtypes : Массив констант используемых в fetch_array

[ Top ]

string $prefix = 'cms_' [line 114]

Префикс таблиц

API Tags:

Access:

public

[ Top ]

integer $querycount = 0 [line 107]

Количество выполненых SQL запросов за текущую сессию

API Tags:

Access:

protected

[ Top ]

bool $readonly = false [line 28]

Режим "Только для чтения".

Если значение установлено в TRUE, то все запросы, которые подразумевают внесения изменений в таблицы базы данных, будут игнорированы.

API Tags:

Access:

public

[ Top ]

CMSRegistry $registry = null [line 19]

Ядро платформы BrickCMS

API Tags:

Access:

public

[ Top ]

string $sql = '' [line 49]

Последний обработанный SQL запрос к базе данных

API Tags:

Access:

protected

[ Top ]

Methods

Constructor CMSDatabase [line 127]

CMSDatabase CMSDatabase(
CMSRegistry
$registry 
)

Конструктор

Parameters:

CMSRegistry

$registry:

API Tags:

Access:

public

[ Top ]

affected_rows [line 360]

integer affected_rows(
)

Вернуть кол-во задействованных строк в последнем запросе insert/replace/update

API Tags:

Access:

public

[ Top ]

affected_rows_pt [line 365]

void affected_rows_pt(
)

API Tags:

Abstract:
Access:	protected

Redefined in descendants as:

CMSMySqlDB::affected_rows_pt()

[ Top ]

ClearError [line 131]

void ClearError(
)

API Tags:

Access:

public

[ Top ]

client_encoding [line 319]

void client_encoding(
)

API Tags:

Access:

public

[ Top ]

client_encoding_pt [line 322]

void client_encoding_pt(
)

API Tags:

Abstract:
Access:	protected

Redefined in descendants as:

CMSMySqlDB::client_encoding_pt()

[ Top ]

close [line 324]

void close(
)

API Tags:

Access:

public

[ Top ]

close_pt [line 327]

void close_pt(
)

API Tags:

Abstract:
Access:	protected

Redefined in descendants as:

CMSMySqlDB::close_pt()

[ Top ]

connect [line 154]

void connect(
string
$database, string
$servername, integer
$port, string
$username, string
$password 
)

Установка соединения с базой данных

Parameters:

string	$database:	имя базы данных
string	$servername:	адрес сервера (имя или IP адрес)
integer	$port:	порт сервера
string	$username:	имя пользователя
string	$password:	пароль пользователя

API Tags:

Access:

public

[ Top ]

connect_pt [line 169]

void connect_pt(

$servername, 
$port, 
$username, 
$password 
)

Parameters:

	$servername:
	$port:
	$username:
	$password:

API Tags:

Abstract:
Access:	protected

Redefined in descendants as:

CMSMySqlDB::connect_pt()

[ Top ]

execute_query_pt [line 217]

void &execute_query_pt(
)

API Tags:

Abstract:
Access:	protected

Redefined in descendants as:

CMSMySqlDB::execute_query_pt()

[ Top ]

fetch_array [line 227]

void fetch_array(
string
$queryresult, [integer
$type = CMSDatabase::DBARRAY_ASSOC] 
)

Выбирает строку из результата запроса и возвращает значения из этой строки в виде массива

Значение $type определяет будет ли массив иметь числовой или ассоциативный ключ, или оба

Parameters:

string	$queryresult:	ID результата SQL запроса
integer	$type:	одно из значений CMSDatabase::DBARRAY_ASSOC / CMSDatabase::DBARRAY_NUM / CMSDatabase::DBARRAY_BOTH

API Tags:

Access:

public

[ Top ]

fetch_array_pt [line 232]

void fetch_array_pt(

$queryresult, [
$type = CMSDatabase::DBARRAY_ASSOC] 
)

Parameters:

	$queryresult:
	$type:

API Tags:

Abstract:
Access:	protected

Redefined in descendants as:

CMSMySqlDB::fetch_array_pt()

[ Top ]

fetch_field [line 335]

void fetch_field(

$queryresult 
)

Parameters:

$queryresult:

API Tags:

Access:

public

[ Top ]

fetch_field_pt [line 339]

void fetch_field_pt(

$queryresult 
)

Parameters:

$queryresult:

API Tags:

Abstract:
Access:	protected

Redefined in descendants as:

CMSMySqlDB::fetch_field_pt()

[ Top ]

fetch_row [line 329]

void fetch_row(

$queryresult 
)

Parameters:

$queryresult:

API Tags:

Access:

public

[ Top ]

fetch_row_pt [line 333]

void fetch_row_pt(

$queryresult 
)

Parameters:

$queryresult:

API Tags:

Abstract:
Access:	protected

Redefined in descendants as:

CMSMySqlDB::fetch_row_pt()

[ Top ]

field_name [line 314]

void field_name(

$queryresult, 
$index 
)

Parameters:

	$queryresult:
	$index:

API Tags:

Access:

public

[ Top ]

field_name_pt [line 317]

void field_name_pt(

$queryresult, 
$index 
)

Parameters:

	$queryresult:
	$index:

API Tags:

Abstract:
Access:	protected

Redefined in descendants as:

CMSMySqlDB::field_name_pt()

[ Top ]

free_result [line 348]

bool free_result(
string
$queryresult 
)

Освободить всю память связанную с указанным результатом запроса

Parameters:

string

$queryresult:

идентификатор указателя на результат SQL запроса

API Tags:

Access:

public

[ Top ]

free_result_pt [line 353]

void free_result_pt(

$queryresult 
)

Parameters:

$queryresult:

API Tags:

Abstract:
Access:	protected

Redefined in descendants as:

CMSMySqlDB::free_result_pt()

[ Top ]

insert_id [line 212]

integer insert_id(
)

Функция возвращает идентификатор добавленной записи выполненого последнего SQL запроса insert

API Tags:

Access:

public

[ Top ]

insert_id_pt [line 215]

void insert_id_pt(
)

API Tags:

Abstract:
Access:	protected

Redefined in descendants as:

CMSMySqlDB::insert_id_pt()

[ Top ]

IsError [line 143]

bool IsError(
)

Если возникла ошибка в процессе работы с базой данных, то вернет TRUE

API Tags:

Access:

public

[ Top ]

num_fields [line 309]

integer num_fields(
integer
$queryresult 
)

Вернуть кол-во полей таблицы из указанного результата SQL запроса

Parameters:

integer

$queryresult:

идентификатор указателя на результат SQL запроса

API Tags:

Access:

public

[ Top ]

num_fields_pt [line 312]

void num_fields_pt(

$queryresult 
)

Parameters:

$queryresult:

API Tags:

Abstract:
Access:	protected

Redefined in descendants as:

CMSMySqlDB::num_fields_pt()

[ Top ]

num_rows [line 297]

integer num_rows(
integer
$queryresult 
)

Вернуть кол-во записей из результата SQL запроса

Parameters:

integer

$queryresult:

идентификатор указателя на результат SQL запроса

API Tags:

Access:

public

[ Top ]

num_rows_pt [line 302]

void num_rows_pt(

$queryresult 
)

Parameters:

$queryresult:

API Tags:

Abstract:
Access:	protected

Redefined in descendants as:

CMSMySqlDB::num_rows_pt()

[ Top ]

query [line 257]

integer query(
string
$sql 
)

Выполнить SQL запрос

Parameters:

string

$sql:

SQL запрос

API Tags:

Return:	идентификатор указателя на результат
Access:	public

[ Top ]

query_first [line 241]

mixed &query_first(
string
$sql, [$type
$type = CMSDatabase::DBARRAY_ASSOC] 
)

Функция возвращает первую запись из SQL запроса в виде ассоциативного массива

Parameters:

string	$sql:	SQL запрос
$type	$type:

API Tags:

Access:

public

[ Top ]

query_read [line 268]

integer query_read(
string
$sql 
)

Выполнить SQL запрос на чтение

Parameters:

string

$sql:

SQL запрос

API Tags:

Return:	идентификатор указателя на результат
Access:	public

[ Top ]

query_write [line 282]

integer query_write(
$sql
$sql, [$ignoreReadOnly
$ignoreReadOnly = false] 
)

Выполнить SQL запрос на запись.

Если параметр $ignoreReadOnly = true, то игнорировать свойство $readonly

Parameters:

$sql	$sql:
$ignoreReadOnly	$ignoreReadOnly:

API Tags:

Return:	идентификатор указателя на результат SQL запроса
Access:	public

[ Top ]

reConnect [line 171]

void reConnect(
)

API Tags:

Access:

public

[ Top ]

select_db [line 182]

bool select_db(
[string
$database = ''] 
)

Выбрать базу данных

Parameters:

string

$database:

имя базы данных

API Tags:

Return:	TRUE - если база данных выбрана
Access:	public

[ Top ]

select_db_pt [line 196]

void select_db_pt(
[
$database = ''] 
)

Parameters:

$database:

API Tags:

Abstract:
Access:	protected

Redefined in descendants as:

CMSMySqlDB::select_db_pt()

[ Top ]

SetError [line 136]

void SetError(

$error 
)

Parameters:

$error:

API Tags:

Abstract:
Access:	protected

Redefined in descendants as:

CMSMySqlDB::SetError()

[ Top ]

system_query [line 367]

void system_query(

$sqls 
)

Parameters:

$sqls:

API Tags:

Access:

public

[ Top ]

system_query_pt [line 373]

void system_query_pt(

$sqls 
)

Parameters:

$sqls:

API Tags:

Abstract:
Access:	protected

Redefined in descendants as:

CMSMySqlDB::system_query_pt()

[ Top ]

Constants

DBARRAY_ASSOC = 1 [line 95]

Тип массива результата SQL запроса: Ассоциативный ключ

[ Top ]

DBARRAY_BOTH = 0 [line 90]

Тип массива результата SQL запроса: Числовой и Ассоциативный ключ

[ Top ]

DBARRAY_NUM = 2 [line 100]

Тип массива результата SQL запроса: Числовой

[ Top ]

ERROR_CONNECT = 1 [line 67]

Ошибка - Связь с базой данных не установлена

[ Top ]

ERROR_EXECUTE_QUERY = 3 [line 77]

Ошибка в SQL запросе, текст ошибки в $errorText

[ Top ]

ERROR_SELECT_DB = 2 [line 72]

Ошибка - База данных $database не найдена

[ Top ]

Documentation generated on Thu, 31 Dec 2009 13:47:21 +0300 by phpDocumentor 1.4.3