From d0df1d240c4df6b073d6f2595f402f97e4e10a72 Mon Sep 17 00:00:00 2001 From: Mehdi Achour Date: Mon, 5 Feb 2007 03:11:27 +0000 Subject: [PATCH] ref.nis: Switch to new doc style # Also move constants description in constants.xml git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@229013 c90b9560-bf6c-de11-be94-00142212c4b1 --- reference/nis/constants.xml | 26 +++---- reference/nis/functions/yp-all.xml | 46 ++++++++++-- reference/nis/functions/yp-cat.xml | 43 ++++++++++-- reference/nis/functions/yp-err-string.xml | 50 ++++++++++--- reference/nis/functions/yp-errno.xml | 54 ++++++-------- reference/nis/functions/yp-first.xml | 59 +++++++++++++--- .../nis/functions/yp-get-default-domain.xml | 33 ++++++--- reference/nis/functions/yp-master.xml | 55 +++++++++++++-- reference/nis/functions/yp-match.xml | 70 ++++++++++++++++--- reference/nis/functions/yp-next.xml | 63 ++++++++++++++--- reference/nis/functions/yp-order.xml | 53 ++++++++++++-- 11 files changed, 436 insertions(+), 116 deletions(-) diff --git a/reference/nis/constants.xml b/reference/nis/constants.xml index 078ee6513d..94cc13fb60 100644 --- a/reference/nis/constants.xml +++ b/reference/nis/constants.xml @@ -1,5 +1,5 @@ - +
&reftitle.constants; &extension.constants; @@ -11,7 +11,7 @@ - + The function arguments are bad @@ -22,7 +22,7 @@ - + YP database is bad @@ -33,7 +33,7 @@ - + Database busy @@ -44,7 +44,7 @@ - + 4 - no such map in server's domain @@ -55,7 +55,7 @@ - + 5 - no such key in map @@ -77,7 +77,7 @@ - + Local domain name not set @@ -88,7 +88,7 @@ - + No more records in map database @@ -99,7 +99,7 @@ - + Can't communicate with portmapper @@ -121,7 +121,7 @@ - + RPC failure - domain has been unbound @@ -132,7 +132,7 @@ - + Can't communicate with ypbind @@ -154,7 +154,7 @@ - + Can't communicate with ypserv @@ -165,7 +165,7 @@ - + YP version mismatch diff --git a/reference/nis/functions/yp-all.xml b/reference/nis/functions/yp-all.xml index 7e1dc40faa..922a0b1c0d 100644 --- a/reference/nis/functions/yp-all.xml +++ b/reference/nis/functions/yp-all.xml @@ -1,13 +1,13 @@ - - + yp_all Traverse the map and call a function on each entry - - Description + + + &reftitle.description; voidyp_all stringdomain @@ -18,6 +18,44 @@ &warn.undocumented.func; + + + &reftitle.parameters; + + + + domain + + + The NIS domain name. + + + + + map + + + The NIS map. + + + + + callback + + + + + + + + + + + &reftitle.returnvalues; + + &return.void; + + - + yp_cat Return an array containing the entire map - - Description + + + &reftitle.description; arrayyp_cat stringdomain stringmap - yp_cat returns all map entries as an array with the - maps key values as array indices and the maps entries as array data. + Returns all map entries. + + + + + &reftitle.parameters; + + + + domain + + + The NIS domain name. + + + + + map + + + The NIS map. + + + + + + + + + &reftitle.returnvalues; + + Returns an array of all map entries, the maps key values as array indices + and the maps entries as array data. diff --git a/reference/nis/functions/yp-err-string.xml b/reference/nis/functions/yp-err-string.xml index b8a4f51e9f..c4744b51b9 100644 --- a/reference/nis/functions/yp-err-string.xml +++ b/reference/nis/functions/yp-err-string.xml @@ -1,36 +1,68 @@ - - + yp_err_string Returns the error string associated with the given error code - - Description + + + &reftitle.description; stringyp_err_string interrorcode - yp_err_string returns the error message - associated with the given error code. Useful to indicate what - exactly went wrong. + Returns the error message associated with the given error code. + Useful to indicate what exactly went wrong. + + + + &reftitle.parameters; + + + + errorcode + + + The error code. + + + + + + + + + &reftitle.returnvalues; + + Returns the error message, as a string. + + + + + &reftitle.examples; Example for NIS errors ]]> + + + + &reftitle.seealso; - See also yp_errno. + + yp_errno + diff --git a/reference/nis/functions/yp-errno.xml b/reference/nis/functions/yp-errno.xml index ee889de0b5..497ee898da 100644 --- a/reference/nis/functions/yp-errno.xml +++ b/reference/nis/functions/yp-errno.xml @@ -1,48 +1,38 @@ - - + yp_errno Returns the error code of the previous operation - - Description + + + &reftitle.description; intyp_errno - yp_errno returns the error code of the - previous operation. - - - Possible errors are: - - - - 1 args to function are bad - 2 RPC failure - domain has been unbound - 3 can't bind to server on this domain - 4 no such map in server's domain - 5 no such key in map - 6 internal yp server or client error - 7 resource allocation failure - 8 no more records in map database - 9 can't communicate with portmapper - 10 can't communicate with ypbind - 11 can't communicate with ypserv - 12 local domain name not set - 13 yp database is bad - 14 yp version mismatch - 15 access violation - 16 database busy - - - - See also yp_err_string. + Returns the error code of the previous operation. + + + &reftitle.returnvalues; + + Returns one of the YPERR_XXX error constants. + + + + + &reftitle.seealso; + + + yp_err_string + + + + - + yp_first Returns the first key-value pair from the named map - - Description + + + &reftitle.description; arrayyp_first stringdomain stringmap - yp_first returns the first key-value - pair from the named map in the named domain, otherwise &false;. + Gets the first key-value pair from the named map + in the named domain. + + + + &reftitle.parameters; + + + + domain + + + The NIS domain name. + + + + + map + + + The NIS map. + + + + + + + + + &reftitle.returnvalues; + + Returns the first key-value pair as an array on success, or &false; on + errors. + + + + + &reftitle.examples; Example for the NIS first @@ -34,11 +70,18 @@ echo "First entry in this map has key " . $key . " and value " . $value; + + + + &reftitle.seealso; - See also yp_next and - yp_get_default_domain. + + yp_next + yp_get_default_domain + + - + yp_get_default_domain Fetches the machine's default NIS domain - - Description + + + &reftitle.description; stringyp_get_default_domain - yp_get_default_domain returns the default - domain of the node or &false;. Can be used as the domain parameter - for successive NIS calls. + Returns the default domain of the node. Can be used as the domain + parameter for successive NIS calls. - A NIS domain can be described a group of NIS maps. Every host - that needs to look up information binds itself to a certain - domain. Refer to the documents mentioned at the beginning for - more detailed information. + A NIS domain can be described a group of NIS maps. Every host that needs + to look up information binds itself to a certain domain. Refer to the + documents mentioned at the beginning for more detailed information. + + + + &reftitle.returnvalues; + + Returns the default domain of the node or &false;. Can be used as the + domain parameter for successive NIS calls. + + + + + &reftitle.examples; Example for the default domain @@ -37,6 +47,7 @@ echo "Default NIS domain is: " . $domain; + - + yp_master Returns the machine name of the master NIS server for a map - - Description + + + &reftitle.description; stringyp_master stringdomain stringmap - yp_master returns the machine name of - the master NIS server for a map. + Returns the machine name of the master NIS server for a + map. + + + + &reftitle.parameters; + + + + domain + + + The NIS domain name. + + + + + map + + + The NIS map. + + + + + + + + + &reftitle.returnvalues; + + + + + + &reftitle.examples; Example for the NIS master @@ -30,10 +64,17 @@ echo "Master for this map is: " . $master; + + + + &reftitle.seealso; - See also yp_get_default_domain. + + yp_get_default_domain + + - + yp_match Returns the matched line - - Description + + + &reftitle.description; stringyp_match stringdomain @@ -15,9 +15,52 @@ stringkey - yp_match returns the value associated with - the passed key out of the specified map or &false;. This key must - be exact. + Returns the value associated with the passed key + out of the specified map. + + + + + &reftitle.parameters; + + + + domain + + + The NIS domain name. + + + + + map + + + The NIS map. + + + + + key + + + This key must be exact. + + + + + + + + + &reftitle.returnvalues; + + Returns the value, or &false; on errors. + + + + + &reftitle.examples; Example for NIS match @@ -29,9 +72,7 @@ echo "Matched entry is: " . $entry; ?> ]]> - - The above code will produce : - + &example.outputs.similar; + + + + &reftitle.seealso; - See also yp_get_default_domain. + + yp_get_default_domain + + - + yp_next Returns the next key-value pair in the named map - - Description + + + &reftitle.description; arrayyp_next stringdomain @@ -15,9 +15,49 @@ stringkey - yp_next returns the next key-value pair in - the named map after the specified key or &false;. + Returns the next key-value pair in the named map + after the specified key. + + + + &reftitle.parameters; + + + + domain + + + + + + + map + + + + + + + key + + + + + + + + + + + &reftitle.returnvalues; + + Returns the next key-value pair as an array, or &false; on errors. + + + + + &reftitle.examples; Example for NIS next @@ -40,11 +80,18 @@ echo "The next entry after joe has key " . $key + + + + &reftitle.seealso; - See also yp_first and - yp_get_default_domain. + + yp_first + yp_get_default_domain + + - + yp_order Returns the order number for a map - - Description + + + &reftitle.description; intyp_order stringdomain stringmap - yp_order returns the order number for a map - or &false;. + Gets the order number for a map. + + + + &reftitle.parameters; + + + + domain + + + + + + + map + + + + + + + + + + + &reftitle.returnvalues; + + Returns the order number for a map or &false; on error. + + + + + &reftitle.examples; Example for the NIS order @@ -30,10 +62,17 @@ + + + + &reftitle.seealso; - See also yp_get_default_domain. + + yp_get_default_domain + +