# PHP OO naming conventions - Thread: https://externals.io/message/1527 - Original archive: https://news-web.php.net/php.internals/1527 - Started by Lukas Smith on 2003-05-15T11:59:38+00:00 - Messages: 9 - Reply by email to internals@lists.php.net - More for agents: search with https://externals.io/search.md?q={query} · JSON API at https://externals.io/api · documentation at https://externals.io/llms.txt --- ## #1528 — Sterling Hughes — 2003-05-15T11:50:04+00:00 URL: https://externals.io/message/1527#1528 · In reply to: #1527 I agree with lukas - I think our methods should follow studlyCap naming conventions. -Sterling > Hi, > > *Disclaimer* > I am only talking about the API that is exposed to the user and not > about any CS that don't relate to this (brackets, indenting etc.). > *Disclaimer* > > As PHP development is beginning to expose more and more functionality > through an OO interface we should address the CS for that API now. > > I think it would be wise not to use the current PHP naming conventions > as they are not that well fit for the OO syntax we have in PHP. > > A pretty lame example to illustrate what I mean: > $foo->get_bar(); > $foo->get->bar(); > > Also it would be useful for the user to easily differentiate the > different interfaces from each other because otherwise there maybe > confusions about different parameter handling in functions/methods due > to the nature that the OO interface will require different parameters > than the functional counterpart in a lot of cases. > > Another constructed example: > execute_query($connection, $query, $param); > $foo->execute_query($query, $param); > > This should also make life easier for syntax highlighter ... > > I would therefore propose to use studlyCaps as the CS for PHP OO APIs. > > Current: $foo->execute_query($query, $param); > New: $foo->executeQuery($query, $param); > > This CS is already known to people in the PHP world (or atleast a > considerable amount) in the form of the PEAR CS. This would also be > great for PEAR as then it would become possible for them to just extend > these classes instead of having to wrap all methods to fit the PEAR CS. > > FYI: PEAR is also working on defining some standard method names. Like > the common issue of close vs. disconnect etc. This might be a good > opportunity to maybe also start off "clean" for PHP OO API's in that > regard. > > FYI: I was told that there are no technical reasons that would make it a > big deal to have different function and method names provided by one > extension. > > Regards, > Lukas Smith > smith@backendmedia.com > _______________________________ > BackendMedia > www.backendmedia.com > berlin@backendmedia.com > > Linn Zwoch Smith GbR > Pariser Str. 44 > D-10707 Berlin > > Tel +49 30 83 22 50 00 > Fax +49 30 83 22 50 07 -- "I can't give you a brain, so I'll give you a diploma" - The Great Oz, The Wizard of Oz --- ## #1527 — Lukas Smith — 2003-05-15T11:59:38+00:00 URL: https://externals.io/message/1527#1527 Hi, *Disclaimer* I am only talking about the API that is exposed to the user and not about any CS that don't relate to this (brackets, indenting etc.). *Disclaimer* As PHP development is beginning to expose more and more functionality through an OO interface we should address the CS for that API now. I think it would be wise not to use the current PHP naming conventions as they are not that well fit for the OO syntax we have in PHP. A pretty lame example to illustrate what I mean: $foo->get_bar(); $foo->get->bar(); Also it would be useful for the user to easily differentiate the different interfaces from each other because otherwise there maybe confusions about different parameter handling in functions/methods due to the nature that the OO interface will require different parameters than the functional counterpart in a lot of cases. Another constructed example: execute_query($connection, $query, $param); $foo->execute_query($query, $param); This should also make life easier for syntax highlighter ... I would therefore propose to use studlyCaps as the CS for PHP OO APIs. Current: $foo->execute_query($query, $param); New: $foo->executeQuery($query, $param); This CS is already known to people in the PHP world (or atleast a considerable amount) in the form of the PEAR CS. This would also be great for PEAR as then it would become possible for them to just extend these classes instead of having to wrap all methods to fit the PEAR CS. FYI: PEAR is also working on defining some standard method names. Like the common issue of close vs. disconnect etc. This might be a good opportunity to maybe also start off "clean" for PHP OO API's in that regard. FYI: I was told that there are no technical reasons that would make it a big deal to have different function and method names provided by one extension. Regards, Lukas Smith smith@backendmedia.com _______________________________ BackendMedia www.backendmedia.com berlin@backendmedia.com Linn Zwoch Smith GbR Pariser Str. 44 D-10707 Berlin Tel +49 30 83 22 50 00 Fax +49 30 83 22 50 07 --- ## #1529 — Derick Rethans — 2003-05-15T13:21:08+00:00 URL: https://externals.io/message/1527#1529 · In reply to: #1528 > I agree with lukas - I think our methods should follow studlyCap naming > conventions. same here, not because I like them, but because it's a standard. (I would hate to see this happen for normal functions though). Derick -- "my other box is your windows PC" ------------------------------------------------------------------------- Derick Rethans http://derickrethans.nl/ PHP Magazine - PHP Magazine for Professionals http://php-mag.net/ --- ## #1535 — Per Lundberg — 2003-05-15T16:04:27+00:00 URL: https://externals.io/message/1527#1535 · In reply to: #1528 > I agree with lukas - I think our methods should follow studlyCap naming > conventions. The only problem is it looks so ugly... :-) Aren't there anyone here that prefers the CapitalizeAllWords() approach? -- Best regards, Per Lundberg / Capio ApS Phone: +46-18-4186040 Fax: +46-18-4186049 Web: http://www.nobolt.com --- ## #1536 — l0t3k — 2003-05-15T16:09:59+00:00 URL: https://externals.io/message/1527#1536 · In reply to: #1528 +1 for studlyCaps. i'd have to rewrite a sh*tload of code otherwise "Sterling Hughes" wrote in message news:1052999404.27984.127.camel@hasele... > I agree with lukas - I think our methods should follow studlyCap naming > conventions. > > -Sterling --- ## #1538 — Derick Rethans — 2003-05-15T16:32:58+00:00 URL: https://externals.io/message/1527#1538 · In reply to: #1536 > +1 for studlyCaps. i'd have to rewrite a sh*tload of code otherwise You wouldnt have to rewrite anything, we're just suggesting to use the studlyCaps naming scheme for class methods that are exported by PHP extensions. Derick -- "my other box is your windows PC" ------------------------------------------------------------------------- Derick Rethans http://derickrethans.nl/ PHP Magazine - PHP Magazine for Professionals http://php-mag.net/ --- ## #1539 — Alan Knowles — 2003-05-15T16:51:04+00:00 URL: https://externals.io/message/1527#1539 · In reply to: #1538 well actually their going to be exported as studlycaps as methods arent case sensative :) = but thats a whole different issue :) Regards Alan Derick Rethans wrote: > > > > > > […] > >You wouldnt have to rewrite anything, we're just suggesting to use the >studlyCaps naming scheme for class methods that are exported by PHP >extensions. > >Derick > > > -- Can you help out? Need Consulting Services or Know of a Job? http://www.akbkhome.com --- ## #1540 — Derick Rethans — 2003-05-15T17:22:24+00:00 URL: https://externals.io/message/1527#1540 · In reply to: #1539 > well actually their going to be exported as studlycaps as methods arent > case sensative :) = but thats a whole different issue :) No put no oil on tha fire mate :) Derick -- "my other box is your windows PC" ------------------------------------------------------------------------- Derick Rethans http://derickrethans.nl/ PHP Magazine - PHP Magazine for Professionals http://php-mag.net/ --- ## #1541 — Maxim Maletsky — 2003-05-15T17:46:36+00:00 URL: https://externals.io/message/1527#1541 · In reply to: #1527 On Thu, 15 May 2003 13:59:38 +0200 "Lukas Smith" wrote: > I would therefore propose to use studlyCaps as the CS for PHP OO APIs. > > Current: $foo->execute_query($query, $param); > New: $foo->executeQuery($query, $param); I personally don't really like studyCaps as any naming convention in PHP for two reasons: 1. PHP rarely uses it 2. Could be confusing for user just my own .02 cents -- Maxim Maletsky maxim@php.net