gzclose

(PHP 3, PHP 4)

gzclose - закрывает открытый gz-файловый указатель.

Описание

int gzclose (int zp)

gz-файл, на который указывает zp, закрывается.

Возвращает TRUE при успехе и FALSE при неудаче.

Указатель gz-файла обязан быть правильным и обязан указывать на файл, успешно открытый функцией gzopen().

gzcompress

(PHP 4 >= 4.0.1)

gzcompress - сжимает строку.

Описание

string gzcompress (string data [, int level])

Эта функция возвращает сжатую версию входных данных data, используя формат данных ZLIB, или FALSE, если обнаружена ошибка. Необязательный параметр level может быть задан от 0 - нет сжатия, до 9 - максимальное сжатие.

Об алгоритме ZLIB-компрессии см. документ "ZLIB Compressed Data Format Specification version 3.3" (RFC 1950).

Примечание: это не то же самое, что gzip-компрессия, которая включает некоторые header-данные. См. в gzencode() о gzip-компрессии.

См. также gzdeflate(), gzinflate(), gzuncompress(), gzencode().

gzdeflate

(PHP 4 >= 4.0.4)

gzdeflate - закачивает строку.

Описание

string gzdeflate (string data [, int level])

Эта функция возвращает сжатую версию входных данных data , используя формат данных DEFLATE, или FALSE, если обнаружена ошибка. Необязательный параметр level может быть задан от 0 - нет сжатия, до 9 - максимальное сжатие.

Об алгоритме компрессии DEFLATE см. документ "DEFLATE Compressed Data Format Specification version 1.3" (RFC 1951).

См. также gzinflate(), gzcompress(), gzuncompress(), gzencode().

gzencode

(PHP 4 >= 4.0.4)

gzencode - создаёт gzip-сжатую строку.

Описание

string gzencode (string data [, int level [, int encoding_mode]])

Эта функция возвращает сжатую версию входных данных data, совместимую с выводом программы gzip, или FALSE, если обнаружена ошибка. Необязательный параметр level может быть задан от 0 - нет сжатия, до 9 - максимальное сжатие, если уровень сжатия по умолчанию не задан zlib-библиотекой.

Вы можете также задать FORCE_GZIP (по умолчанию) или FORCE_DEFLATE в качестве необязательного третьего параметра encoding_mode. Если вы используете FORCE_DEFLATE, вы получите стандартную zlib-сжатую строку (включая zlib headers) после шапки gzip-файла, но без ведомой crc32 checksum.

Примечание: level был введён в PHP 4.2; до PHP 4.2 gzencode() имела только параметры data и (необязательный) encoding_mode.

Результирующие данные содержат соответствующие шапки/headers и структуру данных для создания стандартного .gz-файла, например:

gzeof

(PHP 3, PHP 4)

gzeof - проверяет end-of-file для указателя gz-файла.

Описание

int gzeof (int zp)

Возвращает TRUE, если указатель gz-файла находится в точке EOF или возникла ошибка; иначе возвращает FALSE.

Указатель gz-файла обязан быть правильным и указывать на файл, успешно открытый функцией gzopen().

gzfile

(PHP 3, PHP 4)

gzfile - читает весь gz-файл в массив.

Описание

array gzfile (string filename [, int use_include_path])

Идентична readgzfile(), но gzfile() возвращает файл в виде массива.

Вы можете использовать необязательный второй параметр и установить его "1", если хотите найти также файл в include_path.

См. также readgzfile() и gzopen().

gzgetc

(PHP 3, PHP 4)

gzgetc - получает символ от указателя gz-файла.

Описание

string gzgetc (int zp)

Возвращает строку, содержащую одиночный (несжатый) символ, прочитанный из файла, на который указывает zp. Возвращает FALSE, если EOF (как делает gzeof()).

Указатель gz-файла обязан быть правильным и указывать на файл, успешно открытый функцией gzopen().

См. также gzopen() и gzgets().

gzgets

(PHP 3, PHP 4)

gzgets - получает строку от указателя файла.

Описание

string gzgets (int zp, int length)

Возвращает (несжатую) строку размером length - 1 байт, прочитанных из файла, на который указывает fp. Чтение заканчивается, когда прочитаны length - 1 байт, на символе новой строки/newline или на EOF (что будет найдено первым).

Если возникает ошибка, возвращает FALSE.

Указатель файла обязан быть верным и указывать на файл, успешно открытый функцией gzopen().

См. также gzopen(), gzgetc() и fgets().

gzgetss

(PHP 3, PHP 4)

gzgetss - получает строку от указателя gz-файла и вырезает тэги HTML.

Описание

string gzgetss (int zp, int length [, string allowable_tags])

Идентична gzgets(), но gzgetss() пытается вырезать все тэги HTML и PHP из читаемого ей текста.

