Newsgroups: php.internals
Path: news.php.net
Xref: news.php.net php.internals:48257
Mailing-List: contact internals-help@lists.php.net; run by ezmlm
Received-SPF: pass (pb1.pair.com: domain googlemail.com designates 209.85.161.42 as permitted sender)
DomainKey-Status: bad
DomainKey-Signature: a=rsa-sha1; c=nofws;
        d=googlemail.com; s=gamma;
        h=mime-version:reply-to:in-reply-to:references:from:date:message-id
         :subject:to:cc:content-type:content-transfer-encoding;
        b=tH+LAWBr+jOuC8m8wYv6YjCHuoGT1vgQ26z+y5gr3s4BYwcvfSv7V74EbD+oVjGG/q
         svySEwKNLZpKuOcdVLpqKSNM3CXtS6vSK8m0e3iPL0zrXbpjKgbD8z7VVo2jBkzOfpDW
         uUT3mCWWlrFhDjFHkelkUlOAdn5csuuNxEKPw=
MIME-Version: 1.0
Reply-To: RQuadling@googlemail.com
In-Reply-To: <o2nd3ada2bf1005060055jc8fb8fe6zc8315e059cf716ea@mail.gmail.com>
References: <w2v10845a341005050925z64c7394epe5cd195478395619@mail.gmail.com> 
	<o2nd3ada2bf1005060055jc8fb8fe6zc8315e059cf716ea@mail.gmail.com>
Date: Tue, 11 May 2010 13:33:46 +0100
Message-ID: <AANLkTikAoLN2UWonXhXjbCsTj_2f0yXW7U0v3Zbf2Tr8@mail.gmail.com>
To: Peter Cowburn <petercowburn@gmail.com>
Cc: PHP internals <internals@lists.php.net>, PHP Documentation List <phpdoc@lists.php.net>, 
	=?UTF-8?Q?Marcus_B=C3=B6rger?= <helly@php.net>, 
	Etienne Kneuss <colder@php.net>
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: quoted-printable
Subject: Re: [PHP-DOC] What is the use of the $replacement property in the 
	RegexIterator class.
From: rquadling@googlemail.com (Richard Quadling)

On 6 May 2010 08:55, Peter Cowburn <petercowburn@gmail.com> wrote:
> On 5 May 2010 17:25, Richard Quadling <rquadling@googlemail.com> wrote:
>> Hi.
>>
>> I'm in the process of getting the PHPDoc classes showing the correct
>> inherited properties and methods (public/protected but not private).
>>
>> I picked RecursiveRegexIterator (it has the largest number of
>> xi:includes in the documentation) as a test.
>>
>> Using php --rc I see that the inheritance chain is
>> RecursiveRegexIterator, RegexIterator, FilterIterator and
>> IteratorIterator.
>>
>> The property $replacement is part of RegexIterator.
>>
>> I can see no documentation for this in phpdoc, nor in the Doxygen at
>> http://www.php.net/~helly/php/ext/spl/
>>
>>
>> In all the examples I've made so far, var_dump()-ing the RegexIterator
>> results in a ["replacement"]=3D>NULL
>>
>> Assigning a value to $replacement seems to have no bearing on the output=
.
>
> I believe the intention was to give that property a value which could
> be used with RegexIterator::REPLACE mode but that particular mode has
> not yet been fully implemented. =C2=A0There is a related bug (
> http://bugs.php.net/50579 ) that has not been assigned; I can't say
> what the plan is for if/when the replacement mode will get some
> attention. See also: the PHP implementation of RegexIterator (
> http://svn.php.net/viewvc/php/php-src/trunk/ext/spl/internal/regexiterato=
r.inc?view=3Dmarkup
> ).
>
>>
>> Regards,
>>
>> Richard.
>>
>>
>> --
>> -----
>> Richard Quadling
>> "Standing on the shoulders of some very clever giants!"
>> EE : http://www.experts-exchange.com/M_248814.html
>> EE4Free : http://www.experts-exchange.com/becomeAnExpert.jsp
>> Zend Certified Engineer : http://zend.com/zce.php?c=3DZEND002498&r=3D213=
474731
>> ZOPA : http://uk.zopa.com/member/RQuadling
>>
>

So, this should be documented as what?

As we don't document the future, I think this property should be
omitted from the RegexIterator documentation until such time the
property is useful.

Basically, leave it as is.

Yes?

--=20
-----
Richard Quadling
"Standing on the shoulders of some very clever giants!"
EE : http://www.experts-exchange.com/M_248814.html
EE4Free : http://www.experts-exchange.com/becomeAnExpert.jsp
Zend Certified Engineer : http://zend.com/zce.php?c=3DZEND002498&r=3D213474=
731
ZOPA : http://uk.zopa.com/member/RQuadling