{"id":1525,"date":"2018-01-19T19:22:56","date_gmt":"2018-01-19T19:22:56","guid":{"rendered":"http:\/\/goofy-trucks.flywheelsites.com\/best-practices-php-coding-style-page-3\/"},"modified":"2018-01-19T19:24:51","modified_gmt":"2018-01-19T19:24:51","slug":"best-practices-php-coding-style-page-3","status":"publish","type":"post","link":"https:\/\/phpbuilder.com\/best-practices-php-coding-style-page-3\/","title":{"rendered":"Best Practices: PHP Coding Style Page 3"},"content":{"rendered":"
\n
\n
By Tim Perdue<\/div>\n
on January 3, 2001<\/div>\n<\/p><\/div>\n
\n

Function Calls<\/h2>\n
\nFunctions should be called with no space between between the function name and
\nthe parentheses. Spaces between params and operators are encouraged.<\/div>\n
\n
\n$var = myFunction($x, $y);\n<\/pre>\n<\/div>\n
Functions<\/h2>\n
\nFunction calls are braced differently than conditional expressions. This is a
\ncase where I’ll have to change my personal coding style in order to be kosher,
\nbut I guess it needs to be done.<\/div>\n
\n
\nfunction myFunction($var1, $var2 = '')\n{\n\t\/\/indent all code inside here\n\treturn $result;\n}   \n<\/pre>\n<\/div>\n
\nNotice again there is no space between the function name and the parens, and that
\nthe params are nicely spaced. All your code inside the function will be at least
\n4 spaces indented.<\/div>\n
\nAnother important principle when coding functions is that they should always
\nreturn instead of print directly<\/b>. Remember, if you print directly inside
\nyour function call, whomever calls your function cannot capture its output using a
\nvariable.<\/div>\n
Comments<\/h2>\n
\nBorrowing – almost in its entirety – from the JavaDoc spec, PEAR strongly encourages
\nthe use of PHPDoc<\/a> comment style. JavaDoc is rather
\nclever because you format your
\ncode comments in such a manner that they can be parsed by a doc-generating tool,
\nessentially creating “self commenting” code. You can then view the resulting docs
\nusing a web browser.<\/div>\n
\nAs a reformed java programmer myself, I really like this standard and am trying to
\ngo back through my code and add PHPDoc comments.<\/div>\n
\n
\n\/**\n *\tshort description of function\n *\n *\tOptional more detailed description.\n *\n *\t@param $paramName - type - brief purpose\n *\t@param ...\n *\t...\n *\t@return type and description\n *\/\n<\/pre>\n<\/div>\n
Including Code<\/h2>\n
\nPHP4 introduced a pretty useful new feature: include_once(). I’ve seen a lot
\nof questions on the mailing lists and discussion boards caused by people including
\nthe same files in multiple places. This can cause conflicts when the included files
\ninclude functions, which can be defined only once per script.<\/div>\n
\nThe simple solution is to replace all your include() and require() calls with
\ncorresponding include_once() and require_once(). Both use the same file list, so a
\nfile included with require_once() will not be later included with an include_once()
\ncall. (technically, require_once and include_once are “operators”, not “functions”
\nso parens are not necessary).<\/div>\n
\nI never use include, or any of these *_once functions. IMHO, well-designed applications
\ninclude files in one place that is easy to maintain and keep track of. Others will disagree
\nand say that each included file should require_once() every file that it depends on.
\nThis seems like extra overhead and maintenance headaches to me personally.
\nEither way, the days of conflicting includes are probably over.<\/div>\n<\/div>\n
<\/p>\n
\n
\u00ab Previous Page<\/a><\/div>\n
1<\/a> <\/div>\n
| <\/div>\n
2<\/a> <\/div>\n
| <\/div>\n
3<\/div>\n
| <\/div>\n
4<\/a> <\/div>\n
Next Page \u00bb<\/a><\/div>\n<\/div><\/div>\n","protected":false},"excerpt":{"rendered":"
By Tim Perdue on January 3, 2001 Function Calls Functions should be called with no space between between the function name and the parentheses. Spaces between params and operators are encouraged. $var = myFunction($x, $y); Functions Function calls are braced differently than conditional expressions. This is a case where I’ll… <\/a><\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[3],"tags":[],"class_list":["post-1525","post","type-post","status-publish","format-standard","hentry","category-tutorials"],"_links":{"self":[{"href":"https:\/\/phpbuilder.com\/wp-json\/wp\/v2\/posts\/1525","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/phpbuilder.com\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/phpbuilder.com\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/phpbuilder.com\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/phpbuilder.com\/wp-json\/wp\/v2\/comments?post=1525"}],"version-history":[{"count":1,"href":"https:\/\/phpbuilder.com\/wp-json\/wp\/v2\/posts\/1525\/revisions"}],"predecessor-version":[{"id":3358,"href":"https:\/\/phpbuilder.com\/wp-json\/wp\/v2\/posts\/1525\/revisions\/3358"}],"wp:attachment":[{"href":"https:\/\/phpbuilder.com\/wp-json\/wp\/v2\/media?parent=1525"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/phpbuilder.com\/wp-json\/wp\/v2\/categories?post=1525"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/phpbuilder.com\/wp-json\/wp\/v2\/tags?post=1525"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}