Вы можете использовать необязательный третий параметр для специфицирования тэгов, которые не должны вырезаться.

Примечание: Allowable_tags был введён в PHP 3.0.13, PHP4B3.

См. также gzgets(), gzopen() и strip_tags().

gzinflate

(PHP 4 >= 4.0.4)

gzinflate - распаковывает сжатую строку.

Описание

string gzinflate (string data [, int length])

Эта функция принимает данные data, сжатые функцией gzdeflate(), и возвращает оригинальные несжатые данные или FALSE - при ошибке. Эта функция возвратит ошибку, если несжатые данные более чем в 256 раз больше размера сжатых входных data или больше, чем необязательный параметр length.

См. также gzcompress(), gzuncompress(), gzdeflate(), gzencode().

gzopen

(PHP 3, PHP 4)

gzopen - открывает gz-файл.

Описание

int gzopen (string filename, string mode [, int use_include_path])

Открывает gzip-файл (.gz) для чтения или записи. Параметр mode такой же, как для fopen() ("rb" или "wb"), но может также содержать уровень сжатия ("wb9") или стратегию/strategy: 'f' для фильтрации данных, как, например, "wb6f", 'h' только для Huffman-компрессии, как в "wb1h". (См. в описании deflateInit2 в файле zlib.h о параметре strategy.)

gzopen() можно использовать для чтения файла, который имеет не gzip-формат; в этом случае gzread() будет непосредственно читать из файла без декомпрессии.

gzopen() возвращает указатель файла на открытый файл, после чего всё, что вы читаете из этого дескриптора файла, будет прозрачно распаковываться, а всё, что вы записываете - упаковываться.

Если открытие не удалось, функция возвращает FALSE.

Вы можете использовать необязательный третий параметр и установить его "1", если хотите искать файл также в include_path.

Пример 1. gzopen()

$fp = gzopen ("/tmp/file.gz", "r");

См. также gzclose().

gzpassthru

(PHP 3, PHP 4)

gzpassthru - выводит все оставшиеся данные из указателя gz-файла.

Описание

int gzpassthru (int zp)

Читает до EOF данным указателем gz-файла и записывает (несжатый) результат в стандартный вывод.

Если возникла ошибка, возвращает FALSE.

Указатель файла обязан быть правильным и указывать на файл, успешно открытый функцией gzopen().

gz-файл закрывается, когда gzpassthru() закончила его чтение (оставляя zp без использования).

gzputs

(PHP 3, PHP 4)

gzputs - записывает в указатель gz-файла.

Описание

int gzputs (int zp, string str [, int length])

gzputs() это псевдоним gzwrite(), идентичный во всём.

gzread

(PHP 3, PHP 4)

gzread - Binary-safe чтение gz-файла.

Описание

string gzread (int zp, int length)

gzread() читает до length байт из указателя gz-файла, на который ссылается zp. Чтение останавливается, когда length (несжатых) байт прочитаны, или достигнут EOF, смотря что будет вперёд.

gzrewind

(PHP 3, PHP 4)

gzrewind - возвращает в начало указатель gz-файла.

Описание

int gzrewind (int zp)

Устанавливает индикатор позиции файла для zp на начало потока этого файла.

Если возникла ошибка, возвращает 0.

Указатель файла обязан быть правильным и указывать на файл, успешно открытый функцией gzopen().

См. также gzseek() и gztell().

gzseek

(PHP 3, PHP 4)

gzseek - ищет в указателе gz-файла.

Описание

int gzseek (int zp, int offset)

Устанавливает индикатор позиции файла, на который ссылается zp, на смещение в байтах потока этого файла. Эквивалентно вызову (в C) gzseek( zp, offset, SEEK_SET ).

Если файл открыт для чтения, эта функция эмулируется, но будет работать очень медленно. Если файл открыт для записи, разрешён только поиск вперёд; gzseek затем сжимает последовательность нулей до новой стартовой позиции.

При успехе возвращает 0; иначе возвращает -1. Обратите внимание, что поиск после EOF не считается ошибкой.

См. также gztell() и gzrewind().

gztell

(PHP 3, PHP 4)

gztell - сообщает указателю gz-файла позицию для чтения/записи.

Описание

int gztell (int zp)

Возвращает позицию указателя файла, на который ссылается zp; т.е. смещение в потоке данного файла.

Если возникла ошибка, возвращает FALSE.

Указатель файла обязан быть правильным и указывать на файл, успешно открытый функцией gzopen().

См. также gzopen(), gzseek() и gzrewind().

gzuncompress

(PHP 4 >= 4.0.1)

gzuncompress - распаковывает сжатую строку.

Описание

string gzuncompress (string data [, int length])

Эта функция принимает данные data, сжатые функцией gzcompress(), и возвращает оригинальные несжатые данные или FALSE - при ошибке. Эта функция возвратит ошибку, если несжатые данные более чем в 256 раз больше сжатых входных данных data или больше необязательного параметра length.

