Re: Re: Final RFC for Net_SMPP/Net_SMPP_Client

From: Date: Tue, 19 Jul 2005 23:03:35 +0000
Subject: Re: Re: Final RFC for Net_SMPP/Net_SMPP_Client
References: 1 2 3 4  Groups: php.pear.dev 
Request: Send a blank email to pear-dev+get-38758@lists.php.net to get a copy of this message
Ian Eure wrote:
On Tuesday 19 July 2005 03:06 pm, Pierre-Alain Joye wrote:
On Tue, 19 Jul 2005 14:58:09 -0700 ieure@php.net (Ian Eure) wrote:
On Tuesday 19 July 2005 02:18 pm, Pierre-Alain Joye wrote:
http://pear.php.net/manual/en/standards.naming.php "The PEAR class hierarchy is also reflected in the class name, each level of the hierarchy separated with a single underscore." Can it be more clear?
Yes, it can. "PEAR hierarchy" is not defined, and it's not clear if that means "the category/subcategory structure" or "absolutely every file in a PEAR installation."
PEAR folder hierarchy, please do not with words :)
Well, that's not explicitly stated, and there are enough packages that don't follow it that it's not clear.
Please give a list of these to the QA team and we will see where we can fix it without breaking BC. If you can think of a clearer wording please provide a patch to the doc team.
So you advocate making a project harder to use because it's internal structure (which should never be used directly) doesn't match the PEAR conventions? That seems like a pretty bad trade-off to me.
In what is it harder?
It's harder because you need to read the SMPP specification, then read additional documentation about how Net_SMPP works relative to that document. If Net_SMPP follows the spec closely, you only have to learn a few functions, instead of relearning part of the actual spec.
Underscores in file names that contain package code is a big nono. We have not yet come to angreement though if all classes need to be in their own file. Some developers (including me) only follow this rule for classes that are public (not specifically not abstract classes for example).
According to the CVS logs for the chapter of the manual you reference, that text has been in place since Sep 30th, 2002. However, it was obviously an import of a preexisting document. The Internet Archive's Wayback Machine shows that text was there as early as Feb. 25th, 2002. Both XML_XSLT_Wrapper and HTML_Template_IT post-date that specification by a good 7-8 months.
Afaik Pierre was not the original author of these. Furthermore back then things were handled alot more lax, something which has bitten us sufficiently. We still do mistakes today, just fewer. regards, Lukas

« previous php.pear.dev (#38758) next »