ircg_fetch_error_msg
(PHP 4 >= 4.1.0)
ircg_fetch_error_msg - возвращает ошибку предыдущей ircg-операции.
Описание
array ircg_fetch_error_msg (resource connection)
ircg_fetch_error_msg() возвращает ошибку последней вызванной ircg.
Примечание: код ошибки хранится в первом элементе массива, errortext - во втором.
ircg_get_username
(PHP 4 >= 4.1.0)
ircg_get_username - получает username для соединения.
Описание
string ircg_get_username (int connection)
Функция ircg_get_username() возвращает имя пользователя/username для специфицированного соединения connection. Возвращает FALSE, если connection накрылось или не является правильным.
ircg_html_encode
(PHP 4 >= 4.0.5)
ircg_html_encode - кодирует вывод с сохранением HTML.
Описание
boolean ircg_html_encode (string html_string)
Кодирует HTML-строку html_string для вывода. Это можно использовать, например, если кому-то очень хочется обсудить проблемы html.
ircg_ignore_add
(PHP 4 >= 4.0.5)
ircg_ignore_add - добавляет пользователя в ваш список ignore на сервере.
Описание
boolean ircg_ignore_add (resource connection, string nick)
Эта функция добавит пользователя nick в ваш список ignore на сервере, соединённом по соединению connection. Сделав это вы подавите все сообщения этого пользователя, высылаемые вам.
См. также ircg_ignore_del().
ircg_ignore_del
(PHP 4 >= 4.0.5)
ircg_ignore_del - удаляет пользователя из вашего списка ignore на сервере.
Описание
boolean ircg_ignore_del (resource connection, string nick)
Эта функция удаляет пользователя nick из вашего списка ignore на сервере, соединённом по соединению connection.
См. также ircg_ignore_add().
ircg_is_conn_alive
(PHP 4 >= 4.0.5)
ircg_is_conn_alive - проверяет статус соединения.
Описание
boolean ircg_is_conn_alive (resource connection)
ircg_is_conn_alive() возвращает TRUE, если соединение connection работает, и FALSE, если сервер не отвечает.
ircg_join
(PHP 4 >= 4.0.4)
ircg_join - объединяет канал на соединённом сервере.
Описание
boolean ircg_join (resource connection, string channel)
Объединяет канал channel на сервере, соединённом по соединению connection.
ircg_kick
(PHP 4 >= 4.0.5)
ircg_kick - выталкивает пользователя из канала на сервере.
Описание
boolean ircg_kick (resource connection, string channel, string nick, string reason)
Выталкивает пользователя nick из channel на сервере с соединением
connection.
reason должен задавать краткое сообщение с описанием причин выполнения этой акции.
ircg_lookup_format_messages
(PHP 4 >= 4.0.5)
ircg_lookup_format_messages - выбирает набор строк форматирования для отображения IRC-сообщений.
Описание
boolean ircg_lookup_format_messages (string name)
Выбирает набор строк форматирования для отображения IRC-сообщений и событий. Наборы могут быть зарегистрированы с помощью ircg_register_format_messages(), набор по умолчанию ircg доступен всегда.
См. также ircg_register_format_messages().
ircg_msg
(PHP 4 >= 4.0.4)
ircg_msg - высылает сообщение каналу или пользователю на сервер.
Описание
boolean ircg_msg (resource connection, string recipient, string message [, boolean suppress])
ircg_msg() отправит сообщение каналу или пользователю на сервер, соединённый по соединению connection. Параметр recipient, начинающийся с # или &, отправит message в канал, что-либо ещё будет интерпретировано как username.
Установка для необязательного параметра suppress значения TRUE подавляет вывод вашего сообщения в ваше собственное connection.
ircg_nick
(PHP 4 >= 4.0.5)
ircg_nick - изменяет кличку/nickname на сервере.
Описание
boolean ircg_nick (resource connection, string nick)
Изменяет вашу кличку по данному соединению connection на nick, если это возможно.
Возвратит TRUE при успехе, FALSE при неудаче.
ircg_nickname_escape
(PHP 4 >= 4.0.6)
ircg_nickname_escape - кодирует специальные символы в кличке/nickname для соответствия IRC.
Описание
string ircg_nickname_escape (string nick)
Функция ircg_nickname_escape() возвращает декодированную кличку, специфицированную параметром nick.
См. также ircg_nickname_unescape().
ircg_nickname_unescape
(PHP 4 >= 4.0.6)
ircg_nickname_unescape - декодирует кодированную кличку/nickname.
Описание
string ircg_nickname_unescape (string nick)
Функция ircg_nickname_unescape() возвращает декодированную кличку, специфицированную в nick.
См. также ircg_nickname_escape().
ircg_notice
(PHP 4 >= 4.0.5)
ircg_notice - отправляет уведомление/notice пользователю на сервер.
Описание
boolean ircg_notice (resource connection, string , string message)
Эта функция отправляет текст message пользователю nick на сервер, соединённый по соединению connection. Найдите в документации по IRC точные отличия между MSG и NOTICE.
ircg_part
(PHP 4 >= 4.0.4)
ircg_part - покидает канал на сервере.
Описание
boolean ircg_part (resource connection, string channel)
Покидает канал channel на сервере, соединённом по соединению connection.
ircg_pconnect
(PHP 4 >= 4.0.4)
ircg_pconnect - соединяет с IRC-сервером.
Описание
resource ircg_pconnect (string username [, string server_ip [, int server_port [, string msg_format [, array ctcp_messages [, array user_settings]]]]])
ircg_pconnect() попытается установить соединение с IRC сервером и возвращает дескриптор ресурса соединения для последующего использования.
Единственным обязательным параметром является username; он установит вашу начальную кличку/nickname на сервере.
server_ip и server_port являются необязательными и имеют значения по умолчанию
127.0.0.1 и 6667.
Примечание: в настоящий момент параметр server_ip не просматривает имена хостов и принимает только IP-адреса в числовой форме.
В настоящее время ircg_pconnect() всегда возвращает правильный дескриптор, даже если соединение не удастся.
Вы можете специализировать вывод IRC-сообщений и событий путём выбора набора строк формата, созданного ранее функцией ircg_register_format_messages(), специфицируя имя набора в msg_format.
ctcp_messages
user_settings
См. также ircg_disconnect(), ircg_is_conn_alive(), ircg_register_format_messages().
ircg_register_format_messages
(PHP 4 >= 4.0.5)
ircg_register_format_messages - регистрирует набор строк формата для вывода IRC-сообщений.
Описание
boolean ircg_register_format_messages (string name, array messages)
С помощью ircg_register_format_messages() вы можете специализировать вид вашего IRC-вывода. Вы можете даже зарегистрировать различные наборы строк формата и переключаться между ними на ходу с помощью ircg_lookup_format_messages().
Plain channel message
Private message received
Private message sent
Some user leaves channel
Some user enters channel
Some user was kicked from the channel
Topic has been changed
Error
Fatal error
Join list end(?)
Self part(?)
Some user changes his nick
Some user quits his connection
Mass join begin
Mass join element
Mass join end
Whois user
Whois server
Whois idle
Whois channel
Whois end
Voice status change on user
Operator status change on user
Banlist
Banlist end
%f - from
%t - to
%c - channel
%r - plain message
%m - encoded message
%j - js encoded message
1 - mod encode
2 - nickname decode
См. также ircg_lookup_format_messages().
ircg_set_current
(PHP 4 >= 4.0.4)
ircg_set_current - устанавливает текущее соединение для вывода.
Описание
boolean ircg_set_current (resource connection)
Выбирает текущее соединение для вывода в данном контексте выполнения. Каждый вывод, отправленный с сервера с соединением connection, будет скопирован в стандартный вывод с использованием форматирования по умолчанию или набора строк формата, специфицированного функцией ircg_register_format_messages() и выбранного функцией ircg_lookup_format_messages().
См. также ircg_register_format_messages() и ircg_lookup_format_messages().
ircg_set_file
(PHP 4 >= 4.2.0)
ircg_set_file - устанавливает logfile для соединения.
Описание
bool ircg_set_file (int connection, string path)
Функция ircg_set_file() специфицирует путь path log-файла, в который записываются все выводы из соединения connection. Возвращает TRUE при успехе, иначе FALSE.
ircg_set_on_die
(PHP 4 >= 4.2.0)
ircg_set_on_die - устанавливает выполняемую акцию хоста, когда соединение загибается/die.
Описание
bool ircg_set_on_die (int connection, string host, int port, string data)
В случае разрыва соединения connection, IRCG соединится с host по port (Примечание: host обязан быть IPv4-адресом, IRCG не разрешает host-имена из-за проблем с блокировкой), отправляет данные data по новому соединению с хостом и ожидает, пока удалённая часть не закроет соединение. Это можно использовать, например, для включения РНР-скрипта.
ircg_topic
(PHP 4 >= 4.0.5)
ircg_topic - устанавливает тему/topic для канала на сервере.
Описание
boolean ircg_topic (resource connection, string channel, string new_topic)
Изменяет topic канала channel на сервере, соединённом по соединению connection, на new_topic.
ircg_whois
(PHP 4 >= 4.0.5)
ircg_whois - запрашивает информацию о пользователе для клички/nick на сервере.
Описание
boolean ircg_whois (resource connection, string nick)
Отправляет запрос на соединённый сервер connection для отправки информации специфицированному пользователю nick.
is_a
(PHP 4 >= 4.2.0)
is_a - возвращает TRUE, если это объект данного класса или имеет этот класс в качестве одного из своих предков.
Описание
bool is_a (object object, string class_name)
Эта функция возвращает TRUE, если это объект данного класса или имеет этот класс в качестве одного из своих предков, FALSE в ином случае.
См. также get_class(), get_parent_class() и is_subclass_of().
is_array
(PHP 3, PHP 4)
is_array - определяет, является ли переменная массивом.
Описание
bool is_array (mixed var)
Возвращает TRUE, если var является array, FALSE в ином случае.
См. также is_float(), is_int(), is_integer(), is_string() и is_object().
is_bool
(PHP 4)
is_bool - определяет, является ли переменная булевым значением.
Описание
bool is_bool (mixed var)
Возвращает TRUE, если параметр var является boolean.
См. также is_array(), is_float(), is_int(), is_integer(), is_string() и is_object().
is_callable
(PHP 4 >= 4.0.6)
is_callable - определяет, является ли аргумент правильной вызываемой конструкцией.
Описание
bool is_callable (mixed var [, bool syntax_only [, string callable_name]])
is_dir
(PHP 3, PHP 4)
is_dir - сообщает, является ли filename директорией.
Описание
bool is_dir (string filename)
Возвращает TRUE, если filename существует и является директорией (каталогом). Если filename это относительное имя, оно проверяется относительно текущей рабочей директории.
Результаты этой функции кэшируются. См. детали в clearstatcache().
Эта функция не работает с remote/удалёнными файлами; проверяемый файл обязан быть доступен через файловую систему сервера.
is_double
(PHP 3, PHP 4)
is_double - псевдоним
Описание
Эта функция является псевдонимом для is_float().
is_executable
(PHP 3, PHP 4)
is_executable - сообщает, является ли filename исполняемым (экзешником).
Описание
bool is_executable (string filename)
Возвращает TRUE, если filename существует и является исполняемым.
Результаты работы этой функции кэшируются. См. детали в clearstatcache().
Эта функция не работает с remote/удалёнными файлами; проверяемый файл обязан быть доступен через файловую систему сервера.
is_file
(PHP 3, PHP 4)
is_file - сообщает, является ли filename обычным файлом.
Описание
bool is_file (string filename)
Возвращает TRUE, если filename существует и является обычным/regular файлом.
Результаты этой функции кэшируются. См. детали в clearstatcache().
is_finite
(PHP 4 >= 4.2.0)
Описание
bool is_finite (float val)
Возвращает TRUE, если val является допустимым конечным числом в пределах диапазона чисел с плавающей точкой PHP на данной платформе.
is_float
(PHP 3, PHP 4)
is_float - определяет, является ли переменная числом с плавающей точкой.
Описание
bool is_float (mixed var)
Возвращает TRUE, если var является float, FALSE в ином случае.
Примечание: чтобы проверить, является ли переменная числом или числовой строкой (такой как ввод формы, который всегда является строкой), вы обязаны использовать is_numeric().
См. также is_bool(), is_int(), is_integer(), is_numeric(), is_string(), is_array() и is_object().
is_infinite
(PHP 4 >= 4.2.0)
Описание
bool is_infinite (float val)
Возвращает TRUE, если val является бесконечным (положительным или отрицательным), вроде результата log(0) или любого значения, которое слишком велико, чтобы быть float на данной платформе.
is_int
(PHP 3, PHP 4)
is_int - определяет, является ли переменная integer.
Описание
bool is_int (mixed var)
Возвращает TRUE, если var является integer, FALSE в ином случае.
Примечание: чтобы проверить, является ли переменная числом или числовой строкой (такой как ввод формы, который всегда является строкой), вы обязаны использовать is_numeric().
См. также is_bool(), is_float(), is_integer(), is_numeric(), is_string(), is_array() и is_object().
is_integer
(PHP 3, PHP 4)
is_integer - псевдоним is_int().
Описание
Эта функция является псевдонимом is_int().
is_link
(PHP 3, PHP 4)
is_link - сообщает, является ли filename символьной ссылкой.
Описание
bool is_link (string filename)
Возвращает TRUE, если filename существует и является символьной ссылкой.
Результаты этой функции кэшируются. См. детали в clearstatcache().
См. также is_dir(), is_file() и readlink().
Эта функция не работает с remote/удалёнными файлами; проверяемый файл обязан быть доступен через файловую систему сервера.
Примечание: эта функция не реализована для платформ Windows.
is_long
(PHP 3, PHP 4)
is_long - псевдоним is_int().
Описание
Эта функция является псевдонимом is_int().
is_nan
(PHP 4 >= 4.2.0)
Описание
bool is_nan (float val)
Возвращает TRUE, если val является 'not a number/не-числом', вроде результата acos(1.01).
is_null
(PHP 4 >= 4.0.4)
is_null - определяет, является ли переменная NULL.
Описание
bool is_null (mixed var)
Возвращает TRUE, если var является null, FALSE в ином случае.
См. в описании типа NULL, когда переменная считается NULL, а когда нет.
См. также NULL, is_bool(), is_numeric(), is_float(), is_int(), is_string(), is_object(), is_array(), is_integer() и is_real().
is_numeric
(PHP 4)
is_numeric - определяет, является ли переменная числом или числовой строкой.
Описание
bool is_numeric (mixed var)
Возвращает TRUE, если var является числом или числовой строкой, FALSE в ином случае.
См. также is_bool(), is_float(), is_int(), is_string(), is_object(), is_array() и is_integer().
is_object
(PHP 3, PHP 4)
is_object - определяет, является ли переменная объектом.
Описание
bool is_object (mixed var)
Возвращает TRUE, если var является object, FALSE в ином случае.
См. также is_bool(), is_int(), is_integer(), is_float(), is_string() и is_array().
is_readable
(PHP 3, PHP 4)
is_readable - сообщает, является ли filename читабельным.
Описание
bool is_readable (string filename)
Возвращает TRUE, если файл filename существует и является читабельным.
Помните, что PHP может осуществлять доступ к файлу как user id, под именем которого работает web-сервер (часто 'nobody'). Ограничения безопасного режима не учитываются.
Результаты работы этой функции кэшируются. См. детали в clearstatcache().
Эта функция не будет работать с remote/удалёнными файлами; проверяемый файл обязан быть доступен через файловую систему сервера.
См. также is_writable().
is_real
(PHP 3, PHP 4)
is_real - псевдоним is_float().
Описание
Эта функция является псевдонимом is_float().
is_resource
(PHP 4)
is_resource - определяет, является ли переменная ресурсом.
Описание
bool is_resource (mixed var)
is_resource() возвращает TRUE, если переменная var является resource, иначе возвращает FALSE.
См. также документацию о типе resource.
is_scalar
(PHP 4 >= 4.0.5)
is_scalar - определяет, является ли переменная скаляром.
Описание
bool is_scalar (mixed var)
is_scalar() возвращает TRUE, если переменная var является скаляром, иначе возвращает FALSE.
Скалярными являются переменные, содержащие integer, float, string или boolean. Типы array, object и resource не являются скалярными.
is_string
(PHP 3, PHP 4)
is_string - определяет, является ли переменная строкой.
Описание
bool is_string (mixed var)
Возвращает TRUE, если var является string, иначе FALSE.
См. также is_bool(), is_int(), is_integer(), is_float(), is_real(), is_object() и is_array().
is_subclass_of
(PHP 4)
is_subclass_of - возвращает TRUE, если объект имеет данный класс в качестве одного из своих предков.
Описание
bool is_subclass_of (object object, string class_name)
Эта функция возвращает TRUE, если объект object принадлежит к классу, который является подклассом класса class_name, иначе FALSE.
См. также get_class(), get_parent_class() и is_a().
is_uploaded_file
(PHP 3>= 3.0.17, PHP 4 >= 4.0.3)
is_uploaded_file - сообщает, был ли файл загружен через HTTP POST.
Описание
bool is_uploaded_file (string filename)
Возвращает TRUE, если файл filename был загружен через HTTP POST. Это помогает убедиться, что злонамеренный пользователь не пытался заставить скрипт работать с файлами, с которыми он работать не должен, например, /etc/passwd.
Этот вид проверки особенно важен, когда есть вероятность того, что некоторые действия с загруженными файлами могут дать доступ к их содержимому пользователю или даже другим пользователям той же системы.
is_uploaded_file() доступна только в версиях PHP 3 после PHP 3.0.16 и в версиях PHP 4 после 4.0.2. Если вы продолжаете использовать ранние версии, вы можете использовать следующую функцию, которая поможет вам защититься:
Примечание: следующий пример не будет работать в версиях PHP 4 после 4.0.2. Это зависит от внутренней функциональности PHP, которая была изменена после указанной версии.
is_writable
(PHP 4)
is_writable - сообщает, можно ли записывать в filename.
Описание
bool is_writable (string filename)
Возвращает TRUE, если filename существует и является writable. Аргумент filename может быть именем директории, позволяя проверять возможность записи в директорию.
Помните, что PHP может иметь доступ к файлам как user id, под которым запущен web-сервер (часто это 'nobody'). Ограничения безопасного режима не учитываются.
Результаты этой функции кэшируются. См. детали в clearstatcache().
Эта функция не работает с удалёнными файлами; проверяемый файл обязан быть доступен через файловую систему сервера.
См. также is_readable().
is_writeable
(PHP 3, PHP 4)
is_writeable - сообщает, является ли файл filename доступным для записи.
Описание
bool is_writeable (string filename)
Это псевдоним is_writable().
isset
(unknown)
isset - определяет, установлена ли переменная.
Описание
bool isset (mixed var [, mixed var [, ...]])
Примечание: isset() это конструкция языка.
Возвращает TRUE, если var существует, иначе FALSE.
Если переменная была разустановлена/unset с помощью функции unset(), она больше не сможет быть isset(). isset() возвратит FALSE, если проверяет переменную, которая была установлена NULL. Также отметьте, что NULL-байт ("\0") не является эквивалентом PHP-константы NULL.
java_last_exception_clear
(PHP 4 >= 4.0.2)
java_last_exception_clear - очищает последнее Java-исключение.
Описание
void java_last_exception_clear (void)
java_last_exception_get
(PHP 4 >= 4.0.2)
java_last_exception_get - получает последнее Java-исключение.
Описание
exception java_last_exception_get (void)
Следующий пример демонстрирует использование обработчика Java-исключения в PHP:
JDDayOfWeek
(PHP 3, PHP 4)
JDDayOfWeek - возвращает день недели.
Описание
mixed jddayofweek (int julianday, int mode)
Возвращает день недели. Может возвратить строку или integer, в зависимости от режима.
Таблица 1. Режимы календарной недели
JDMonthName
(PHP 3, PHP 4)
JDMonthName - возвращает название месяца.
Описание
string jdmonthname (int julianday, int mode)
Возвращает строку, содержащую название месяца.
mode говорит этой функции, в какой календарь конвертировать Julian Day Count/Юлианское
летосчисление и каков тип возвращаемых названий месяцев.
Таблица 1. Режимы календаря
JDToFrench
(PHP 3, PHP 4)
JDToFrench - конвертирует Юлианское летосчисление во Французский Республиканский календарь.
Описание
string jdtofrench (int juliandaycount)
Конвертирует Julian Day Count во French Republican Calendar.
JDToGregorian
(PHP 3, PHP 4)
JDToGregorian - конвертирует Юлианское летосчисление в Григорианскую дату.
Описание
string jdtogregorian (int julianday)
Конвертирует Юлианское летосчисление в строку, содержащую Григорианскую дату в формате "месяц/день/год".
JDToJewish
(PHP 3, PHP 4)
JDToJewish - конвертирует Юлианское летосчисление в Иудейский календарь.
Описание
string jdtojewish (int julianday)
Конвертирует Юлианское летосчисление в Иудейский календарь.
JDToJulian
(PHP 3, PHP 4)
JDToJulian - конвертирует Юлианское летосчисление в дату Юлианского календаря.
Описание
string jdtojulian (int julianday)
Конвертирует Юлианское летосчисление/Julian Day Count в строку, содержащую Julian Calendar Date в формате "месяц/день/год".
jdtounix
(PHP 4)
jdtounix - конвертирует Julian Day в UNIX timestamp.
Описание
int jdtounix (int jday)
Эта функция возвратит UNIX timestamp, соответствующий Julian Day jday, или FALSE, если jday не находится в пределах UNIX-эпохи (Григорианские годы от 1970 до 2037, или 2440588 <= jday <= 2465342). Возвращается локальное время (а не GMT).
См. также unixtojd().
JewishToJD
(PHP 3, PHP 4)
JewishToJD - конвертирует дату Иудейского календаря в Julian Day Count.
Описание
int jewishtojd (int month, int day, int year)
Хотя эта функция может обрабатывать даты до 1 года (3761 Д.Н.Э.), такое использование не имеет смысла. Иудейский календарь используется на протяжении нескольких тысяч лет, но раньше не было формулы для определения начала месяца. Новый месяц начинался, когда впервые появлялась новая луна.
join
(PHP 3, PHP 4)
join - объединяет элементы массива со строкой.
Описание
string join (string glue, array pieces)
join() это псевдоним implode(), идентичный во всём.
jpeg2wbmp
(PHP 4 >= 4.0.5)
jpeg2wbmp - конвертирует файл JPEG-изображения в файл WBMP-изображения.
Описание
int jpeg2wbmp (string jpegname, string wbmpname, int d_height, int d_width, int threshold)
Конвертирует JPEG-файл jpegname в WBMP-формат и сохраняет как wbmpname. С помощью d_height и d_width вы специфицируете высоту и ширину целевого изображения.
Примечание: поддержка WBMP доступна только в том случае, если PHP был скомпилирован относительно GD-1.8 или новее.
См. также png2wbmp().
JulianToJD
(PHP 3, PHP 4)
JulianToJD - конвертирует дату Юлианского календаря в Julian Day Count/Юлианское летосчисление.
Описание
int juliantojd (int month, int day, int year)
Диапазон Юлианского календаря: от 4713 до Н.Э до 9999 Н.Э.
Хотя эта функция может работать с датами до 4713 до Н.Э., такое использование не имеет смысла. Этот календарь был создан в 46 году до Н.Э., но детали не были стабилизированы как минимум до 8 Н.Э., а возможно и до 4 столетия. Также начало года варьируется от одной культуры к другой - не все принимают January как первый месяц.
key
(PHP 3, PHP 4)
key - извлекает ключ из ассоциативного массива.
Описание
mixed key (array array)
key() возвращает индексный элемент текущей позиции в массиве.
krsort
(PHP 3>= 3.0.13, PHP 4)
krsort - сортирует массив по ключам в обратном порядке.
Описание
int krsort (array array [, int sort_flags])
Сортирует массив по ключам в обратном порядке, сохраняя корреляцию ключей с данными. Это используется в основном в ассоциативных массивах.
ksort
(PHP 3, PHP 4)
ksort - сортирует массив по ключам.
Описание
int ksort (array array [, int sort_flags])
Сортирует массив по ключам, сохраняя корреляцию ключей и данных. Это используется в основном в ассоциативных массивах.
lcg_value
(PHP 4)
lcg_value - комбинирует линеарный конгруэнтный генератор.
Описание
float lcg_value (void)
lcg_value() возвращает псевдослучайное в диапазоне (0, 1). Функция комбинирует два CG с периодами 2^31 - 85 и 2^31 - 249. Период этой функции равен продукту обоих составляющих.
ldap_8859_to_t61
(PHP 4 >= 4.0.2)
ldap_8859_to_t61 - транслирует 8859-символы в t61-символы.
Описание
string ldap_8859_to_t61 (string value)
ldap_add
(PHP 3, PHP 4)
ldap_add - добавляет вхождения в LDAP-директорию.
Описание
bool ldap_add (resource link_identifier, string dn, array entry)
Возвращает TRUE при успехе, FALSE при неудаче.
Функция ldap_add() используется для добавления вхождений в LDAP-директорию. DN добавляемого вхождения специфицируется параметром dn. Массив entry специфицирует информацию о вхождении. Значения вхождений индексируются по индивидуальным атрибутам. При наличии нескольких значений атрибута, они индексируются целыми числами, начиная с 0.
entry["attribute1"] = value
entry["attribute2"][0] = value1
entry["attribute2"][1] = value2
ldap_bind
(PHP 3, PHP 4)
ldap_bind - связывает с LDAP-директорией.
Описание
bool ldap_bind (resource link_identifier [, string bind_rdn [, string bind_password]])
Связывает с LDAP-директорией со специфицированными RDN и password. Возвращает TRUE при успехе, FALSE при неудаче.
ldap_bind() выполняет операцию bind в директории.
bind_rdn и bind_password являются необязательными. Если не специфицированы, делается попытка anonymous bind/анонимной
связки.
ldap_close
(PHP 3, PHP 4)
ldap_close - закрывает ссылку на LDAP-сервер.
Описание
bool ldap_close (resource link_identifier)
Возвращает TRUE при успехе, FALSE при неудаче.
ldap_close() закрывает ссылку на LDAP-сервер, ассоциированную со специфицированным идентификатором link_identifier.
Этот вызов внутренне идентичен ldap_unbind(). LDAP API использует вызов ldap_unbind(), поэтому, возможно, вам нужно использовать её вместо ldap_close().
Примечание: эта функция является псевдонимом ldap_unbind().
ldap_compare
(PHP 4 >= 4.0.2)
ldap_compare - сравнивает значение атрибута, найденное во вхождении, специфицированном с помощью DN.
Описание
bool ldap_compare (resource link_identifier, string dn, string attribute, string value)
Возвращает TRUE, если value совпадает, иначе возвращает FALSE. Возвращает -1 при ошибке.
ldap_compare() используется для сравнения value атрибута attribute со значением того же атрибута во вхождении LDAP-директории, специфицированном параметром dn.
Следующий пример демонстрирует, как проверить, совпал или нет данный пароль/password с паролем, определённым в специфицированном вхождении DN.
ldap_connect
(PHP 3, PHP 4)
ldap_connect - соединяется с LDAP-сервером.
Описание
resource ldap_connect ([string hostname [, int port]])
Возвращает положительный идентификатор LDAP-ссылки при успехе, FALSE при ошибке.
ldap_connect() устанавливает соединение с LDAP-сервером при специфицированных hostname и port. Оба аргумента являются необязательными. Если аргументы не специфицированы, будет возвращён идентификатор уже открытой ссылки. Если специфицирован только hostname, то по умолчанию порт будет 389.
Если вы используете OpenLDAP 2.x.x, вы можете специфицировать URL вместо hostname. Для использования LDAP с SSL скомпилируйте OpenLDAP 2.x.x с поддержкой SSL, сконфигурируйте PHP с SSL и используйте ldaps://hostname/ как host-параметр. Номер порта не используется при использовании URL.
Примечание: поддержка URL и SSL была введена в 4.0.4.
ldap_count_entries
(PHP 3, PHP 4)
ldap_count_entries - вычисляет количество вхождений при поиске.
Описание
int ldap_count_entries (resource link_identifier, resource result_identifier)
Возвращает количество вхождений в результате или FALSE при ошибке.
ldap_count_entries() возвращает количество вхождений, хранимых в результате предыдущих операций поиска. result_identifier идентифицирует внутренний ldap-результат.
ldap_delete
(PHP 3, PHP 4)
ldap_delete - удаляет вхождение из директории.
Описание
bool ldap_delete (resource link_identifier, string dn)
Возвращает TRUE при успехе, FALSE при неудаче.
ldap_delete() удаляет определённое вхождение в LDAP-директории, специфицированное параметром dn.
ldap_dn2ufn
(PHP 3, PHP 4)
ldap_dn2ufn - конвертирует DN в формат User Friendly Naming.
Описание
string ldap_dn2ufn (string dn)
ldap_dn2ufn() используется для перевода DN, специфицированного параметром dn, в более близкую пользователю форму, вырезая имена типов.
ldap_err2str
(PHP 3>= 3.0.13, PHP 4)
ldap_err2str - конвертирует номер LDAP-ошибки в строку сообщения об ошибке.
Описание
string ldap_err2str (int errno)
Возвращает строку сообщения об ошибке.
Эта функция возвращает строковое сообщение об ошибке, разъясняющее ошибку номер errno. Хотя LDAP errno-номера стандартизированы, различные библиотеки возвращают разные или даже локализованные текстовые сообщения. Никогда не проверяйте текст сообщения об ошибке, но всегда используйте номер ошибки для проверки.
См. также ldap_errno() и ldap_error().
ldap_errno
(PHP 3>= 3.0.12, PHP 4)
ldap_errno - возвращает номер LDAP-ошибки последней LDAP-команды.
Описание
int ldap_errno (resource link_identifier)
Возвращает номер LDAP-ошибки последней LDAP-команды для данной ссылки.
Эта функция возвращает стандартизованный номер ошибки, возвращённой последней LDAP-командой для данного идентификатора ссылки link_identifier. Это число может быть конвертировано в текстовое сообщение об ошибке с помощью ldap_err2str().
Если вы не снизили уровень предупреждений в php.ini и не ввели префикс @ (at) в ваших LDAP-командах для подавления вывода предупреждений, генерируемые ошибки будут выводиться в вашем HTML-выводе.
ldap_error
(PHP 3>= 3.0.12, PHP 4)
ldap_error - возвращает LDAP-сообщение об ошибке последней LDAP-команды.
Описание
string ldap_error (resource link_identifier)
Возвращает строковое сообщение об ошибке.
Эта функция возвращает строковое сообщение, объясняющее ошибку, сгенерированную последней LDAP-командой для данного link_identifier. Хотя LDAP errno-номера стандартизованы, разные библиотеки возвращают разные, и даже локализованные, текстовые сообщения об ошибках. Никогда не проверяйте текст сообщения, но всегда используйте для проверки error-номер.
Если вы не снизили уровень предупреждений в php.ini и не ввели префикс @ (at) в ваших LDAP-командах для подавления вывода предупреждений, генерируемые ошибки будут выводиться в вашем HTML-выводе.
См. также ldap_err2str() и ldap_errno().
ldap_explode_dn
(PHP 3, PHP 4)
ldap_explode_dn - разделяет DN на части-компоненты.
Описание
array ldap_explode_dn (string dn, int with_attrib)
ldap_explode_dn() используется для разделения DN, возвращённого функцией ldap_get_dn(), на компоненты. Каждая часть известна как Relative
Distinguished Name/Относительное Отличительное Имя, или RDN. ldap_explode_dn()возвращает массив из всех этих компонентов.
with_attrib используется для запроса: возвращены RDNs только со значениями, или также и с
атрибутами. Для получения RDNs с атрибутами (т.е. в формате attribute=value) установите в
with_attrib значение 0, а для получения только значений - установите 1.
ldap_first_attribute
(PHP 3, PHP 4)
ldap_first_attribute - возвращает первый атрибут.
Описание
string ldap_first_attribute (resource link_identifier, resource result_entry_identifier, int ber_identifier)
Возвращает первый атрибут во вхождении при успехе, FALSE при ошибке.
По аналогии с вхождениями, атрибуты также читаются один за другим из определённого вхождения.
ldap_first_attribute() возвращает первый атрибут во вхождении, на которое указывает
result_entry_identifier. Остальные атрибуты запрашиваются последующими вызовами функции
ldap_next_attribute().
ber_identifier это идентификатор указателя внутренней памяти. Он передаётся по ссылке. Тот же
самый ber_identifier передаётся функции ldap_next_attribute(), которая модифицирует этот указатель.
См. также ldap_get_attributes().
ldap_first_entry
(PHP 3, PHP 4)
ldap_first_entry - возвращает первый результирующий id.
Описание
resource ldap_first_entry (resource link_identifier, resource result_identifier)
Возвращает результирующий идентификатор первого вхождения при успехе, FALSE при ошибке.
Вхождения в LDAP-результате читаются последовательно с использованием функций ldap_first_entry() и ldap_next_entry(). ldap_first_entry() возвращает идентификатор вхождения для первого вхождения в результате. Этот идентификатор затем предоставляется утилите lap_next_entry() для получения последующих вхождений в результате.
См. также ldap_get_entries().
ldap_first_reference
(PHP 4 >= 4.0.5)
ldap_first_reference - возвращает первую ссылку.
Описание
resource ldap_first_reference (resource link, resource result)
ldap_free_result
(PHP 3, PHP 4)
ldap_free_result - освобождает результирующую память.
Описание
bool ldap_free_result (resource result_identifier)
Возвращает TRUE при успехе, FALSE при неудаче.
ldap_free_result() освобождает память, выделенную внутренне для хранения результата, на которую указывает идентификатор result_identifier. Вся результирующая память автоматически будет освобождена, когда скрипт завершает работу.
Обычно вся память, выделенная для ldap-результата, освобождается по окончании работы скрипта. Если скрипт несколько раз успешно выполнил поиск, возвращая большие результирующие наборы, ldap_free_result() может быть вызвана для сохранения низкого уровня использования памяти скриптом.
ldap_get_attributes
(PHP 3, PHP 4)
ldap_get_attributes - получает атрибуты из вхождения результата поиска.
Описание
array ldap_get_attributes (resource link_identifier, resource result_entry_identifier)
Возвращает полную информацию о вхождении в виде многомерного массива при успехе, FALSE при ошибке.
ldap_get_attributes() используется для упрощения чтения атрибутов и значений из вхождения в
результате поиска.
return-значение это многомерный массив атрибутов и значений.
Локализовав специфицированное вхождение в директории, вы можете определить, какая информация содержится об этом вхождении при использовании этого вызова. Вы можете использовать этот вызов для приложения, которое "просматривает" вхождения директории, и/или где вы не знаете структуру вхождений директории. Во многих приложениях вы будете искать специфический атрибут, такой как email-адрес или surname, или другие данные.
return_value["count"] = количество атрибутов во вхождении
return_value[0] = первый атрибут
return_value[n] = n'ный атрибут
return_value["attribute"]["count"] = количество значений атрибута
return_value["attribute"][0] = первое значение атрибута
return_value["attribute"][i] = (i+1)'ное значение атрибута
ldap_get_dn
(PHP 3, PHP 4)
ldap_get_dn - получает DN вхождения в результате.
Описание
string ldap_get_dn (resource link_identifier, resource result_entry_identifier)
Возвращает DN вхождения в результате, FALSE при ошибке.
ldap_get_dn() используется для определения DN вхождения в результате.
ldap_get_entries
(PHP 3, PHP 4)
ldap_get_entries - получает все вхождения в результате.
Описание
array ldap_get_entries (resource link_identifier, resource result_identifier)
Возвращает полную результирующую информацию в виде многомерного массива при успехе, FALSE при ошибке.
ldap_get_entries() используется для упрощения чтения нескольких вхождений в результате, специфицированном идентификатором result_identifier, и последующего чтения атрибутов и множественных значений. Вся информация возвращается одним вызовом функции в виде многомерного массива. Структура массива такова:
Индекс атрибутов конвертируется в нижний регистр. (Атрибуты нечувствительны к регистру для серверов директорий, но чувствительны при использовании в качестве индексов массива.)
return_value["count"] = количество вхождений в результате
return_value[0 : касается деталей первого вхождения
return_value[i]["dn"] = DN i'ного вхождения в результате
return_value[i]["count"] = количество атрибутов в i'ном вхождении
return_value[i][j] = j'ный атрибут в i'ном вхождении в результате
return_value[i]["attribute"]["count"] = количество значений атрибута в i'ном вхождении
return_value[i]["attribute"][j] = j'ное значение атрибута в i'ном вхождении
См. также ldap_first_entry() и ldap_next_entry().
ldap_get_option
(PHP 4 >= 4.0.4)
ldap_get_option - получает текущее значение данной опции.
Описание
bool ldap_get_option (resource link_identifier, int option, mixed retval)
Устанавливает в retval значение специфицированной опции. Возвращает TRUE при успехе, FALSE при неудаче.
Параметр option может быть одним из: LDAP_OPT_DEREF, LDAP_OPT_SIZELIMIT, LDAP_OPT_TIMELIMIT, LDAP_OPT_PROTOCOL_VERSION, LDAP_OPT_ERROR_NUMBER, LDAP_OPT_REFERRALS, LDAP_OPT_RESTART, LDAP_OPT_HOST_NAME, LDAP_OPT_ERROR_STRING, LDAP_OPT_MATCHED_DN. Они описаны в draft-ietf-ldapext-ldap-c-api-xx.txt
Примечание: эта функция доступна только при использовании OpenLDAP 2.x.x ИЛИ Netscape Directory SDK x.x и была введена в PHP 4.0.4.
ldap_get_values
(PHP 3, PHP 4)
ldap_get_values - получает все значения из результирующего вхождения.
Описание
array ldap_get_values (resource link_identifier, resource result_entry_identifier, string attribute)
Возвращает массив значений атрибута при успехе, FALSE при ошибке.
ldap_get_values() используется для чтения всех значений атрибута вхождения в результате. Вхождение специфицируется параметром result_entry_identifier. Количество значений можно определить через индексирование результирующего массива. Доступ к отдельным значениям можно получить по целочисленному индексу массива. Первый индекс 0.
Для этого вызова требуется result_entry_identifier, поэтому ему должен предшествовать один из вызовов ldap-поиска и один из вызовов получения конкретного вхождения.
Ваше приложение должно быть жёстко кодировано для поиска определённых атрибутов (таких как "surname" или "mail"), либо вы должны использовать вызов ldap_get_attributes() для работы с существующими атрибутами данного вхождения.
LDAP разрешает более одного вхождения на атрибут, поэтому можно, например, хранить количество email-адресов одной директории маркированными атрибутом "mail".
return_value["count"] = количество значений атрибута
return_value[0] = первое значение атрибута
return_value[i] = i'ное значение атрибута
ldap_get_values_len
(PHP 3>= 3.0.13, PHP 4)
ldap_get_values_len - получает все двоичные значения из результирующего вхождения.
Описание
array ldap_get_values_len (resource link_identifier, resource result_entry_identifier, string attribute)
Возвращает массив значений атрибута при успехе, FALSE при ошибке.
ldap_get_values_len() используется для чтения всех значений атрибута вхождения в результате. Вхождение специфицируется параметром result_entry_identifier. Количество значений можно определить через индексирование результирующего массива. Доступ к отдельным значениям можно получить по целочисленному индексу массива. Первый индекс 0.
Эта функция используется точно так же, как ldap_get_values(), но обрабатывает двоичные, а не строковые данные.
Примечание: эта функция была введена в 4.0.
ldap_list
(PHP 3, PHP 4)
ldap_list - одноуровневый поиск.
Описание
resource ldap_list (resource link_identifier, string base_dn, string filter [, array attributes [, int attrsonly [, int sizelimit [, int timelimit [, int deref]]]]])
Возвращает идентификатор результата поиска или FALSE при ошибке.
ldap_list() выполняет поиск специфицированного фильтра filter в директории с областью видимости LDAP_SCOPE_ONELEVEL.
LDAP_SCOPE_ONELEVEL означает, что поиск должен лишь возвратить информацию об уровне на один ниже, чем base_dn, заданный в вызове. (Эквивалентно печати "ls" и получению списка файлов и каталогов в текущей рабочей директории.)
Этот вызов имеет 5 необязательных параметров. См. ldap_search().
Примечание: эти необязательные параметры были введены в версии 4.0.2: attrsonly, sizelimit, timelimit, deref.
ldap_mod_add
(PHP 3>= 3.0.8, PHP 4)
ldap_mod_add - добавляет значения текущим атрибутам.
Описание
bool ldap_mod_add (resource link_identifier, string dn, array entry)
Возвращает TRUE при успехе, FALSE при неудаче.
Эта функция добавляет атрибут(ы) специфицированному dn. Она выполняет модификацию на уровне атрибута, а не на уровне объекта. Дополнения на уровне объекта выполняются функцией ldap_add().
ldap_mod_del
(PHP 3>= 3.0.8, PHP 4)
ldap_mod_del - удаляет значения текущих атрибутов.
Описание
bool ldap_mod_del (resource link_identifier, string dn, array entry)
Возвращает TRUE при успехе, FALSE при неудаче.
Эта функция удаляет атрибут(ы) из специфицированного dn. Она выполняет модификацию на уровне атрибута, а не на уровне объекта. Удаления на уровне объекта выполняются функцией ldap_delete().
ldap_mod_replace
(PHP 3>= 3.0.8, PHP 4)
ldap_mod_replace - замещает значения атрибутов новыми значениями.
Описание
bool ldap_mod_replace (resoure link_identifier, string dn, array entry)
Возвращает TRUE при успехе, FALSE при неудаче.
Эта функция замещает атрибут(ы) специфицированного dn. Она выполняет модификацию на уровне атрибута, а не на уровне объекта. Модификации на уровне объекта выполняются функцией ldap_modify().
ldap_modify
(PHP 3, PHP 4)
ldap_modify - модифицирует LDAP-вхождение.
Описание
bool ldap_modify (resource link_identifier, string dn, array entry)
Возвращает TRUE при успехе, FALSE при неудаче.
ldap_modify() используется для модификации существующих вхождений в LDAP-директории. Структура вхождения - та же, что и в ldap_add().
ldap_next_attribute
(PHP 3, PHP 4)
ldap_next_attribute - получает следующий атрибут вхождения в результате.
Описание
string ldap_next_attribute (resource link_identifier, resource result_entry_identifier, resource ber_identifier)
Возвращает следующий атрибут вхождения при успехе, FALSE при ошибке.
ldap_next_attribute() вызывается для запрашивания атрибутов вхождения. Внутренний статус указателя указывается параметром ber_identifier. Он передаётся по ссылке первому вызову функции. Первый вызов ldap_next_attribute() делается с идентификатором result_entry_identifier, возвращённым функцией ldap_first_attribute().
См. также ldap_get_attributes().
ldap_next_entry
(PHP 3, PHP 4)
ldap_next_entry - получает следующее результирующее вхождение.
Описание
resource ldap_next_entry (resource link_identifier, resource result_entry_identifier)
Возвращает идентификатор следующего вхождения в результате, чьи вхождения читаются, начиная с ldap_first_entry(). Если в результате больше вхождений нет, функция возвращает FALSE.
ldap_next_entry() используется для запрашивания вхождений, хранимых в результате. Последовательные вызовы ldap_next_entry() возвращают вхождения одно за другим до их окончания. Первый вызов ldap_next_entry() делается, после вызова ldap_first_entry(), с идентификатором result_entry_identifier, возвращённом из ldap_first_entry().
См. также ldap_get_entries().
ldap_next_reference
(PHP 4 >= 4.0.5)
ldap_next_reference - получает следующую ссылку.
Описание
resource ldap_next_reference (resource link, resource entry)
ldap_parse_reference
(PHP 4 >= 4.0.5)
ldap_parse_reference - извлекает информацию из вхождения ссылки.
Описание
bool ldap_parse_reference (resource link, resource entry, array referrals)