См. также gzdeflate(), gzinflate(), gzcompress(), gzencode().

gzwrite

(PHP 3, PHP 4)

gzwrite - Binary-safe запись в gz-файл.

Описание

int gzwrite (int zp, string string [, int length])

gzwrite() записывает содержимое string в поток gz-файла, на который указывает zp. Если аргумент length задан, запись останавливается, после того как length (несжатых) байт будут записаны или конец string будет достигнут, смотря что вперёд.

Заметьте, что, если аргумент length задан, опция конфигурации magic_quotes_runtime будет игнорироваться, и слэши не будут вырезаться из string.

См. также gzread(), gzopen() и gzputs().

header

(PHP 3, PHP 4)

header - отправляет "сырую" HTTP-шапку/header.

Описание

int header (string string [, bool replace])

header() используется для отправки необработанных HTTP-шапок. См. в спецификации HTTP/1.1 информацию о HTTP headers.

Необязательный параметр replace указывает, должна ли шапка замещать предыдущую аналогичную шапку, или нужно добавить вторую header того же самого типа. По умолчанию выполняется замещение, но, если вы передаёте FALSE в качестве второго аргумента, вы можете форсировать создание нескольких headers одного типа. Например:

headers_sent

(PHP 3>= 3.0.8, PHP 4)

headers_sent - возвращает TRUE, если шапки/headers отправлены.

Описание

bool headers_sent (void)

Эта функция возвращает TRUE, если HTTP headers уже отправлены, FALSE в ином случае.

См. также header().

hebrev

(PHP 3, PHP 4)

hebrev - конвертирует логический Hebrew-текст в визуальный текст.

Описание

string hebrev (string hebrew_text [, int max_chars_per_line])

Необязательный параметр max_chars_per_line указывает максимальное количество символов на строчку при выводе. Функция пытается исключить разрывы слов.

См. также hebrevc().

hebrevc

(PHP 3, PHP 4)

hebrevc - конвертирует логический Hebrew-текст в визуальный текст с конвертацией символов newline.

Описание

string hebrevc (string hebrew_text [, int max_chars_per_line])

Эта функция похожа на hebrev(), с тем только отличием, что она конвертирует символы новой строки (\n) в "<br>\n". Необязательный параметр max_chars_per_line указывает максимальное количество символов на строчку при выводе. Функция пытается исключить разрывы слов.

См. также hebrev()

hexdec

(PHP 3, PHP 4)

hexdec - 16-ричное в 10-ричное.

Описание

int hexdec (string hex_string)

Возвращает десятеричный эквивалент 16-ричного числа, заданного аргументом hex_string. hexdec() конвертирует 16-ричную строку в 10-ричное число. Наибольшее конвертируемое число это 7fffffff, или 2147483647 в 10-ричном выражении.

hexdec() замещает все не-16-ричные символы нулями. Таким образом, все нули игнорируются, но нули справа являются значащими.

highlight_file

(PHP 4)

highlight_file - выделение синтаксиса файла.

Описание

mixed highlight_file (string filename [, bool return])

Функция highlight_file() печатает версию с синтаксиса, с выделениями кода, содержащегося в filename, с использованием цветов, определённых встроенной подсветкой синтаксиса PHP.

Если второй параметр return имеет значение TRUE, то highlight_file() возвратит код с выделениями как строку, а не будет печатать его. Если второй параметр не имеет значение TRUE, то highlight_file() возвратит TRUE при успехе, FALSE при неудаче.

Примечание: параметр return стал доступен, начиная с PHP 4.2.0. До этого он имел поведение по умолчанию - FALSE.

Примечание: необходимо внимание при использовании функций show_source() и highlight_file(), чтобы гарантировать, что вы случайно не выдали закрытую информацию, такую как пароли, или информацию другого типа, которая может создать потенциальный риск нарушения защиты.

Примечание: начиная с PHP 4.2.1, на эту функцию действуют также режим safe_mode и open_basedir.

highlight_string

(PHP 4)

highlight_string - выделение синтаксиса строки.

Описание

mixed highlight_string (string str [, bool return])

Функция highlight_string() выводит версию с расцвеченным синтаксисом строки str, используя цвета, определённые во встроенном выделении синтаксиса PHP.

Если второй параметр return имеет значение TRUE, то highlight_string() возвратит версию раскрашенного кода как строку, вместо её печати. Если второй параметр не имеет значение TRUE, highlight_string() возвратит TRUE при успехе, FALSE при неудаче.

Примечание: параметр return стал доступен, начиная с PHP 4.2.0. До этого он работал, как по умолчанию, т.е. FALSE.

См. также highlight_file() и show_source().

htmlentities

(PHP 3, PHP 4)

htmlentities - конвертирует символы в мнемоники HTML.

