YP/NIS Functions

Introduction

NIS (formerly called Yellow Pages) allows network management of important administrative files (e.g. the password file). For more information refer to the NIS manpage and » The Linux NIS(YP)/NYS/NIS+ HOWTO. There is also a book called » Managing NFS and NIS by Hal Stern.

Note:

This extension has been moved to the » PECL repository and is no longer bundled with PHP as of PHP 5.1.0.

Note:

This extension is not available on Windows platforms.

Requirements

None besides functions from standard Unix libraries which are always available (either libc or libnsl, configure will detect which one to use).

Installation

To get these functions to work, you have to configure PHP with --enable-yp.

Runtime Configuration

This extension has no configuration directives defined in php.ini.

Predefined Constants

The constants below are defined by this extension, and will only be available when the extension has either been compiled into PHP or dynamically loaded at runtime.

YPERR_ACCESS (integer): access violation (this has only been added recently and is only available from PECL CVS for now)
YPERR_BADARGS (integer): The function arguments are bad
YPERR_BADDB (integer): YP database is bad
YPERR_BUSY (integer): Database busy
YPERR_DOMAIN (integer): cannot bind to server in this domain
YPERR_KEY (integer): no such key in map
YPERR_MAP (integer): no such map in server's domain
YPERR_NODOM (integer): Local domain name not set
YPERR_NOMORE (integer): No more records in map database
YPERR_PMAP (integer): Can't communicate with portmapper
YPERR_RESRC (integer): resource allocation failure
YPERR_RPC (integer): RPC failure - domain has been unbound
YPERR_YPBIND (integer): Can't communicate with ypbind
YPERR_YPERR (integer): internal yp server or client error
YPERR_YPSERV (integer): Can't communicate with ypserv
YPERR_VERS (integer): YP version mismatch

Table of Contents

yp_all — Traverse the map and call a function on each entry
yp_cat — Return an array containing the entire map
yp_err_string — Returns the error string associated with the given error code
yp_errno — Returns the error code of the previous operation
yp_first — Returns the first key-value pair from the named map
yp_get_default_domain — Fetches the machine's default NIS domain
yp_master — Returns the machine name of the master NIS server for a map
yp_match — Returns the matched line
yp_next — Returns the next key-value pair in the named map
yp_order — Returns the order number for a map