Re: [PHP-DOC] Request for review : ldap_control_paged_result & ldap_control_paged_result_response
On Tue, 10 Apr 2012 13:23:45 +0200, Hannes Magnusson wrote: >> >> Last week, I tried to ask for an account on >> http://uk3.php.net/git-php.php with initial karma on phpdoc >> >> But I haven't seen any mail on phpdoc or internals, am I missing >> something ? > > > No idea what happened to the mail, but I do see the request on master. > I'll approve it and give you karma if few minutes. > > -Hannes Thanks, You can cancel the other request on jeansebastien. -- Jean-Sébastien H. au-fil-du.net
Re: [PHP-DOC] Request for review : ldap_control_paged_result & ldap_control_paged_result_response
On Mon, 26 Mar 2012 22:28:06 +0200, "Jean-Sébastien H." wrote: > Hi, > > Le 22/03/2012 10:10, Jean-Sébastien H. a écrit : >> Thanks for your feedback, I'll fix my patch soon. > In attachment, the new patch. > > Regards, Hi, Last week, I tried to ask for an account on http://uk3.php.net/git-php.php with initial karma on phpdoc But I haven't seen any mail on phpdoc or internals, am I missing something ? Regards, -- Jean-Sébastien H. au-fil-du.net
Re: [PHP-DOC] Request for review : ldap_control_paged_result & ldap_control_paged_result_response
Hi, Le 22/03/2012 10:10, Jean-Sébastien H. a écrit : Thanks for your feedback, I'll fix my patch soon. In attachment, the new patch. Regards, -- Jean-Sébastien H. au-fil-du.net Index: en/reference/ldap/functions/ldap-control-paged-result-response.xml === --- en/reference/ldap/functions/ldap-control-paged-result-response.xml (révision 324333) +++ en/reference/ldap/functions/ldap-control-paged-result-response.xml (copie de travail) @@ -1,9 +1,11 @@ -http://docbook.org/ns/docbook";> +http://docbook.org/ns/docbook"; +xmlns:xlink="http://www.w3.org/1999/xlink";> ldap_control_paged_result_response - Extract paged results control response + Retrieve the LDAP pagination cookie @@ -15,9 +17,67 @@ stringcookie intestimated - &warn.undocumented.func; + + Retrieve the pagination information send by the server. + + + &reftitle.parameters; + + + + link + + + An LDAP link identifier, returned by ldap_connect. + + + + + result + + + + + + + cookie + + + An opaque structure sent by the server. + + + + + estimated + + + The estimated number of entries to retrieve. + + + + + + + + + &reftitle.returnvalues; + + &return.success; + + + + + &reftitle.seealso; + + +ldap_control_paged_result +RFC2696 : LDAP Control Extension for Simple +Paged Results Manipulation + + + -http://docbook.org/ns/docbook";> +http://docbook.org/ns/docbook"; +xmlns:xlink="http://www.w3.org/1999/xlink";> ldap_control_paged_result - Inject paged results control + Send LDAP pagination control &reftitle.description; - mixedldap_control_paged_result + boolldap_control_paged_result resourcelink intpagesize - booliscritical - stringcookie + booliscritical + stringcookie - &warn.undocumented.func; + + Enable LDAP pagination by sending the pagination control (page size, cookie...). + + + &reftitle.parameters; + + + + link + + + An LDAP link identifier, returned by ldap_connect. + + + + + pagesize + + + The number of entries by page. + + + + + iscritical + + + Indicates whether the pagination is critical of not. + If true and if the server doesn't support pagination, the search + will return no result. + + + + + cookie + + + An opaque structure sent by the server + (ldap_control_paged_result_response). + + + + + + + + + &reftitle.returnvalues; + + &return.success; + + + + + &reftitle.examples; + + The example below show the retrieval of the first page of a search paginated + with one entry by page. + +LDAP pagination + + + + + + + The example below show the retrieval of all the result paginated with 100 + entries by page. + +LDAP pagination + + + + + + + + + &reftitle.seealso; + + +ldap_control_paged_result_response +RFC2696 : LDAP Control Extension for Simple +Paged Results Manipulation + + +
Re: [PHP-DOC] Request for review : ldap_control_paged_result & ldap_control_paged_result_response
Hello Philip, On Tue, 20 Mar 2012 20:58:09 -0700, Philip Olson wrote: > > I'm not all that familiar with LDAP but know the documentation there > is lacking. It'd be most wonderful if you chose to champion those docs. > Or, simply offering these patches is perfectly fine too. I sent this patch as the co-dev of those functions but I can take a look to some missing docs. > I'm going to > assume you want to get involved with the PHP documentation, in which > you'd want someone to nitpick by finding every tiny little problem with > your patches. I can do that! :) So here goes: > Thanks for your feedback, I'll fix my patch soon. Regards, -- Jean-Sébastien H. au-fil-du.net
[PHP-DOC] Request for review : ldap_control_paged_result & ldap_control_paged_result_response
Hi, Could you review the attached patch adding documention to the function ldap_control_paged_result & ldap_control_paged_result_response. Regards, NB : I'm not very familiar with doc process so correct me if I'm wrong. -- Jean-Sébastien H. au-fil-du.net Index: en/reference/ldap/functions/ldap-control-paged-result-response.xml === --- en/reference/ldap/functions/ldap-control-paged-result-response.xml (révision 324333) +++ en/reference/ldap/functions/ldap-control-paged-result-response.xml (copie de travail) @@ -1,11 +1,11 @@ - + http://docbook.org/ns/docbook";> ldap_control_paged_result_response - Extract paged results control response + Retrieve the pagination cookie. - + &reftitle.description; @@ -15,9 +15,64 @@ stringcookie intestimated - &warn.undocumented.func; + Retrieve the pagination information send by the server. + + &reftitle.parameters; + + + + link + + + An LDAP link identifier, returned by ldap_connect. + + + + + result + + + + + + + cookie + + +An opaque structure sent by the server. + + + + + estimated + + + The estimated number of entries to retrieve. + + + + + + + + + &reftitle.returnvalues; + + Returns &true; or &false; on error. + + + + + &reftitle.seealso; + + +ldap_control_paged_result +http://www.ietf.org/rfc/rfc2696.txt + + + + http://docbook.org/ns/docbook";> ldap_control_paged_result - Inject paged results control + Send LDAP pagination control + &reftitle.description; - mixedldap_control_paged_result + boolldap_control_paged_result resourcelink intpagesize - booliscritical - stringcookie + booliscritical + stringcookie - &warn.undocumented.func; + Enable LDAP pagination by sending the pagination control (page size, cookie...). + + &reftitle.parameters; + + + + link + + + An LDAP link identifier, returned by ldap_connect. + + + + + pagesize + + + The number of entries by page. + + + + + iscritical + + +Indicates whether the pagination is critical of not. +If true and if the server doesn't support pagination, the search +will return no result. + + + + + cookie + + + An opaque structure sent by the server (ldap_control_paged_result_response). + + + + + + + + + &reftitle.returnvalues; + + Returns true or &false; on error. + + + + + &reftitle.examples; + + The example below show the retrieval of the first page of a search paginated with one entry by page. + +LDAP pagination + + + + + + The example below show the retrieval of all the result paginated with 100 entries by page. + +LDAP pagination + + + + + + + + &reftitle.seealso; + + +ldap_control_paged_result_response +http://www.ietf.org/rfc/rfc2696.txt + + +