Описание

string htmlentities (string string [, int quote_style [, string charset]])

Эта функция идентична htmlspecialchars(), но все символы, имеющие эквиваленты - мнемоники HTML, транслируются в эти мнемоники. Как и htmlspecialchars(), она принимает необязательный второй аргумент, указывающий, что должно выполняться с одинарными и двойными кавычками. ENT_COMPAT (по умолчанию) будет конвертировать только двойные кавычки и оставит одинарные без изменения. ENT_QUOTES будет конвертировать как двойные, так и одинарные кавычки, а ENT_NOQUOTES оставит и двойные, и одинарные кавычки без конвертации.

В настоящее время по умолчанию используется набор символов ISO-8859-1. Поддержка второго аргумента была введена в PHP 3.0.17 и в PHP 4.0.3.

Как и htmlspecialchars(), она принимает необязательный третий аргумент, который определяет набор символов, используемый при конвертации. Поддержка этого аргумента была введена в PHP 4.1.0.

Обратная функция отсутствует, но вы можете создать её сами. Вот пример того, как это сделать.

htmlspecialchars

(PHP 3, PHP 4)

htmlspecialchars - конвертирует специальные символы в мнемоники HTML.

Описание

string htmlspecialchars (string string [, int quote_style [, string charset]])

Некоторые символы имеют в HTML специальное значение и должны быть представлены мнемониками HTML для сохранения своего значения. Эта функция возвращает строку с выполненной конвертацией; трансляция выполняется как всегда в современном web-программировании. Если вам нужны все оттранслированные HTML-мнемоники символов, используйте htmlentities().

Эта функция используется для предотвращения ввода вместе с пользовательским текстом разметки HTML, как в досках объявлений или в приложении guest book. Необязательный второй аргумент, quote_style, сообщает функции, что делать с символами одинарных и двойных кавычек. Режим по умолчанию, ENT_COMPAT, обратно совместим только для трансляции двойных кавычек и оставляет одинарные кавычки неоттранслированными. Если установлен ENT_QUOTES, и двойные, и одинарные кавычки транслируются, а если установлен ENT_NOQUOTES - ни одинарные. ни двойные кавычки не транслируются.

Выполняются трансляции:

'&' (амперсанд) становится '&amp;'

'"' (double quote) становится '&quot;' когда ENT_NOQUOTES не установлен

