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. jean...@au-fil-du.net 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
On Tue, 10 Apr 2012 13:23:45 +0200, Hannes Magnusson hannes.magnus...@gmail.com 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
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 @@ ?xml version=1.0 encoding=utf-8? !-- $Revision$ -- -refentry xml:id='function.ldap-control-paged-result-response' xmlns=http://docbook.org/ns/docbook; +refentry xml:id='function.ldap-control-paged-result-response' +xmlns=http://docbook.org/ns/docbook; +xmlns:xlink=http://www.w3.org/1999/xlink; refnamediv refnameldap_control_paged_result_response/refname - refpurposeExtract paged results control response/refpurpose + refpurposeRetrieve the LDAP pagination cookie/refpurpose /refnamediv refsect1 role=description @@ -15,9 +17,67 @@ methodparam choice=opttypestring/typeparameter role=referencecookie/parameter/methodparam methodparam choice=opttypeint/typeparameter role=referenceestimated/parameter/methodparam /methodsynopsis - warn.undocumented.func; + para + Retrieve the pagination information send by the server. + /para /refsect1 + refsect1 role=parameters + reftitle.parameters; + para + variablelist +varlistentry + termparameterlink/parameter/term + listitem + para + An LDAP link identifier, returned by functionldap_connect/function. + /para + /listitem +/varlistentry +varlistentry + termparameterresult/parameter/term + listitem + para + /para + /listitem +/varlistentry +varlistentry + termparametercookie/parameter/term + listitem + para + An opaque structure sent by the server. + /para + /listitem +/varlistentry +varlistentry + termparameterestimated/parameter/term + listitem + para + The estimated number of entries to retrieve. + /para + /listitem +/varlistentry +/variablelist + /para + /refsect1 + + refsect1 role=returnvalues + reftitle.returnvalues; + para + return.success; + /para + /refsect1 + + refsect1 role=seealso + reftitle.seealso; + para + simplelist +memberfunctionldap_control_paged_result/function/member +memberlink xlink:href=url.rfc;2696RFC2696 : LDAP Control Extension for Simple +Paged Results Manipulation/link/member + /simplelist + /para + /refsect1 /refentry !-- Keep this comment at the end of the file Index: en/reference/ldap/functions/ldap-control-paged-result.xml === --- en/reference/ldap/functions/ldap-control-paged-result.xml (révision 324333) +++ en/reference/ldap/functions/ldap-control-paged-result.xml (copie de travail) @@ -1,22 +1,151 @@ ?xml version=1.0 encoding=utf-8? !-- $Revision$ -- -refentry xml:id='function.ldap-control-paged-result' xmlns=http://docbook.org/ns/docbook; +refentry xml:id='function.ldap-control-paged-result' +xmlns=http://docbook.org/ns/docbook; +xmlns:xlink=http://www.w3.org/1999/xlink; refnamediv refnameldap_control_paged_result/refname - refpurposeInject paged results control/refpurpose + refpurposeSend LDAP pagination control/refpurpose /refnamediv refsect1 role=description reftitle.description; methodsynopsis - typemixed/typemethodnameldap_control_paged_result/methodname + typebool/typemethodnameldap_control_paged_result/methodname methodparamtyperesource/typeparameterlink/parameter/methodparam methodparamtypeint/typeparameterpagesize/parameter/methodparam - methodparam choice=opttypebool/typeparameter role=referenceiscritical/parameter/methodparam - methodparam choice=opttypestring/typeparameter role=referencecookie/parameter/methodparam + methodparam choice=opttypebool/typeparameteriscritical/parameter/methodparam + methodparam choice=opttypestring/typeparametercookie/parameter/methodparam /methodsynopsis - warn.undocumented.func; + para + Enable LDAP pagination by sending the pagination control (page size, cookie...). + /para /refsect1 + refsect1 role=parameters + reftitle.parameters; + para + variablelist +varlistentry + termparameterlink/parameter/term + listitem + para + An LDAP link identifier, returned by functionldap_connect/function. + /para + /listitem +/varlistentry +varlistentry + termparameterpagesize/parameter/term + listitem + para + The number of entries by page. + /para + /listitem +/varlistentry +varlistentry + termparameteriscritical/parameter/term + listitem + para + Indicates whether the pagination is critical of not. + If true and if the server doesn't support
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 phi...@roshambo.org 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 @@ ?xml version=1.0 encoding=utf-8? -!-- $Revision$ -- +!-- $Revision$ -- refentry xml:id='function.ldap-control-paged-result-response' xmlns=http://docbook.org/ns/docbook; refnamediv refnameldap_control_paged_result_response/refname - refpurposeExtract paged results control response/refpurpose + refpurposeRetrieve the pagination cookie./refpurpose /refnamediv - + refsect1 role=description reftitle.description; methodsynopsis @@ -15,9 +15,64 @@ methodparam choice=opttypestring/typeparameter role=referencecookie/parameter/methodparam methodparam choice=opttypeint/typeparameter role=referenceestimated/parameter/methodparam /methodsynopsis - warn.undocumented.func; + paraRetrieve the pagination information send by the server./para /refsect1 + refsect1 role=parameters + reftitle.parameters; + para + variablelist +varlistentry + termparameterlink/parameter/term + listitem + para + An LDAP link identifier, returned by functionldap_connect/function. + /para + /listitem +/varlistentry +varlistentry + termparameterresult/parameter/term + listitem + para + /para + /listitem +/varlistentry +varlistentry + termparametercookie/parameter/term + listitem + para +An opaque structure sent by the server. + /para + /listitem +/varlistentry +varlistentry + termparameterestimated/parameter/term + listitem + para + The estimated number of entries to retrieve. + /para + /listitem +/varlistentry +/variablelist + /para + /refsect1 + + refsect1 role=returnvalues + reftitle.returnvalues; + para + Returns true; or false; on error. + /para + /refsect1 + + refsect1 role=seealso + reftitle.seealso; + para + simplelist +memberfunctionldap_control_paged_result/function/member +memberlinkhttp://www.ietf.org/rfc/rfc2696.txt/link/member + /simplelist + /para + /refsect1 /refentry !-- Keep this comment at the end of the file Index: en/reference/ldap/functions/ldap-control-paged-result.xml === --- en/reference/ldap/functions/ldap-control-paged-result.xml (révision 324333) +++ en/reference/ldap/functions/ldap-control-paged-result.xml (copie de travail) @@ -1,22 +1,147 @@ ?xml version=1.0 encoding=utf-8? -!-- $Revision$ -- +!-- $Revision$ -- refentry xml:id='function.ldap-control-paged-result' xmlns=http://docbook.org/ns/docbook; refnamediv refnameldap_control_paged_result/refname - refpurposeInject paged results control/refpurpose + refpurposeSend LDAP pagination control/refpurpose /refnamediv + refsect1 role=description reftitle.description; methodsynopsis - typemixed/typemethodnameldap_control_paged_result/methodname + typebool/typemethodnameldap_control_paged_result/methodname methodparamtyperesource/typeparameterlink/parameter/methodparam methodparamtypeint/typeparameterpagesize/parameter/methodparam - methodparam choice=opttypebool/typeparameter role=referenceiscritical/parameter/methodparam - methodparam choice=opttypestring/typeparameter role=referencecookie/parameter/methodparam + methodparam choice=opttypebool/typeparameteriscritical/parameter/methodparam + methodparam choice=opttypestring/typeparametercookie/parameter/methodparam /methodsynopsis - warn.undocumented.func; + paraEnable LDAP pagination by sending the pagination control (page size, cookie...)./para /refsect1 + refsect1 role=parameters + reftitle.parameters; + para + variablelist +varlistentry + termparameterlink/parameter/term + listitem + para + An LDAP link identifier, returned by functionldap_connect/function. + /para + /listitem +/varlistentry +varlistentry + termparameterpagesize/parameter/term + listitem + para + The number of entries by page. + /para + /listitem +/varlistentry +varlistentry + termparameteriscritical/parameter/term + listitem + para +Indicates whether the pagination is critical of not. +If true and if the server doesn't support pagination, the search +will return no result. + /para + /listitem +/varlistentry +varlistentry + termparametercookie/parameter/term
