hw_api_content->read
(unknown)
hw_api_content->read - читает содержимое.
Описание
string read (string buffer, integer len)
Читает len байтов из содержимого в данный буфер.
hw_api->copy
(unknown)
hw_api->copy - копирует физически.
Описание
object copy (array parameter)
Эта функция делает физическую копию, включая содержимое, если оно имеется, и возвращает новый объект или error-объект. Массив parameter содержит необходимые элементы 'objectIdentifier' и 'destinationParentIdentifier'. Необязательный параметр - 'attributeSelector'.
См. также hwapi_move(), hwapi_link().
hw_api->dbstat
(unknown)
hw_api->dbstat - возвращает статистику о сервере БД.
Описание
object dbstat (array parameter)
См. также hwapi_dcstat(), hwapi_hwstat(), hwapi_ftstat().
hw_api->dcstat
(unknown)
hw_api->dcstat - возвращает статистику сервера о кэшировании документов.
Описание
object dcstat (array parameter)
См. также hwapi_hwstat(), hwapi_dbstat(), hwapi_ftstat().
hw_api->dstanchors
(unknown)
hw_api->dstanchors - возвращает список всех якорей назначения.
Описание
object dstanchors (array parameter)
Запрашивает все якоря назначения объекта. Массив parameter содержит необходимый элемент 'objectIdentifier' и необязательные элементы 'attributeSelector' и 'objectQuery'.
См. также hwapi_srcanchors().
hw_api->dstofsrcanchors
(unknown)
hw_api->dstofsrcanchors - возвращает цель назначения исходного якоря.
Описание
object dstofsrcanchors (array parameter)
Запрашивает объект назначения, на который указывают специфицированные якоря-источники. Объект назначения может быть якорем назначения или всем документом целиком. Массив parameter содержит необходимый элемент 'objectIdentifier' и необязательный элемент 'attributeSelector'.
См. также hwapi_srcanchors(), hwapi_dstanchors(), hwapi_objectbyanchor().
hw_api_error->count
(unknown)
hw_api_error->count - возвращает количество причин/reasons.
Описание
int count (void)
Возвращает количество причин ошибок.
См. также hwapi_error_reason().
hw_api_error->reason
(unknown)
hw_api_error->reason - возвращает причину ошибки.
Описание
object reason (void)
Возвращает первую причину ошибки.
См. также hwapi_error_count().
hw_api->find
(unknown)
Описание
array find (array parameter)
Эта функция ищет объекты, выполняя поиск по ключу и/или полнотекстовый поиск. Найденные объекты могут затем быть отфильтрованы необязательным
запросом объектов. Они сортируются по значимости. Вторая операция поиска относительно медленнее, и её результат может быть ограничен определённым
количеством совпадений. Это позволяет выполнять поиск с расширением, возвращая каждый раз поднабор всех найденных документов, начиная с заданного индекса.
Массив parameter содержит 'keyquery' и/или 'fulltextquery', в зависимости от того, что вы хотели бы найти. Необязательными являются параметры
'objectquery', 'scope', 'lanugages' и 'attributeselector'. В случае поиска с расширением, могут передаваться необязательные параметры 'startIndex',
numberOfObjectsToGet' и 'exactMatchUnit'.
hw_api->ftstat
(unknown)
hw_api->ftstat - возвращает статистику полнотекстового сервера.
Описание
object ftstat (array parameter)
См. также hwapi_dcstat(), hwapi_dbstat(), hwapi_hwstat().
hwapi_hgcsp
(unknown)
hwapi_hgcsp - возвращает объект класса hw_api.
Описание
object hwapi_hgcsp (string hostname [, int port])
Открывает соединение с Hyperwave-сервером на хосте hostname. Используется протокол HGCSP. Если вы не передаёте номер порта, используется 418.
См. также hwapi_hwtp().
hw_api->hwstat
(unknown)
hw_api->hwstat - возвращает статистику о Hyperwave-сервере.
Описание
object hwstat (array parameter)
См. также hwapi_dcstat(), hwapi_dbstat(), hwapi_ftstat().
hw_api->identify
(unknown)
hw_api->identify - входит в Hyperwave-сервер.
Описание
object identify (array parameter)
Входит (логин) в Hyperwave Server. Массив parameter обязан содержать элементы 'username' и 'password'.
return-значением будет объект типа HW_API_Error, если идентификация не удастся, или TRUE, если она пройдёт успешно.
hw_api->info
(unknown)
hw_api->info - возвращает информацию о конфигурации сервера.
Описание
object info (array parameter)
См. также hwapi_dcstat(), hwapi_dbstat(), hwapi_ftstat(), hwapi_hwstat().
hw_api->insert
(unknown)
hw_api->insert - вставляет новый объект.
Описание
object insert (array parameter)
Вставляет новый объект. Тип объекта может быть user, group, document или anchor. В зависимости от типа, могут быть вставлены и друге атрибуты объекта. Массив parameter содержит необходимые элементы 'object' и 'content' (если объект является документом) и необязательные параметры 'parameters', 'mode' и 'attributeSelector'.
Элемент 'object' обязан содержать все атрибуты объекта.
'parameters' это объект, также содержащий атрибуты вроде назначения (ключ
атрибута - 'Parent').
'content' это содержимое документа.
'mode' это комбинация следующих флагов:
- HW_API_INSERT_NORMAL
Объект вставляется в сервер.
- HW_API_INSERT_FORCE-VERSION-CONTROL
- HW_API_INSERT_AUTOMATIC-CHECKOUT
- HW_API_INSERT_PLAIN
- HW_API_INSERT_KEEP_TIME_MODIFIED
- HW_API_INSERT_DELAY_INDEXING
См. также hwapi_replace().
hw_api->insertanchor
(unknown)
hw_api->insertanchor - вставляет новый объект типа anchor.
Описание
object insertanchor (array parameter)
Эта функция является сокращением hwapi_insert(). Она вставляет объект типа anchor и устанавливает некоторые из атрибутов, необходимые для якоря/anchor. Массив parameter содержит необходимые элементы object' и 'documentIdentifier' и необязательные элементы 'destinationIdentifier', 'parameter', 'hint' и 'attributeSelector'.
'documentIdentifier' специфицирует документ, где якорь будет вставлен. Цель якоря устанавливается в 'destinationIdentifier', если она уже существует. Если цель не существует, в элемент 'hint' должно быть установлено имя объекта, который предполагается вставить позднее. После вставки цель якоря разрешается автоматически.
См. также hwapi_insertdocument(), hwapi_insertcollection(), hwapi_insert().
hw_api->insertcollection
(unknown)
hw_api->insertcollection - вставляет новый объект типа collection.
Описание
object insertcollection (array parameter)
Эта функция является аббревиатурой hwapi_insert(). Она вставляет объект типа collection и устанавливает некоторые атрибуты, необходимые для collection. Массив parameter содержит необходимые элементы 'object' и 'parentIdentifier' и необязательные элементы 'parameter' и 'attributeSelector'. См. в hwapi_insert() значение каждого элемента.
См. также hwapi_insertdocument(), hwapi_insertanchor(), hwapi_insert().
hw_api->insertdocument
(unknown)
hw_api->insertdocument - вставляет новый объект типа document.
Описание
object insertdocument (array parameter)
Эта функция является аббревиатурой hwapi_insert(). Она вставляет объект с содержимым и устанавливает некоторые необходимые для документа атрибуты. Массив parameter содержит необходимые элементы 'object', 'parentIdentifier' и 'content' и необязательные элементы 'mode', 'parameter' и 'attributeSelector'. См. в hwapi_insert() значение каждого элемента.
См. также hwapi_insert(), hwapi_insertanchor(), hwapi_insertcollection().
hw_api->link
(unknown)
hw_api->link - создаёт ссылку/link на объект.
Описание
object link (array parameter)
Создаёт ссылку на объект. Доступ по этой ссылке похож на доступ к объекту, на который указывают ссылки. Массив parameter содержит необходимые элементы 'objectIdentifier' и 'destinationParentIdentifier'. 'destinationParentIdentifier' это целевая коллекция.
Функция возвращает true при успехе или error-объект.
См. также hwapi_copy().
hw_api->lock
(unknown)
hw_api->lock - блокирует объект.
Описание
object lock (array parameter)
Блокирует объект для редактирования его пользователем, вызвавшим эту функцию. Этот объект может быть разблокирован только этим пользователем или системным пользователем. Массив parameter содержит необходимый элемент 'objectIdentifier' и необязательные параметры 'mode' и 'objectquery'. 'mode' определяет, как объект блокируется. HW_API_LOCK_NORMAL означает, что объект блокирован, пока не будет разблокирован. HW_API_LOCK_RECURSIVE верно только для коллекции и блокирует все объекты в этой коллекции и возможные подколлекции. HW_API_LOCK_SESSION означает, что объект блокирован, только пока сессия верна.
См. также hwapi_unlock().
hw_api->move
(unknown)
hw_api->move - перемещает объект между коллекциями.
Описание
object move (array parameter)
См. также hw_objrec2array().
hw_api_content
(unknown)
hw_api_content - создаёт новый экземпляр класса hw_api_content.
Описание
string content (string content, string mimetype)
Создаёт новый content-объект из строки
content.
mimetype получает значение mimetype.
hw_api->object
(unknown)
hw_api->object - запрашивает информацию атрибутов.
Описание
object hw_api->object (array parameter)
Эта функция запрашивает информацию атрибутов объекта любой версии. Она не возвращает содержимое документа. Массив parameter содержит необходимый элемент 'objectIdentifier' и необязательные элементы 'attributeSelector' и 'version'.
Возвращённый объект является экземпляром класса HW_API_Object при успехе или класса HW_API_Error - при возникновении ошибки.
В следующем простом примере объект запрашивается и проверяется на наличие ошибок.
Пример 1. Запрашивание объекта
<?php
function handle_error($error) {
$reason = $error->reason(0);
echo "Type: <B>";
switch($reason->type()) {
case 0:
echo "Error";
break;
case 1:
echo "Warning!";
break;
case 2:
echo "Message";
break;
}
echo "</B><BR>\n";
echo "Description: ".$reason->description("en")."<BR>\n";
}
function list_attr($obj) {
echo "<TABLE>\n";
$count = $obj->count();
for($i=0; $i<$count; $i++) {
$attr = $obj->attribute($i);
printf(" <TR><TD bgcolor=#c0c0c0><B>%s</B></TD><TD bgcolor=#F0F0F0>%s</TD>\n",
$attr->key(), $attr->value());
}
echo "</TABLE>\n";
}
$hwapi = hwapi_hgcsp($g_config[HOSTNAME]);
$parms = array("objectIdentifier"=>"rootcollection, "attributeSelector"=>array("Title", "Name", "DocumentType"));
$root = $hwapi->object($parms);
if(get_class($root) == "HW_API_Error") {
handle_error($root);
exit;
}
list_attr($root);
?>См. также hwapi_content().
hw_api_object->assign
(unknown)
hw_api_object->assign - клонирует объект.
Описание
object assign (array parameter)
Клонирует атрибуты объекта.
hw_api_object->attreditable
(unknown)
hw_api_object->attreditable - проверяет, является ли атрибут редактируемым.
Описание
bool attreditable (array parameter)
hw_api_object->count
(unknown)
hw_api_object->count - возвращает количество атрибутов.
Описание
int count (array parameter)
hw_api_object->insert
(unknown)
hw_api_object->insert - вставляет новый атрибут.
Описание
bool insert (object attribute)
Добавляет новый атрибут объекту. Возвращает true при успехе, иначе false.
См. также hwapi_object_remove().
hw_api_object
(unknown)
hw_api_object - создаёт новый экземпляр класса hw_api_object.
Описание
object hw_api_object (array parameter)
См. также hwapi_lock().
hw_api_object->remove
(unknown)
hw_api_object->remove - удаляет атрибут.
Описание
bool remove (string name)
Удаляет атрибут с данным именем name. Возвращает true при успехе, иначе false.
См. также hwapi_object_insert().
hw_api_object->title
(unknown)
hw_api_object->title - возвращает атрибут title.
Описание
string title (array parameter)
hw_api_object->value
(unknown)
hw_api_object->value - возвращает значение атрибута.
Описание
string value (string name)
Возвращает значение атрибута с данным именем или false, если возникла ошибка.
hw_api->objectbyanchor
(unknown)
hw_api->objectbyanchor - возвращает объект, к которому принадлежит якорь/anchor.
Описание
object objectbyanchor (array parameter)
Эта функция запрашивает объект, к которому принадлежит специфицированный якорь. Массив parameter содержит необходимый элемент 'objectIdentifier' и необязательный элемент 'attributeSelector'.
См. также hwapi_dstofsrcanchor(), hwapi_srcanchors(), hwapi_dstanchors().
hw_api->parents
(unknown)
hw_api->parents - возвращает предков объекта.
Описание
array parents (array parameter)
Запрашивает предков объекта. Предки могут быть затем отфильтрованы путём специфицирования запроса объекта. Массив parameter содержит необходимый элемент 'objectidentifier' и необязательные элементы 'attributeselector' и 'objectquery'.
return-значением является массив объектов типа HW_API_Object или HW_API_Error.
См. также hwapi_children().
hw_api_reason->description
(unknown)
hw_api_reason->description - возвращает описание причины/reason.
Описание
string description (void)
Возвращает описание причины.
hw_api_reason->type
(unknown)
hw_api_reason->type - возвращает тип причины/reason.
Описание
object type (void)
Возвращает тип причины.
hw_api->remove
(unknown)
hw_api->remove - удаляет объект.
Описание
object remove (array parameter)
Эта функция удаляет объект из специфицированного предка. Коллекции будут удаляться рекурсивно. Вы можете передать необязательный объект запроса для удаления только тех объектов, которые совпадают с запросом/query. Объект будет удалён физически, если это последний экземпляр. Массив parameter содержит необходимые элементы 'objectidentifier' и 'parentidentifier'. Если вы хотите удалить пользователя или группу, 'parentidentifier' можно опустить. Необязательный параметр 'mode' определяет, как выполняется удаление. В режиме normal объект не будет физически удалён, пока не будут удалены все экземпляры. В режиме physical все экземпляры объекта будут немедленно удалены. В режиме removelinks все ссылки на и из объектов будут также удалены. В режиме nonrecursive удаление не выполняется рекурсивно. Удаление непустой коллекции приведёт к ошибке.
См. также hwapi_move().
hw_api->replace
(unknown)
hw_api->replace - заменяет объект.
Описание
object replace (array parameter)
Заменяет атрибуты и содержимое объекта. Массив parameter содержит необходимые элементы 'objectIdentifier' и 'object' и необязательные параметры 'content', 'parameters', 'mode' и 'attributeSelector'. 'objectIdentifier' содержит заменяемый объект. 'object' содержит новый объект. 'content' это новое содержимое. 'parameters' содержит дополнительную информацию для HTML-документов. HTML_Language это аббревиатура языка заголовка. HTML_Base устанавливает атрибут base документа HTML. 'mode' может быть комбинацией следующих флагов:
- HW_API_REPLACE_NORMAL
Объект на сервере заменяется передаваемым объектом.
- HW_API_REPLACE_FORCE_VERSION_CONTROL
- HW_API_REPLACE_AUTOMATIC_CHECKOUT
- HW_API_REPLACE_AUTOMATIC_CHECKIN
- HW_API_REPLACE_PLAIN
- HW_API_REPLACE_REVERT_IF_NOT_CHANGED
- HW_API_REPLACE_KEEP_TIME_MODIFIED
См. также hwapi_insert().
hw_api->setcommitedversion
(unknown)
hw_api->setcommitedversion - подтверждает версию, отличную от последней версии.
Описание
object setcommitedversion (array parameter)
Подтверждает версию документа. Подтверждённая версия это такая версия, которая видна пользователям, имеющим доступ для чтения. По умолчанию последняя версия это подтверждённая версия.
См. также hwapi_checkin(), hwapi_checkout(), hwapi_revert().
hw_api->srcanchors
(unknown)
hw_api->srcanchors - возвращает список всех якорей-источников.
Описание
object srcanchors (array parameter)
Запрашивает все якоря-источники объекта. Массив parameter содержит необходимый элемент 'objectIdentifier' и необязательные элементы 'attributeSelector' и 'objectQuery'.
См. также hwapi_dstanchors().
hw_api->srcsofdst
(unknown)
hw_api->srcsofdst - возвращает источник объекта назначения.
Описание
object srcsofdst (array parameter)
Запрашивает все якоря-источники, указывающие на специфицированную цель. Объект-назначение может быть якорем назначения, либо документом. Массив parameter содержит необходимый элемент 'objectIdentifier' и необязательные элементы 'attributeSelector' и 'objectQuery'. Функция возвращает массив объектов или ошибку.
См. также hwapi_dstofsrcanchor().
hw_api->unlock
(unknown)
hw_api->unlock - разблокирует блокированный объект.
Описание
object unlock (array parameter)
Разблокирует объект. Только пользователь, блокировавший объект, и системный пользователь/администратор могут разблокировать объект. Массив parameter содержит необходимый элемент 'objectIdentifier' и необязательные параметры 'mode' и 'objectquery'. Значения 'mode' - те же, что и для функции hwapi_lock().
Возвращает true при успехе или объект класса HW_API_Error.
См. также hwapi_lock().
hw_api->user
(unknown)
hw_api->user - возвращает объект user.
Описание
object user (array parameter)
См. также hwapi_userlist().
hw_api->userlist
(unknown)
hw_api->userlist - возвращает список всех вошедших/logged пользователей.
Описание
object userlist (array parameter)
См. также hwapi_user().
hypot
(PHP 4 >= 4.1.0)
hypot - возвращает sqrt( num1*num1 + num2*num2)
Описание
float hypot (float num1, float num2)
ibase_blob_add
(PHP 3>= 3.0.7, PHP 4)
ibase_blob_add - добавляет данные в созданный blob.
Описание
int ibase_blob_add (int blob_id, string data)
ibase_blob_cancel
(PHP 3>= 3.0.7, PHP 4)
ibase_blob_cancel - отменяет создание blob.
Описание
int ibase_blob_cancel (int blob_id)
ibase_blob_close
(PHP 3>= 3.0.7, PHP 4)
ibase_blob_close - закрывает blob.
Описание
int ibase_blob_close (int blob_id)
ibase_blob_create
(PHP 3>= 3.0.7, PHP 4)
ibase_blob_create - создаёт blob для добавления данных.
Описание
int ibase_blob_create ([int link_identifier])
ibase_blob_echo
(PHP 3>= 3.0.7, PHP 4)
ibase_blob_echo - выводит содержимое blob в браузер.
Описание
int ibase_blob_echo (string blob_id_str)
ibase_blob_get
(PHP 3>= 3.0.7, PHP 4)
ibase_blob_get - получает len байт данных из открытого blob.
Описание
string ibase_blob_get (int blob_id, int len)
ibase_blob_import
(PHP 3>= 3.0.7, PHP 4)
ibase_blob_import - создаёт blob, копирует в него файл и закрывает его.
Описание
string ibase_blob_import ([int link_identifier, int file_id])
ibase_blob_info
(PHP 3>= 3.0.7, PHP 4)
ibase_blob_info - возвращает размер blob и другую информацию.
Описание
object ibase_blob_info (string blob_id_str)
ibase_blob_open
(PHP 3>= 3.0.7, PHP 4)
ibase_blob_open - открывает blob для запрашивания частей данных.
Описание
int ibase_blob_open (string blob_id)
ibase_close
(PHP 3>= 3.0.6, PHP 4)
ibase_close - закрывает соединение с БД InterBase.
Описание
int ibase_close ([int connection_id])
Закрывает ссылку на БД InterBase, ассоциированную с id соединения, возвращённым из ibase_connect(). Если id соединения опущен, принимается последняя открытая ссылка. Транзакция по умолчанию для ссылки подтверждается, другие транзакции откатываются.
ibase_commit
(PHP 3>= 3.0.7, PHP 4)
ibase_commit - подтверждает транзакцию.
Описание
int ibase_commit ([int link_identifier, int trans_number])
Подтверждает транзакцию trans_number, которая была создана функцией ibase_trans().
ibase_connect
(PHP 3>= 3.0.6, PHP 4)
ibase_connect - открывает соединение с БД InterBase.
Описание
int ibase_connect (string database [, string username [, string password [, string charset [, int buffers [, int dialect [, string role]]]]]])
Устанавливает соединение с InterBase-сервером. Аргумент database должен быть правильным путём к файлу БД на сервере, на котором он находится.
Если сервер не является локальным, он обязан иметь префикс 'hostname:' (TCP/IP) '//hostname/' (NetBEUI), или 'hostname@' (IPX/SPX),
в зависимости от используемого протокола соединения.
username и password могут также быть специфицированными директивами конфигурации PHP ibase.default_user
и ibase.default_password.
charset это набор символов по умолчанию для БД.
buffers это это количество буферов БД, выделяемых серверным кэшем. Если 0 или опущен, сервер выбирает собственное значение по умолчанию.
dialect выбирает диалект SQL по умолчанию для любого оператора, выполняемого внутри
соединения, и по умолчанию является наивысшим, поддерживаемым клиентскими библиотеками.
Если делается второй вызов ibase_connect() с теми же аргументами, новая ссылка не устанавливается, но возвращается идентификатор уже открытой ссылки. Ссылка на сервер будет закрыта сразу же по окончании работы скрипта, если она не будет закрыта до этого явным образом путём вызова ibase_close().
ibase_errmsg
(PHP 3>= 3.0.7, PHP 4)
ibase_errmsg - возвращает сообщения об ошибках.
Описание
string ibase_errmsg (void)
Возвращает строку с сообщением об ошибке.
ibase_execute
(PHP 3>= 3.0.6, PHP 4)
ibase_execute - выполняет ранее подготовленный запрос/query.
Описание
int ibase_execute (int query [, int bind_args])
Выполняет запрос, подготовленный функцией ibase_prepare(). Это намного эффективнее, чем использование ibase_query(), если вы повторяете запрос того же вида несколько раз с изменением только некоторых параметров.
<?php
$updates = array(
1 => 'Eric',
5 => 'Filip',
7 => 'Larry'
);
$query = ibase_prepare("UPDATE FOO SET BAR = ? WHERE BAZ = ?");
while (list($baz, $bar) = each($updates)) {
ibase_execute($query, $bar, $baz);
}
?>ibase_fetch_object
(PHP 3>= 3.0.7, PHP 4)
ibase_fetch_object - получает объект из БД InterBase.
Описание
object ibase_fetch_object (int result_id)
Извлекает ряд как псевдообъект из result_id, полученного функцией ibase_query() или ibase_execute().
ibase_fetch_row
(PHP 3>= 3.0.6, PHP 4)
ibase_fetch_row - извлекает ряд из БД InterBase.
Описание
array ibase_fetch_row (int result_identifier)
Возвращает массив, соответствующий извлечённому ряду, или FALSE, если рядов больше нет.
ibase_fetch_row() извлекает один ряд данных из результата, ассоциированного со специфицированным result_identifier. Ряд возвращается как массив. Каждый результирующий столбец хранится в смещении массива, начиная со смещения 0.
Последующий вызов ibase_fetch_row() возвратит следующий ряд результирующего набора или FALSE, если рядов больше нет.
ibase_field_info
(PHP 3>= 3.0.7, PHP 4)
ibase_field_info - получает информацию о поле.
Описание
array ibase_field_info (int result, int field number)
Возвращает массив с информацией о поле после запуска запроса выборки/select query. Массив имеет форму name/имя, alias/псевдоним, relation/реляция, length/размер, type/тип.
$rs=ibase_query("SELECT * FROM tablename");
$coln = ibase_num_fields($rs);
for ($i=0; $i < $coln; $i++) {
$col_info = ibase_field_info($rs, $i);
echo "name: ".$col_info['name']."\n";
echo "alias: ".$col_info['alias']."\n";
echo "relation: ".$col_info['relation']."\n";
echo "length: ".$col_info['length']."\n";
echo "type: ".$col_info['type']."\n";
}ibase_free_query
(PHP 3>= 3.0.6, PHP 4)
ibase_free_query - освобождает память, занимаемую подготовленным запросом.
Описание
int ibase_free_query (int query)
Освобождает запрос, подготовленный функцией ibase_prepare().
ibase_free_result
(PHP 3>= 3.0.6, PHP 4)
ibase_free_result - освобождает результирующий набор.
Описание
int ibase_free_result (int result_identifier)
Освобождает результирующий набор, созданный функцией ibase_query().
ibase_num_fields
(PHP 3>= 3.0.7, PHP 4)
ibase_num_fields - получает количество полей в результирующем наборе.
Описание
int ibase_num_fields (int result_id)
Возвращает целое число - количество полей в результирующем наборе.
ibase_pconnect
(PHP 3>= 3.0.6, PHP 4)
ibase_pconnect - создаёт постоянное соединение с БД InterBase.
Описание
int ibase_pconnect (string database [, string username [, string password [, string charset [, int buffers [, int dialect [, string role]]]]]])
ibase_pconnect() работает почти так же, как ibase_connect(), но с двумя отличиями. Во-первых, при соединении эта функция сначала пытается найти (постоянную) ссылку, уже открытую с теми же параметрами. Если она найдена, возвращается её идентификатор вместо открытия нового соединения. Во-вторых, соединение с InterBase-сервером не будет закрыто по окончании выполнения скрипта. Ссылка остаётся открытой для последующего использования (ibase_close() не будет закрывать ссылки, установленные функцией ibase_pconnect()). Ссылки этого типа называются поэтому 'persistent/постоянные'.
Примечание: buffers был введён в PHP4-RC2.
Примечание: dialect был введён в PHP4-RC2. Он работает только с версией InterBase 6 и новее.
Примечание: role был введён в PHP4-RC2. Он работает только с версией InterBase 5 и новее.
См. также в описании ibase_connect() значения параметров, передаваемых этой функции. Они точно такие же.
ibase_prepare
(PHP 3>= 3.0.6, PHP 4)
ibase_prepare - готовит запрос/query для последующей привязки заглушек параметров и выполнения.
Описание
int ibase_prepare ([int link_identifier, string query])
Готовит запрос для последующей привязки заглушек параметров и выполнения (через ibase_execute()).
ibase_query
(PHP 3>= 3.0.6, PHP 4)
ibase_query - выполняет запрос к БД InterBase.
Описание
int ibase_query ([int link_identifier, string query [, int bind_args]])
Выполняет запрос к БД InterBase. Если запрос терпи неудачу, возвращается FALSE. Если он выполнен успешно и имеются результирующие ряды (как в запросе SELECT), возвращается идентификатор результата. Если прошёл успешно и результатов нет, возвращает TRUE. Возвращает FALSE, если запрос терпит неудачу.
См. также ibase_errmsg(), ibase_fetch_row(), ibase_fetch_object() и ibase_free_result().
ibase_rollback
(PHP 3>= 3.0.7, PHP 4)
ibase_rollback - откатывает транзакцию.
Описание
int ibase_rollback ([int link_identifier, int trans_number])
Откатывает транзакцию trans_number, которая была создана функцией ibase_trans().
ibase_timefmt
(PHP 3>= 3.0.6, PHP 4)
ibase_timefmt - устанавливает формат столбцов timestamp, date и time, возвращаемых запросами.
Описание
int ibase_timefmt (string format [, int columntype])
Устанавливает формат столбцов timestamp, date и time, возвращаемых запросами. Внутренне функции форматируются c-функцией
strftime(), поэтому обратитесь к её документации по вопросу формата строки.
columntype это одна из констант: IBASE_TIMESTAMP, IBASE_DATE или IBASE_TIME. Если опущен,
по умолчанию IBASE_TIMESTAMP - для обеспечения обратной совместимости.
ibase_trans
(PHP 3>= 3.0.7, PHP 4)
ibase_trans - начинает транзакцию.
Описание
int ibase_trans ([int trans_args [, int link_identifier]])
Начинает транзакцию.
icap_close
(unknown)
icap_close - закрывает поток ICAP.
Описание
int icap_close (int icap_stream [, int flags])
Закрывает данный icap-поток.
icap_create_calendar
(PHP 4)
icap_create_calendar - создаёт новый календарь.
Описание
string icap_create_calendar (int stream_id, string calendar)
icap_delete_calendar
(PHP 4)
icap_delete_calendar - удаляет календарь.
Описание
string icap_delete_calendar (int stream_id, string calendar)
icap_delete_event
(PHP 4)
icap_delete_event - удаляет событие из ICAP-календаря.
Описание
string icap_delete_event (int stream_id, int uid)
icap_delete_event() удаляет календарное событие, специфицированное параметром uid.
Возвращает TRUE.
icap_fetch_event
(PHP 4)
icap_fetch_event - извлекает событие из потока календаря.
Описание
int icap_fetch_event (int stream_id, int event_id [, int options])
icap_fetch_event() извлекает событие из потока календаря, специфицированного параметром event_id.
Возвращает объект события, состоящий из:
int id - ID этого события.
int public - TRUE, если событие public, FALSE, если private.
string category - категория строки события.
string title - строка заголовка события.
string description - описание строки события.
int alarm - количество минут перед отправкой событием alarm/reminder (предупреждения/напоминания).
object start - объект, содержащий вхождение datetime.
object end - объект, содержащий вхождение datetime.
Все вхождения datetime состоят из объекта, содержащего:
int year - год
int month - месяц
int mday - день месяца
int hour - час
int min - минуты
int sec - секунды
icap_list_alarms
(PHP 4)
icap_list_alarms - возвращает список событий, имеющих включённое alarm/предупреждение в данное datetime.
Описание
int icap_list_alarms (int stream_id, array date, array time)
Возвращает массив ID события, которое имеет отправленное alarm в данное datetime.
icap_list_alarms() принимает datetime для календарного потока. Возвращается массив id события, которое уже выдало alarm в данное datetime.
Все вхождения datetime состоят из объекта, который содержит:
int year - год
int month - месяц
int mday - день/число месяца
int hour - час
int min - минуты
int sec - секунды
icap_list_events
(PHP 4)
icap_list_events - возвращает список событий между двумя данными datetimes.
Описание
array icap_list_events (int stream_id, int begin_date [, int end_date])
Возвращает массив ID'ов событий, произошедших между двумя данными datetimes.
icap_list_events() принимает начальное и конечное datetime для потока календаря. Возвращается массив id'ов событий, произошедших между двумя данными datetimes.
Все вхождения datetime состоят из объекта, который содержит:
int year - год
int month - месяц
int mday - день/число месяца
int hour - час
int min - минуты
int sec - секунды
icap_open
(PHP 4)
icap_open - открывает ICAP-соединение.
Описание
stream icap_open (string calendar, string username, string password, string options)
Возвращает поток ICAP-поток, FALSE - при ошибке.
icap_open() открывает ICAP-соединение со специфицированным хранилищем calendar. Если необязательный параметр options специфицирован, передаёт также options в этот mailbox/почтовый ящик.
icap_rename_calendar
(PHP 4)
icap_rename_calendar - переименовывает календарь.
Описание
string icap_rename_calendar (int stream_id, string old_name, string new_name)
icap_reopen
(PHP 4)
icap_reopen - повторно открывает поток ICAP для нового календаря.
Описание
int icap_reopen (int stream_id, string calendar [, int options])
icap_snooze
(PHP 4)
icap_snooze - "усыпляет" (????) alarm.
Описание
string icap_snooze (int stream_id, int uid)
icap_snooze() включае/turns on (????) напоминание/alarm для календарного события, специфицированного параметром uid.
Возвращает TRUE.
icap_store_event
(PHP 4)
icap_store_event - сохраняет событие в ICAP-календаре.
Описание
string icap_store_event (int stream_id, object event)
icap_store_event() сохраняет событие в ICAP-календаре. Объект события состоит из:
int public - 1, если public, 0, если private.
string category - строки категории события.
string title - заголовка события.
string description - строки описания события.
int alarm - количество минут перед вставкой событием напоминания.
datetime start - datetime-объек начала события.
datetime end - datetime-объект конца события.
Все вхождения datetime состоят из объекта, который содержит:
int year - год
int month - месяц
int mday - день/число месяца
int hour - час
int min - минуты
int sec - секунды
Возвращает TRUE при успехе, FALSE при ошибке.
iconv
(PHP 4 >= 4.0.5)
iconv - конвертирует строку в запрошенную кодировку символов.
Описание
string iconv (string in_charset, string out_charset, string str)
Конвертирует строку string, кодированную в наборе символов in_charset, в строку, кодированную в наборе символов out_charset. Возвращает конвертированную строку или FALSE, если конвертация не удалась.
iconv_get_encoding
(PHP 4 >= 4.0.5)
iconv_get_encoding - получает текущие установки для конвертации кодировки символов.
Описание
array iconv_get_encoding ([string type])
Возвращает текущие установки ob_iconv_handler() как массив, или FALSE при неудаче.
См. также iconv_set_encoding() и ob_iconv_handler().
iconv_set_encoding
(PHP 4 >= 4.0.5)
iconv_set_encoding - устанавливает текущие установки для конвертации кодировки символов.
Описание
array iconv_set_encoding (string type, string charset)
Изменяет значение type на charset и возвращает TRUE при успехе или FALSE при неудаче.
ifx_affected_rows
(PHP 3>= 3.0.3, PHP 4)
ifx_affected_rows - получает количество рядов, задействованных в запросе.
Описание
int ifx_affected_rows (int result_id)
result_id это правильный id результата, возвращённый функциями ifx_query() или ifx_prepare().
Возвращает количество рядов, задействованных в запросе, ассоциированном с result_id.
Для insert, update и delete количество является реальным числом (sqlerrd[2]) использованных рядов. Для select оно является приблизительным (sqlerrd[0]). Не полагайтесь на него. Сервер БД никогда не сможет возвратить фактическое количество рядов, возвращённых оператором SELECT, поскольку он даже не начинал их извлечение на этом этапе (только после "PREPARE", когда оптимизатор определили план запроса).
Используется после ifx_prepare() для ограничения запросов рациональными результирующими наборами.
См. также ifx_num_rows().
ifx_blobinfile_mode
(PHP 3>= 3.0.4, PHP 4)
ifx_blobinfile_mode - устанавливает blob-режим по умолчанию для всех запросов select.
Описание
void ifx_blobinfile_mode (int mode)
Устанавливает blob-режим по умолчанию для всех запросов select. Режим "0" означает сохранение Byte-Blobs в памяти, а режим "1" означает сохранение Byte-Blobs файле.
ifx_byteasvarchar
(PHP 3>= 3.0.4, PHP 4)
ifx_byteasvarchar - устанавливает байтовый режим по умолчанию.
Описание
void ifx_byteasvarchar (int mode)
Устанавливает байтовый режим по умолчанию для всех select-запросов. Режим "0" возвратит blob id, а режим "1" возвратит varchar с текстовым содержимым.
ifx_close
(PHP 3>= 3.0.3, PHP 4)
ifx_close - закрывает соединение Informix.
Описание
int ifx_close ([int link_identifier])
Возвращает всегда TRUE.
ifx_close() закрывает ссылку на БД Informix, ассоциированную (ссылку) со специфицированным идентификатором ссылки. Если идентификатор ссылки не специфицирован, принимается последняя открытая ссылка.
Заметьте, что в этом обычно нет надобности, так как непостоянные открытые ссылки автоматически закрываются по окончании выполнения скрипта.
ifx_close() не закроет постоянные ссылки, сгенерированные функцией ifx_pconnect().
См. также ifx_connect() и ifx_pconnect().
ifx_connect
(PHP 3>= 3.0.3, PHP 4)
ifx_connect - открывает соединение с Informix-сервером.
Описание
int ifx_connect ([string database [, string userid [, string password]]])
Возвращает идентификатор соединения при успехе либо FALSE при ошибке.
ifx_connect() устанавливает соединение с сервером Informix. Все аргументы являются необязательными и, если они отсутствуют, принимаются значения по умолчанию из файла конфигурации (ifx.default_host для хоста (библиотеки Informix будут использовать значение окружения INFORMIXSERVER, если не определено), ifx.default_user для user, ifx.default_password для password (none, если не определено).
Если второй вызов ifx_connect() сделан с теми же аргументами, новая ссылка не устанавливается, а будет возвращён идентификатор уже открытой ссылки.
Ссылка на сервер будет закрыта сразу после окончания работы скрипта, если не будет закрыта до этого явным вызовом ifx_close().
См. также ifx_pconnect() и ifx_close().
ifx_copy_blob
(PHP 3>= 3.0.4, PHP 4)
ifx_copy_blob - дублирует данный blob-объект.
Описание
int ifx_copy_blob (int bid)
Дублирует данный blob-объект. bid это ID этого blob-объекта.
Возвращает FALSE при ошибке, иначе id нового blob-объекта.
ifx_create_blob
(PHP 3>= 3.0.4, PHP 4)
ifx_create_blob - создаёт blob-объект.
Описание
int ifx_create_blob (int type, int mode, string param)
Создаёт blob-объект.
type: 1 = TEXT, 0 = BYTE
mode: 0 = blob-объект хранит содержимое в памяти, 1 = хранит содержимое в файле.
param: если mode = 0: указатель на содержимое, если mode = 1: указатель на строку файла/filestring.
Возвращает FALSE при ошибке, иначе id нового blob-объекта.
ifx_create_char
(PHP 3>= 3.0.6, PHP 4)
ifx_create_char - создаёт char-объект.
Описание
int ifx_create_char (string param)
Создаёт char-объект. param должен иметь содержимое char.
ifx_do
(PHP 3>= 3.0.4, PHP 4)
ifx_do - выполняет ранее подготовленный SQL-оператор.
Описание
int ifx_do (int result_id)
Возвращает TRUE при успехе, FALSE при ошибке.
Выполняет ранее подготовленный запрос/query или открывает курсор для него.
НЕ освобождает result_id при ошибке.
Также устанавливает реальное количество задействованных рядов для не-select операторов для запроса функцией ifx_affected_rows().
См. также ifx_prepare(), где имеется пример.
ifx_error
(PHP 3>= 3.0.3, PHP 4)
ifx_error - возвращает код ошибки последнего вызова Informix.
Описание
string ifx_error (void)
Коды ошибок Informix (SQLSTATE & SQLCODE) форматируются так:
x [SQLSTATE = aa bbb SQLCODE=cccc]
где x = space: нет ошибки
E: ошибка
N: больше нет данных
W: предупреждение
?: undefined
Если символ "x" это нечто отличное от пробела, SQLSTATE и SQLCODE описывают ошибку более детально.
См. в учебнике Informix описание SQLSTATE и SQLCODE.
Возвращает в виде строки один символ, описывающий общие результаты выполнения операции, и SQLSTATE и SQLCODE, ассоциированные с самым последним выполненным SQL-оператором. Формат строки таков: "(char) [SQLSTATE=(две цифры) (три цифры) SQLCODE=(одна цифра)]". Первый символ может быть ' ' (space) (успешно), 'W' (оператор выдаёт некое предупреждение), 'E' (при выполнении оператора возникла ошибка) или 'N' (оператор не возвратил данных).
См. также ifx_errormsg().
ifx_errormsg
(PHP 3>= 3.0.4, PHP 4)
ifx_errormsg - возвращает сообщение об ошибке в последнем вызове Informix.
Описание
string ifx_errormsg ([int errorcode])
Возвращает сообщение об ошибке Informix для самой последней ошибки Informix или, если имеется необязательный параметр "errorcode", сообщение об ошибке, соответствующее "errorcode".
См. также ifx_error().
ifx_fetch_row
(PHP 3>= 3.0.3, PHP 4)
ifx_fetch_row - получает ряд как перечислимый массив.
Описание
array ifx_fetch_row (int result_id [, mixed position])
Возвращает ассоциативный массив, соответствующий извлечённому ряду, или FALSE, если рядов больше нет.
Blob-столбцы возвращаются как целочисленные blob id-значения для использования в ifx_get_blob(), если только вы не использовали ifx_textasvarchar(1) или ifx_byteasvarchar(1), - в этих случаях blob'ы возвращаются как строковые значения. Возвращает FALSE при ошибке.
result_id это правильный resultid, возвращённый функцией ifx_query() или ifx_prepare() (только запросы select!).
position это необязательный параметр для операций "извлечения" в "scroll"-курсорах: "NEXT", "PREVIOUS", "CURRENT", "FIRST", "LAST" или число. Если вы специфицировали число, выполняется извлечение "absolute". Этот параметр не обязателен и верен только для SCROLL-курсоров.
ifx_fetch_row() извлекает один ряд данных из результата, ассоциированного со специфицированным идентификатором результата. Ряд возвращается как массив. Каждый результирующий столбец сохраняется как смещение массива, начиная со смещения 0, с именем столбца в качестве ключа.
Последующие вызовы ifx_fetch_row() будут возвращать следующий ряд результирующего набора или FALSE, если рядов больше нет.
ifx_fieldproperties
(PHP 3>= 3.0.3, PHP 4)
ifx_fieldproperties - список свойств SQL-полей.
Описание
array ifx_fieldproperties (int result_id)
Возвращает ассоциативный массив с именами полей в качестве ключей и свойствами SQL-полей как данными для запроса с result_id. Возвращает FALSE при ошибке.
Возвращает Informix SQL-fieldproperties каждого поля запроса как ассоциативный массив. Свойства кодированы так: "SQLTYPE;length;precision;scale;ISNULLABLE", где SQLTYPE = Informix-тип вроде "SQLVCHAR" etc., а ISNULLABLE = "Y" или "N".
ifx_fieldtypes
(PHP 3>= 3.0.3, PHP 4)
ifx_fieldtypes - список Informix SQL-полей.
Описание
array ifx_fieldtypes (int result_id)
Возвращает ассоциативный массив с fieldnames (именами полей) в качестве ключей и с SQL fieldtypes в качестве данных для запроса с result_id. Возвращает FALSE при ошибке.
Пример 1. Fieldnames и SQL fieldtypes
$types = ifx_fieldtypes ($resultid);
if (! isset ($types)) {
... error ...
}
for ($i = 0; $i < count($types); $i++) {
$fname = key($types);
printf("%s :\t type = %s\n", $fname, $types[$fname]);
next($types);
}ifx_free_blob
(PHP 3>= 3.0.4, PHP 4)
ifx_free_blob - удаляет blob-объект.
Описание
int ifx_free_blob (int bid)
Удаляет blob-объект для данного blob object-id bid. Возвращает FALSE при ошибке, иначе TRUE.