''' (single quote) становится '&#039;', только когда установлен ENT_QUOTES.

'<' (less than) становится '&lt;'

'>' (greater than) становится '&gt;'

hw_Array2Objrec

(PHP 3>= 3.0.4, PHP 4)

hw_Array2Objrec - конвертирует атрибуты из массива объекта в запись объекта.

Описание

strin hw_array2objrec (array object_array)

Конвертирует object_array в запись объекта. Несколько атрибутов вроде 'Title' на разных языках рассматриваются соответствующим образом.

См. также hw_objrec2array().

hw_changeobject

(PHP 3>= 3.0.3, PHP 4)

hw_changeobject - изменяет атрибуты объекта (устарела).

Описание

void hw_changeobject (int link, int objid, array attributes)

Предупреждение!Эта функция в настоящее время ещё не задокументирована; имеется только список аргументов.

hw_Children

(PHP 3>= 3.0.3, PHP 4)

hw_Children - id'ы объектов потомков.

Описание

array hw_children (int connection, int objectID)

Возвращает массив id'ов потомков. Каждый id принадлежит потомку коллекции с ID objectID. Массив содержит всех потомков документов и коллекций.

hw_ChildrenObj

(PHP 3>= 3.0.3, PHP 4)

hw_ChildrenObj - записи объектов потомков.

Описание

array hw_childrenobj (int connection, int objectID)

Возвращает массив записей объектов. Каждая запись объекта принадлежит потомку коллекции с ID objectID. Массив содержит всех потомков документов и коллекций.

hw_Close

(PHP 3>= 3.0.3, PHP 4)

hw_Close - закрывает Hyperwave-соединение.

Описание

int hw_close (int connection)

Возвращает FALSE, если соединение не является правильным индексом соединения, иначе TRUE. Закрывает соединение Hyperwave-сервера с данным индексом соединения.

hw_Connect

(PHP 3>= 3.0.3, PHP 4)

hw_Connect - открывает соединение.

Описание

int hw_connect (string host, int port, string username, string password)

Открывает соединение с Hyperwave-сервером и возвращает индекс соединения, при успехе, либо FALSE, если соединение не может быть установлено. Каждый аргумент должен быть закавыченной строкой, за исключением номера порта. Аргументы username и password являются необязательными и могут быть опущены. В этом случае никакая идентификация с сервером не выполняется. Это напоминает идентификацию как пользователь anonymous. Эта функция возвращает индекс соединения, который необходим другим Hyperwave-функциям. Вы можете иметь одновременно открытыми несколько соединений. Помните, что пароль не шифруется.

См. также hw_pconnect().

hw_connection_info

(PHP 3>= 3.0.3, PHP 4)

hw_connection_info - печатает информацию о соединении с Hyperwave-сервером.

Описание

void hw_connection_info (int link)

Предупреждение!Эта функция в настоящее время ещё не задокументирована; имеется только список аргументов.

hw_Cp

(PHP 3>= 3.0.3, PHP 4)

hw_Cp - копирует объекты.

Описание

int hw_cp (int connection, array object_id_array, int destination id)

Копирует объекты с ids объектов, специфицированными во втором параметре, в коллекцию с id destination id.

return-значение это количество скопированных объектов.

См. также hw_mv().

hw_Deleteobject

(PHP 3>= 3.0.3, PHP 4)

hw_Deleteobject - удаляет объект.

Описание

int hw_deleteobject (int connection, int object_to_delete)

Удаляет объект с данным id объекта, указанным во втором параметре. Удаляет все экземпляры данного объекта.

Возвращает TRUE, если нет ошибок, иначе FALSE.

См. также hw_mv().

hw_DocByAnchor

(PHP 3>= 3.0.3, PHP 4)

hw_DocByAnchor - id объекта, принадлежащего якорю/anchor.

Описание

int hw_docbyanchor (int connection, int anchorID)

Возвращает object id документа, к которому принадлежит anchorID.

hw_DocByAnchorObj

(PHP 3>= 3.0.3, PHP 4)

hw_DocByAnchorObj - объект записи объекта, принадлежащего якорю.

Описание

string hw_docbyanchorobj (int connection, int anchorID)

Возвращает запись объекта документа, к которому принадлежит anchorID.

hw_Document_Attributes

(PHP 3>= 3.0.3, PHP 4)

hw_Document_Attributes - запись объекта из hw_document.

Описание

string hw_document_attributes (int hw_document)

Возвращает запись объекта документа.

Для обеспечения совместимости принимается также hw_documentattributes(). Но это не рекомендуется.

См. также hw_document_bodytag() и hw_document_size().

hw_Document_BodyTag

(PHP 3>= 3.0.3, PHP 4)

hw_Document_BodyTag - тэг BODY из hw_document.

Описание

string hw_document_bodytag (int hw_document)

Возвращает тэг BODY документа. Если документ это HTML-документ, тэг BODY должен быть напечатан до документа.

См. также hw_document_attributes() и hw_document_size().

Для обеспечения совместимости принимается также hw_documentbodytag(). Но это не рекомендуется.

hw_Document_Content

(PHP 3>= 3.0.3, PHP 4)

hw_Document_Content - возвращает содержимое hw_document.

Описание

string hw_document_content (int hw_document)

Возвращает содержимое документа. Если это HTML-документ, содержимым будет всё после тэга BODY. Информация из HEAD и тэга BODY хранится в записи объекта.

См. также hw_document_attributes(), hw_document_size() и hw_document_setcontent().

hw_Document_SetContent

(PHP 4)

hw_Document_SetContent - устанавливает/замещает содержимое hw_document.

Описание

string hw_document_setcontent (int hw_document, string content)

Устанавливает или замещает содержимое документа. Если это HTML-документ, содержимым будет всё после тэга BODY. Информация из HEAD и тэга BODY tag хранится в записи объекта. Если вы также предоставляете эту информацию в содержимом документа, Hyperwave-сервер изменит запись объекта соответствующим образом при вставке объекта. Возможно, не самый лучший вариант. Если функция терпит неудачу, документ остаётся со старым содержимым.

См. также hw_document_attributes(), hw_document_size() и hw_document_content().

hw_Document_Size

(PHP 3>= 3.0.3, PHP 4)

hw_Document_Size - размер hw_document.

Описание

int hw_document_size (int hw_document)

Возвращает размер документа в байтах.

См. также hw_document_bodytag() и hw_document_attributes().

Для обратной совместимости принимается также hw_documentsize(). Но это не рекомендуется.

hw_dummy

(PHP 3>= 3.0.3, PHP 4)

hw_dummy - Hyperwave функция-заглушка.

Описание

string hw_dummy (int link, int id, int msgid)

Предупреждение!Эта функция в настоящее время ещё не задокументирована; имеется только список аргументов.

hw_EditText

(PHP 3>= 3.0.3, PHP 4)

hw_EditText - запрашивает текстовый документ.

Описание

int hw_edittext (int connection, int hw_document)

Загружает текстовый документ на сервер. Запись объекта этого документа не может модифицироваться, пока документ редактируется. Эта функция работает только с чисто текстовыми документами. Она не открывает специальное соединение с данными и, следовательно, блокирует управление соединением в процессе трансфера.

См. также hw_pipedocument(), hw_free_document(), hw_document_bodytag(), hw_document_size(), hw_output_document(), hw_gettext().

hw_Error

(PHP 3>= 3.0.3, PHP 4)

hw_Error - номер ошибки.

Описание

int hw_error (int connection)

Возвращает номер последней ошибки. Если return-значение равно 0, ошибки не было. Ошибка касается последней команды.

hw_ErrorMsg

(PHP 3>= 3.0.3, PHP 4)

hw_ErrorMsg - возвращает сообщение об ошибке.

Описание

string hw_errormsg (int connection)

Возвращает строку, содержащую сообщение о последней ошибке или 'No Error'. Если возвращено FALSE, данная функция не была выполнена. Сообщение относится к последней команде.

hw_Free_Document

(PHP 3>= 3.0.3, PHP 4)

hw_Free_Document - освобождает hw_document.

Описание

int hw_free_document (int hw_document)

Освобождает память, занимаемую Hyperwave-документом.

hw_GetAnchors

(PHP 3>= 3.0.3, PHP 4)

hw_GetAnchors - object ids якорей документа.

Описание

array hw_getanchors (int connection, int objectID)

Возвращает массив из object ids с якорями документа с object ID objectID.

hw_GetAnchorsObj

(PHP 3>= 3.0.3, PHP 4)

hw_GetAnchorsObj - записи объектов якорей документа.

Описание

array hw_getanchorsobj (int connection, int objectID)

Возвращает массив записей объектов с якорями документа с object ID objectID.

hw_GetAndLock

(PHP 3>= 3.0.3, PHP 4)

hw_GetAndLock - возвращает запись объекта и блокирует объект.

Описание

string hw_getandlock (int connection, int objectID)

Возвращает запись объекта для объекта с ID objectID. Также блокирует объект, и другие пользователи не могут получить к нему доступ, пока он не будет разблокирован.

См. также hw_unlock() и hw_getobject().

hw_GetChildColl

(PHP 3>= 3.0.3, PHP 4)

hw_GetChildColl - object ids дочерних коллекций.

Описание

array hw_getchildcoll (int connection, int objectID)

Возвращает массив из object ids. Каждый object ID принадлежит коллекции, дочерней относительно коллекции с ID objectID. Функция не возвращает дочерних документов.

См. также hw_children() и hw_getchilddoccoll().

hw_GetChildCollObj

(PHP 3>= 3.0.3, PHP 4)

hw_GetChildCollObj - записи объектов дочерних коллекций.

Описание

array hw_getchildcollobj (int connection, int objectID)

Возвращает массив записей объектов. Каждая запись объекта принадлежит коллекции, дочерней относительно коллекции с ID objectID. Функция не возвращает дочерних документов.

См. также hw_childrenobj() и hw_getchilddoccollobj().

hw_GetChildDocColl

(PHP 3>= 3.0.3, PHP 4)

hw_GetChildDocColl - object ids дочерних документов коллекции.

Описание

array hw_getchilddoccoll (int connection, int objectID)

Возвращает массив из object ids дочерних документов коллекции.

См. также hw_children() и hw_getchildcoll().

hw_GetChildDocCollObj

(PHP 3>= 3.0.3, PHP 4)

hw_GetChildDocCollObj - записи объектов дочерних документов коллекции.

Описание

array hw_getchilddoccollobj (int connection, int objectID)

Возвращает массив записей объектов дочерних документов коллекции.

См. также hw_childrenobj() и hw_getchildcollobj().

hw_GetObject

(PHP 3>= 3.0.3, PHP 4)

hw_GetObject - запись объекта/object record.

Описание

array hw_getobject (int connection, [int|array] objectID, string query)

Возвращает запись объекта для объекта с ID objectID, если второй параметр является целым числом/integer. Если второй параметр является массивом целых чисел, функция возвращает массив записей объекта. В этом случае вычисляется также и последний параметр, который является строкой запроса/query string.

Строка запроса имеет следующий синтаксис:

<expr> ::= "(" <expr> ")" |

"!" <expr> | /* NOT */

<expr> "||" <expr> | /* OR */

<expr> "&&" <expr> | /* AND */

<attribute> <operator> <value>

<attribute> ::= /* имя любого атрибута (Title, Author, DocumentType ...) */

<operator> ::= "=" | /* равно */

"<" | /* меньше (сравнение строк) */

">" | /* больше (сравнение строк) */

"~" /* подстановка регулярного выражения */

Запрос позволяет производит последующую выборку определённых объектов из списка данных объектов. В отличие от других функций запроса, этот запрос может использовать неиндексированные атрибуты. То, сколько возвращается записей объекта, зависит от запроса и от того, разрешён ли доступ к объекту.

См. также hw_getandlock() и hw_getobjectbyquery().

hw_GetObjectByQuery

(PHP 3>= 3.0.3, PHP 4)

hw_GetObjectByQuery - ищет объект.

Описание

array hw_getobjectbyquery (int connection, string query, int max_hits)

Ищет объекты по всему серверу и возвращает массив из object ids. Максимальное количество совпадений ограничено параметром max_hits. Если max_hits имеет значение -1, ограничения нет.

Этот запрос будет работать только с индексированными атрибутами.

См. также hw_getobjectbyqueryobj().

hw_GetObjectByQueryColl

(PHP 3>= 3.0.3, PHP 4)

hw_GetObjectByQueryColl - ищет объект в коллекции.

Описание

array hw_getobjectbyquerycoll (int connection, int objectID, string query, int max_hits)

Ищет объекты в коллекции с ID objectID и возвращает массив из object ids. Максимальное количество совпадений ограничено параметром max_hits. Если max_hits имеет значение -1, ограничения нет.

Этот запрос будет работать только с индексированными атрибутами.

См. также hw_getobjectbyquerycollobj().

hw_GetObjectByQueryCollObj

(PHP 3>= 3.0.3, PHP 4)

hw_GetObjectByQueryCollObj - ищет объект в коллекции.

Описание

array hw_getobjectbyquerycollobj (int connection, int objectID, string query, int max_hits)

Ищет объекты в коллекции с ID objectID и возвращает массив из записей объектов. Максимальное количество совпадений ограничено параметром max_hits. Если max_hits имеет значение -1, ограничения нет.

Этот запрос будет работать только с индексированными атрибутами.

См. также hw_getobjectbyquerycoll().

hw_GetObjectByQueryObj

(PHP 3>= 3.0.3, PHP 4)

hw_GetObjectByQueryObj - ищет объекты.

Описание

array hw_getobjectbyqueryobj (int connection, string query, int max_hits)

Ищет объекты по всему серверу и возвращает массив из записей объектов. Максимальное количество совпадений ограничено параметром max_hits. Если max_hits имеет значение -1, ограничения нет.

Этот запрос будет работать только с индексированными атрибутами.

См. также hw_getobjectbyquery().

hw_GetParents

(PHP 3>= 3.0.3, PHP 4)

hw_GetParents - object ids предков.

Описание

array hw_getparents (int connection, int objectID)

Возвращает индексированный массив из object ids. Каждый object id принадлежит родителю объекта с ID objectID.

hw_GetParentsObj

(PHP 3>= 3.0.3, PHP 4)

hw_GetParentsObj - записи объектов родителей.

Описание

array hw_getparentsobj (int connection, int objectID)

Возвращает индексированный массив записей объектов плюс ассоциативный массив со статистической информацией об этих записях объектов. Этот ассоциативный массив является последним элементом возвращаемого массива. Каждая запись объекта принадлежит родителю объекта с ID objectID.

hw_getrellink

(PHP 3>= 3.0.3, PHP 4)

hw_getrellink - получает ссылку от источника на цель относительно rootid.

Описание

string hw_getrellink (int link, int rootid, int sourceid, int destid)

Предупреждение!Эта функция в настоящее время ещё не задокументирована; имеется только список аргументов.

hw_GetRemote

(PHP 3>= 3.0.3, PHP 4)

hw_GetRemote - получает удалённый/remote документ.

Описание

int hw_getremote (int connection, int objectID)

Возвращает удалённый/remote документ. Удалёнными документами, в терминологии Hyperwave, являются документы, запрошенные из внешнего источника. Таковыми обычно являются, к примеру, внешние web-страницы или запросы в БД. Чтобы иметь доступ ко внешним источникам через удалённые документы, Hyperwave вводит HGI (Hyperwave Gateway Interface/Шлюзовый Интерфейс), напоминающий CGI. В настоящее время с помощью HGI можно получать доступ только к ftp, http-серверам и некоторым БД. Вызов hw_getremote() возвращает документ из внешнего источника. Если вы хотите использовать эту функцию, необходимо хорошо ознакомиться с HGI. Вы должны также предусмотреть использование PHP вместо Hyperwave для доступа ко внешним источникам. Добавление поддержки БД через Hyperwave может оказаться более трудоёмким, чем через PHP.

См. также hw_getremotechildren().

hw_GetRemoteChildren

(PHP 3>= 3.0.3, PHP 4)

hw_GetRemoteChildren - получает потомков удалённого/remote документа.

Описание

int hw_getremotechildren (int connection, string object record)

Возвращает потомков удалённого/remote документа. Потомки удалённого документа сами являются удалёнными документами. Это имеет смысл, если запрос БД должен быть уточнён, как разъясняется в учебнике Hyperwave Programmers' Guide. Если количество потомков равно 1, эта функция возвратит сам документ, отформатированный с помощью Hyperwave Gateway Interface (HGI). Если количество потомков больше 1, возвращается массив записей объектов, каждая из которых может быть input-значением другого вызова hw_getremotechildren(). Эти записи объектов являются виртуальными и не существуют на Hyperwave-сервере, поэтому они не имеют правильного object ID. Как будет в точности выглядеть эта запись объекта, зависит от HGI. Если вы хотите использовать эту функцию, вы должны быть хорошо знакомы с HGI. Вы должны также предусмотреть использование PHP вместо Hyperwave для доступа ко внешним источникам. Добавление поддержки БД через шлюз Hyperwave может оказаться более трудоёмким, чем через PHP.

См. также hw_getremote().

hw_GetSrcByDestObj

(PHP 3>= 3.0.3, PHP 4)

hw_GetSrcByDestObj - возвращает якоря, указывающие на объект.

Описание

array hw_getsrcbydestobj (int connection, int objectID)

Возвращает записи объектов всех якорей, указывающих на объект с ID objectID. Объект может быть либо документом, либо якорем типа назначения/destination.

См. также hw_getanchors().

hw_GetText

(PHP 3>= 3.0.3, PHP 4)

hw_GetText - запрашивает текстовый документ.

Описание

int hw_gettext (int connection, int objectID [, mixed rootID/prefix])

Возвращает возвращает документ с object ID objectID. Если этот документ имеет якоря, которые могут быть вставлены, они будут вставлены. Необязательный параметр rootID/prefix может быть строкой или целым числом. Целое число определяет, как ссылки вставляются в документ. По умолчанию 0, т.е. ссылки конструируются из имени объекта назначения ссылки. Это используется для web-приложений. Если ссылка указывает на объект с именем 'internet_movie', HTML-ссылка будет <A HREF="/internet_movie">. Реальное расположение объекта источника и объекта назначения в иерархии документа игнорируется. Вы должны будете настроить ваш web-браузер на перезапись этого URL на, к примеру, '/my_script.php3/internet_movie'.
'my_script.php3' должен будет вычислять $PATH_INFO и запрашивать документ. Все ссылки будут иметь префикс '/my_script.php3/'. Если вам это не нужно, вы можете установить необязательный параметр rootID/prefix на любой необходимый префикс. В этом случае он должен быть строкой.

Если rootID/prefix это целое число, не равное 0, ссылка конструируется из всех имён, начиная с объекта с id rootID/prefix, разделённых слэшем, относительно текущего объекта. Если, к примеру, документ 'internet_movie' размещён в 'a-b-c-internet_movie' с '-' в качестве разделителя уровней иерархии на Hyperwave-сервере, а документ-источник размещён в 'a-b-d-source', результирующая HTML-ссылка может быть: <A HREF="../c/internet_movie">. Это используется, когда нужно загрузить содержимое всего сервера на диск и отобразить иерархию документов в файловую систему.

Эта функция будет работать только для чисто текстовых документов. Она не открывает специальное соединение данных и, следовательно, не блокирует управление соединением в ходе трансфера.

См. также hw_pipedocument(), hw_free_document(), hw_document_bodytag(), hw_document_size() и hw_output_document().

hw_getusername

(PHP 3>= 3.0.3, PHP 4)

hw_getusername - имя текущего вошедшего/logged пользователя.

Описание

string hw_getusername (int connection)

Возвращает username соединения.

hw_Identify

(PHP 3>= 3.0.3, PHP 4)

hw_Identify - идентифицирует как пользователя.

Описание

int hw_identify (string username, string password)

Идентифицирует как пользователя с username и password. Идентификация верна только для текущей сессии. Я не думаю, что эта функция будет часто нужна. В большинстве случаев легче идентифицировать при открытии соединения.

См. также hw_connect().

hw_InCollections

(PHP 3>= 3.0.3, PHP 4)

hw_InCollections - проверяет, имеются ли object ids в коллекции.

Описание

array hw_incollections (int connection, array object_id_array, array collection_id_array, int return_collections)

Проверяет, является ли набор объектов (документов или коллекций), специфицированный параметром object_id_array, частью коллекций перечисленных collection_id_array. Если четвёртый параметр return_collections равен 0, то поднабор object ids, являющихся частью коллекций (т.е. документов или коллекций, которые являются потомками одной или более ids коллекций или их подколлекций, рекурсивно), возвращается как массив. Если четвёртый параметр равен 1, то как массив возвращается как набор коллекций, которые имеют один или более объектов из этого поднабора в качестве потомков. Эта опция позволяет клиентам, например, выделять часть иерархии коллекции, содержащую совпадения предыдущего запроса, в графическом просмотре.

hw_Info

(PHP 3>= 3.0.3, PHP 4)

hw_Info - информация о соединении.

Описание

string hw_info (int connection)

Возвращает информацию о текущем соединении. Возвращаемая строка имеет следующий формат: <Serverstring>, <Host>, <Port>, <Username>, <Port of Client>, <Byte swapping>