hw_Changeobject
hw_Changeobject -- Сменить объект
Описание int hw_changeobject(int connection, int object_to_change, string commands);
Команда позволяет удалить, добавить или модифицировать индивидуальные атрибуты объектной записи. Объекты указываются идентификатором оюъекта, object_to_change; команды придерживаются следующего синитаксиса:
<command> ::= <remcmd> |
<addcmd> |
<remcmd> "\" <addcmd>
<remcmd> ::= "rem " <attribute> "=" <value>
<addcmd> ::= "add " <attribute> "=" <value>
Заметим, что в запросе на удаление или перемещение атрибута, его старое значение также поддерживается (некоторые атрибуты могут иметь одновременно несколько значений). Команда, подобная rem attr=value\add attr=value позводяет модифицировать атрибуты за одну операцию.
Возвращает True при отсутствии ошибок, иначе False.
hw_Children
hw_Children -- ID наследников объекта
Описание array hw_children(int connection, int objectID);
Возвращает массив идентификаторов объектов. Каждый иденитификатор - часть коллекции с идентификатором objectID. Массив содержит всех наследников, документы и коллекции.
hw_ChildrenObj
hw_ChildrenObj -- объектные записи наследников.
Описание array hw_childrenobj(int connection, int objectID);
Возвращает массив объектных записей. Каждая запись - часть коллекции с идентификатором objectID. Массив содержит всех наследников, документы и коллекции.
hw_Close
hw_Close -- закрыть соединение Hyperwave
Описание int hw_close(int connection);
Возвращет false, если соединение не является действующим, в противном случае - true. Closes закрывает соединение с Hyperwave сервером с указанным номером соединения connection.
hw_Connect
hw_Connect -- открыть соединение.
Описание int hw_connect(string host, int port, string username, string password);
Открывает соединение с Hyperwave сервером и возвращает номер соединение при успешном открытиии, или False, ели слединение не может быть установлено. Каждый аргумент должен быть "закавыченой" строкой, исключая номер порта. Аргумент username и password опциональны и могут не указываться. В случае ошибки идентификации, сервер завершит работу. Проще использовать идентификацию как пользователь anonymous. Функция возращает индекс соединения, необходимы для других функций Hyperwave. Вы можете открыть несколько соединений. Помните, что пароли не шифруются.
Смотри также hw_pConnect().
hw_Cp
hw_Cp -- копировать оюъекты
Описание int hw_cp(int connection, array object_id_array, int destination id);
Копирует объекты с идентификаторами, указанными во втором параметре в коллекцию с идентификатором destination id.
Возвращается число скопированных объектов.
Смотри также hw_Mv().
hw_Deleteobject
hw_Deleteobject -- удалить объект
Описание int hw_deleteobject(int connection, int object_to_delete);
Удаляет объект с идентификатором, указанным во втором параметре. Будут удалены все экземпляры объекта.
При отсутствии ошибок возвращает true, инача - false.
Смотри также hw_Mv().
hw_DocByAnchor
hw_DocByAnchor -- ИД объекта, относящегося к якорю
Описание int hw_docbyanchor(int connection, int anchorID);
Возвращает идентификатор оъекта документа, который относится к якорю anchorID.
hw_DocByAnchorObj
hw_DocByAnchorObj -- объектная запись объекта, относящегося к якорю
Описание string hw_docbyanchorobj(int connection, int anchorID);
Возвращает объектную запись объекта документа, относящегося к якорю anchorID.
hw_DocumentAttributes
hw_DocumentAttributes -- объектная запись Hyperwave документа
Описание string hw_documentattributes(int hw_document);
Возвращает объектную запись документа.
Смотри также hw_DocumentBodyTag(), hw_DocumentSize().
hw_DocumentBodyTag
hw_DocumentBodyTag -- тег body hw-документа
Описание string hw_documentbodytag(int hw_document);
Возвращает тег BODY для документа. Если документ в формате HTML, тег BODY должен быть напечатен перед документом.
Смотри также hw_DocumentAttributes(), hw_DocumentSize().
hw_DocumentSize
hw_DocumentSize -- размер hw-документа
Описание int hw_documentsize(int hw_document);
Возвращает размер документа в байтах.
Смотри также hw_DocumentBodyTag(), hw_DocumentAttributes().
hw_ErrorMsg
hw_ErrorMsg -- возврат сообщения об ошибке
Описание string hw_errormsg(int connection);
Возвращает строку, содержащую последнее сообщени об ошибке или "No Error". Если возвратилось False, функция не выполнилась. Сообщение относится к последней команде.
hw_EditText
hw_EditText -- получение текстового документа
Описание int hw_edittext(int connection, int hw_document);
Загружет текстовый документ на сервер. Объектная запись документа не должна модифицироваться, пока документ редактируется. Эта функция работает только с чисто текстовыми документами. Она не отрывает специальных соединений для данных, поэтому управление соединением во время передачи данных блокируется.
Смотри также hw_PipeDocument (), hw_Free_Document(), hw_DocumentBodyTag(), hw_DocumentSize(), hw_OutputDocument(), hw_GetText().
hw_Error
hw_Error -- номер ошибки
Описание int hw_error(int connection);
Возвращет номер последней ошибки. Если 0 - ошибок не было. Ошибка относится к последней команде.
hw_Free_Document
hw_Free_Document -- освободить hw-документ
Описание int hw_free_document(int hw_document);
Oсвобождает память, занятую hw-документом.
hw_GetParents
hw_GetParents -- ИД родителей объекта
Описание array hw_getparentsobj(int connection, int objectID);
Возвращает индексированный массив идентификаторов объектов. Каждый ИД объекта относится к родителям объекта с идентификатором objectID.
hw_GetParentsObj
hw_GetParentsObj -- объектные записи родителей
Описание array hw_getparentsobj(int connection, int objectID);
Возвращает индексированный массив объектных записей плюс ассоциативный массив со статистической информацией об объектных записях. Ассоциативный массив - последний член возвращенного массива. Каждая объектная запись относится к родителю объекта с ИД objectID.
hw_GetChildColl
hw_GetChildColl -- ИД объекта коллекции наследников
Описание array hw_getchildcoll(int connection, int objectID);
Возвращает массив идентификаторов оюъектов. Каждый ИД объекта относится к наследной коллекции, коллекции с идентификатором objectID. Функция не возвращает наследуемые документы.
Смотри также hw_GetChildren(), hw_GetChildDocColl().
hw_GetChildCollObj
hw_GetChildCollObj -- объектные записи коллекции наследников
Описание array hw_getchildcollobj(int connection, int objectID);
Возвращает массив объектных записей. Каждая запись относится к наследной коллекции, коллекции с идентификатором objectID. Функция не возвращает наследуемые документы.
Смотри также hw_ChildrenObj(), hw_GetChildDocColl().
hw_GetSrcByDestObj
hw_GetSrcByDestObj -- возвращает якорные точки объекта
Описание array hw_getsrcbydestobj(int connection, int objectID);
Возвращает объектные записи всех якорных точек объекта с ИД objectID. Объект может быть как документом, так и якорем.
Смотри также hw_GetAnchors ().
hw_GetObject
hw_GetObject -- объектная запись
Описание array hw_getobject(int connection, int objectID);
Возвращает объектную запись объекта с идентификатором objectID.
Смотри также hw_GetAndLock().
hw_GetAndLock
hw_GetAndLock -- вернуть объектную запись и запереть объект
Описание string hw_getandlock(int connection, int objectID);
Возвращает объектную запись объекта с ИД objectID. Объект также запирается, поэтому другие позователи не имеют к нему доступа, пока объект не будет разблокирован.
Смотри также hw_Unlock (), hw_GetObject ().
hw_GetText
hw_GetText -- получить текстовый документ
Описание int hw_gettext(int connection, int objectID, int rootID);
Возвращается документ с идентификатором объекта objectID. Если документ имеет якоря, которые можно вставить, то они будут сразу вставлены. Опциональный параметр rootID определяет, как ссылки будут вставляться в документ. По умолчанию подставляется 0, что означает конструирование ссылок из имен объктов назначения ссылок. Это применимо для веб-приложений. Если ссылка указывает на объект с именем "internet_movie", ссылка HTML будет выглядеть как <A HREF="/internet_movie">. Настоящее положение исходного объекта и объекта назначения в иерархии документа полностью игнорируется. Вы будете вынуждены установить ваш браузер, переписать URL приблизительно так:
example "/my_script.php3/internet_movie". "my_script.php3" обработает $PATH_INFO и выдаст документ.
Если rootID не равен 0, ссылка конструируется из всех имен, начиная с объекта с ИД rootID, разделенных слешами от текущего объекта. Если для предидущего примера документ "internet_movie" расположен в "a-b-c-internet_movie", где "-" - разделители между уровнями иерархии, и исходный документ расположен по пути "a-b-d-source", результирующая HTML-ссылка будет: <A HREF="../c/internet_movie">. Это используется, если вы хотите утянуть се содержание сервера на диск и мапить иерархию докмента на файловую систему.
Эта функция работает только с чисто текстовыми документами. Она не отрывает специальных соединений для данных, поэтому управляющее соединение во время передачи данных блокируется.
Смотри также hw_PipeDocument(), hw_Free_Document(), hw_DocumentBodyTag(), hw_DocumentSize(), hw_OutputDocument().
hw_GetObjectByQuery
hw_GetObjectByQuery -- поиск объекта
Описание array hw_getobjectbyquery(int connection, string query, int max_hits);
Ищет объекты по всему серверу и возвращает массив идентификаторов объектов. Максимальное число найденных димитируется в max_hits. Если max_hits установлен в -1, то максимальное число ответов не ограниченно.
Смотри также hw_GetObjectByQueryObj().
hw_GetObjectByQueryObj
hw_GetObjectByQueryObj -- поиск объекта
Описание array hw_getobjectbyqueryobj(int connection, string query, int max_hits);
Ищет объекты по всему серверу и возвращает массив объектных записей. Максимальное число найденных димитируется в max_hits. Если max_hits установлен в -1, то максимальное число ответов не ограниченно.
Смотри также hw_GetObjectByQuery().
hw_GetObjectByQueryColl
hw_GetObjectByQueryColl -- поиск объекта в коллекции
Описание array hw_getobjectbyquerycoll(int connection, int objectID, string query, int max_hits);
Ищет объект в коллекции с идентификатором objectID и возвращает массив идентификаторов объектов. Максимальное число найденных димитируется в max_hits. Если max_hits установлен в -1, то максимальное число ответов не ограниченно.
Смотри также hw_GetObjectByQueryCollObj().
hw_GetObjectByQueryCollObj
hw_GetObjectByQueryCollObj -- search object in collection
Описание array hw_getobjectbyquerycollobj(int connection, int objectID, string query, int max_hits);
Ищет объект в коллекции с идентификатором objectID и возвращает массив объектных записей. Максимальное число найденных димитируется в max_hits. Если max_hits установлен в -1, то максимальное число ответов не ограниченно.
Смотри также hw_GetObjectByQueryColl().
hw_GetChildDocColl
hw_GetChildDocColl -- ИД объектов наследуемых документов коллекции
Описание array hw_getchilddoccoll(int connection, int objectID);
Возвращает массив идентификатров объектов наследуемых документов коллекции.
Смотри также hw_GetChildren(), hw_GetChildColl() .
hw_GetChildDocCollObj
hw_GetChildDocCollObj -- объектные записи наследуемых документов коллекции
Описание array hw_getchilddoccollobj(int connection, int objectID);
Возвращает массив идентификатров объектов наследуемых документов коллекции.
Смотри также hw_ChildrenObj (), hw_GetChildCollObj ().
hw_GetAnchors
Описание array hw_getanchors(int connection, int objectID);
Возвращает массив идентификаторов объектов для якорей документа с ИД objectID.
hw_GetAnchorsObj
hw_GetAnchorsObj -- объектные записи якорей документа
Описание array hw_getanchorsobj(int connection, int objectID);
Возвращает массив объектных записей для якорей документа с ИД objectID.
hw_Mv
hw_Mv -- переместить объект
Описание int hw_mv(int connection, array object id array, int source id, int destination id);
Перемещает объект с объектным идентификатром, указанным во втором параметре, из коллекции с идентификатором source id в коллекцию с идентификатором destination id. Если исходный ИД равен 0, объекты будут "отвязаны" от исходной коллекции. Если это последний экземпляр этого объекта, он будет удален.
Возвращется число перемещенных объектов.
Смотри также hw_Cp(), hw_Deleteobject().
hw_Identify
hw_Identify -- идентификация пользователя
Описание int hw_identify(string username, string password);
Идентификация пользователя с именем username и паролем password. Идентификация имеет силу только для текущей сессии. Я не думаю, что данная функция так уж часто используется. В большинстве случаев будет проще проводить идентификацию при установлении соединения.
Смотри также hw_Connect().
hw_InCollections
hw_InCollections -- есть ли такой объект в коллекции
Описание array hw_incollections(int connection, array object_id_array, array collection_id array, int return_collections);
Проверяет, является ли множество объектов (документов или коллекций), определенное в object_id_array, частью коллекций, определенных в коллекции id_array. Если четвертый параметр return_collections равен 0, подмножество идентификаторов объектов, которое является частью коллекций (т.е. документы или коллекции, которые являются наследниками одной или более коллекций идентификаторов коллекции или их подколлекций, рекурсивно) возвращается как массив. Когда четвертый праметр равен 1, однако, множество соллекций, которые имеют наследников в этом подмножестве, возвращается как массив. Это позволяет пользователю, например, подчеркнуть часть иерархии коллекции, которая содержит находки предыдущего запроса, в графическом виде.
hw_Info
hw_Info -- информация о соединении
Описание string hw_info(int connection);
Возвращает сведения о текущем соединении. Возвращаемая строка имеет следующий формат: <Serverstring>, <Host>, <Port>, <Username>, <Port of Client>, <Byte swapping>
hw_InsColl
hw_InsColl -- добавление коллекции
Описание int hw_inscoll(int connection, int objectID, array object_array);
Вставить новую коллекцию с атрибутами как в object_array в коллекцию с идентификатором objectID.
hw_InsDoc
hw_InsDoc -- добавление доукмента
Описание int hw_insdoc(int connection, int parentID, string object_record, string text);
Вставить новый документ с атрибутами как в object_array в коллекцию с идентификатором objectID. Эта функци может добавить как отдельную объектную запись, так и чистый ascii текст из text, если text получен. Если вы хотите добавить документ в общем, используйте hw_insertdocument().
Смотри также hw_InsertDocument(), hw_InsColl().
hw_InsertDocument
hw_InsertDocument -- добавление любого документа
Описание int hw_putdocument(int connection, int parent_id, int hw_document);
Загружает документ в коллекцию parent_id. Перед этим документ должен быть создан hw_NewDocument(). Удостоверьтесь, что объектная запись нового документа содержит следующие атрибуты: Type, DocumentType, Title и Name. Возможно, вы захотите также установить MimeType.
Смотри также hw_PipeDocument().
hw_New_Document
hw_New_Document -- создание нового документа
Описание int hw_new_document(string document_data, string object_record, int document_size);
Возвращает новый hw-документ с данными, установленными по document_data и объектной записью object_record. Длина данных документа document_data передается в document_size. Эта функция не добавляет документ в Hyperwave сервер.
Смотри также hw_Free_Document(), hw_DocumentSize(), hw_DocumentBodyTag(), hw_OutputDocument(), hw_InsertDocument().
hw_Objrec2Array
hw_Objrec2Array -- конвертировать атрибуты из объектной записи в объектный массив
Описание array hw_objrec2array(string object_record);
Преобразует object_record в объектный массив.
hw_OutputDocument
hw_OutputDocument -- печать hw-документа
Описание int hw_outputdocument(int hw_document);
Печатает документ без тега BODY.
hw_pConnect
hw_pConnect -- создание устойчивого соединения с базой данных
Описание int hw_pconnect(string host, int port, string username, string password);
Возвращает индекс соединения в случае удачи, или false, если соединение не может быть установлено. Открывает устойчивое соединение с Hyperwave сервером. Каждый аргумент должен быть "заавыченной" строкой, исключая номер порта. Аргументы username и password опциональны и могут быть опущены. В случае ошибки идентификации, сервер будет остановлен. Проще применять вход пользователя anonymous. В ыможете открыть множество устойчивых соединений.
Смотри также hw_Connect().
hw_PipeDocument
hw_PipeDocument -- полдучение любого документа
Описание int hw_pipedocument(int connection, int objectID);
Возвращает hw-документ с идентификатором objectID. Если документ имеет якоря, которые можно вставить, то данная операция произойдет автоматически. Документ передается через специальное соединение для данных, поэтому управляющее соединение не блокируется.
Смотри также hw_GetText() for more on link insertion, hw_Free_Document(), hw_DocumentSize(), hw_DocumentBodyTag(), hw_OutputDocument().
hw_Root
hw_Root -- идентификатор коренного объекта
Описание int hw_root();
Возвращает объектный идентификатор для гиперкоренной коллекции. Обычно это 0. Наследная коллекция от гиперкорневой - корневая, на сервере, с которым установлено соединение.
hw_Unlock
hw_Unlock -- разблокировать объект
Описание int hw_unlock(int connection, int objectID);
Разблокирует документ для доступа другим пользователям.
Смотри также hw_GetAndLock().
hw_Username
hw_Username -- имя текущего пользователя
Описание string hw_getusername(int connection);
Возвращает имя пользователя соединения.
1 2
8 8 8
| 
*
Обратная связь