Newsgroups: php.internals
Path: news.php.net
Xref: news.php.net php.internals:71535
Mailing-List: contact internals-help@lists.php.net; run by ezmlm
Received-SPF: pass (pb1.pair.com: domain oracle.com designates 156.151.31.81 as permitted sender)
Message-ID: <52E2EA9B.8020206@oracle.com>
Date: Fri, 24 Jan 2014 14:35:07 -0800
User-Agent: Mozilla/5.0 (X11; Linux i686; rv:24.0) Gecko/20100101 Thunderbird/24.1.0
MIME-Version: 1.0
To: Yasuo Ohgaki <yohgaki@ohgaki.net>,
        "internals@lists.php.net" <internals@lists.php.net>
References: <CAGa2bXbV-mWpDWWSFbsrMSBffp9=fdAbMrJ33f8KHuJiTAzi8w@mail.gmail.com> <CAGa2bXap2YyxdrgGk8ckUyEO=wVG3+qN+gKDz_ZcbMB2QqpWVA@mail.gmail.com>
In-Reply-To: <CAGa2bXap2YyxdrgGk8ckUyEO=wVG3+qN+gKDz_ZcbMB2QqpWVA@mail.gmail.com>
Content-Type: text/plain; charset=UTF-8; format=flowed
Content-Transfer-Encoding: 7bit
Subject: Re: [PHP-DEV] Re: Module function API naming conventions
From: christopher.jones@oracle.com (Christopher Jones)



On 01/24/2014 02:09 PM, Yasuo Ohgaki wrote:
> Hi all,
>
> On Fri, Jan 24, 2014 at 7:41 AM, Yasuo Ohgaki <yohgaki@ohgaki.net> wrote:
>
>> When I try to add dummy save handler functions for session module,
>> I noticed that ps_update() etc has been defined in SOAP module.
>>
>> To avoid collisions, we might better to have following change in
>> CODING_STANDARDS.
>>
>> [yohgaki@dev PHP-5.4]$ git diff
>> diff --git a/CODING_STANDARDS b/CODING_STANDARDS
>> index 7a0562e..4c67a30 100644
>> --- a/CODING_STANDARDS
>> +++ b/CODING_STANDARDS
>> @@ -82,7 +82,7 @@ Exceptions:
>>       library may need to control or free the memory, or when the memory in
>>       question needs to survive between multiple requests.
>>
>> -Naming Conventions
>> +User Functions/Methods Naming Conventions
>>   ------------------
>>
>>   1.  Function names for user-level functions should be enclosed with in
>> @@ -163,6 +163,19 @@ Naming Conventions
>>       'foobar'
>>       'foo_bar'
>>
>> +Internal Function Naming Conventions
>> +----------------------
>> +
>> +1.  Exposed module API must have 'php_modulename_function()' to avoid
>> +    symbol collision. They should be in lowercase, with words
>> +    underscore delimited.
>> +
>> +2.  Main module source file must be named modulename.c.
>> +
>> +3.  Header file that are used by other sources than it's module must be
>> +    named 'php_modulename.h'.
>> +
>> +
>>   Syntax and indentation
>>   ----------------------
>>
>> The rule should be applied to new modules, not existing one.
>> Main source and header is named like this, since ext_skel creates
>> files as above.
>>
>> Any comments?
>>
>
> It seems no comments for this. This is mandatory. IMHO.
> I'll commit this 5.4 and up today.
> If there are corrections/additions, please update.
>
> Regards,
>
> --
> Yasuo Ohgaki
> yohgaki@ohgaki.net
>

Can you make it more explicit with an example to show what an "exposed module API" would
look like?  This doc will be read by people not familiar with PHP internals.

Is there anything in ext/ext_skel or the manual that needs to be kept in sync with your
changes?

Chris

-- 
christopher.jones@oracle.com  http://twitter.com/ghrd
Free PHP & Oracle book:
http://www.oracle.com/technetwork/topics/php/underground-php-oracle-manual-098250.html