Thread: [Phpwebsite-developers] Re: Coding Standards

SourceForge Headquarters 225 Broadway Suite 1600 San Diego, CA 92101 +1 (858) 422-6466

I think we should code according to pear standards.

__________________________________________________
FREE voicemail, email, and fax...all in one place.
Sign Up Now! http://www.onebox.com

<BinaryCloud.com and many others believe that there should not be ANY
echo or
print statements.>
I think this is a given now... and your excerpt serves as a nice guideline...
so what's specific structure to model phpWS, openACS looks quite clean
although haven't really taken too coherent a look... guess i'd like to
see the proposed current roadmap.
Has anyone looked at MMBase http://www.mmbase.org/, i've only peeked...
nice dev organization, tho.  

__________________________________________________
FREE voicemail, email, and fax...all in one place.
Sign Up Now! http://www.onebox.com

> <BinaryCloud.com and many others believe that there should not be ANY
> echo or
> print statements.>
> I think this is a given now... and your excerpt serves as a nice
> guideline...

Agreed - the Road Map will include coding standards - the PEAR/BinaryCloud
combo is basically it.

> so what's specific structure to model phpWS, openACS looks
> quite clean although haven't really taken too coherent a look... guess
> i'd like to see the proposed current roadmap.
> Has anyone looked at MMBase http://www.mmbase.org/, i've only peeked...
> nice dev organization, tho.

A detailed "structural" model for the re-write will follow the Road Map.  We
will be asking for help in developing this, so start thinking about this
now.  I like the dev model for MMBase as well, and once we have volunteers
for various components, we will assign lead developers to each.  Very
efficient, IMHO.

Brian Brown
phpWebSite Project Manager

--
Brian W. Brown
Internet Systems Architect, ESS
Student Development
Room 269, John Thomas Hall
Appalachian State University
Boone, NC 28608

vox: 828-262-7124
fax: 828-262-2585

WDS,

Clayton's port of the Ars Digita Community System access control list can be
found at the my URL below.  As he said, it is not a functional port, but
it's better than reading the original TCL code.  Thanks Clayton !!!
Look at it to get an idea of how we could provide fine granularity in
phpWS's permissions.

http://www.datadx.com/phpwebsite/

I will review mmbase this afternoon.

--Todd

Todd:

> Clayton's port of the Ars Digita Community System access control list
> can be found at the my URL below.  As he said, it is not a functional
> port, but it's better than reading the original TCL code.  Thanks
> Clayton !!! Look at it to get an idea of how we could provide fine
> granularity in phpWS's permissions.
> 
> http://www.datadx.com/phpwebsite/

Can you post these so that we can DL/view the code? 

Brian
-- 
Brian W. Brown
Internet Systems Architect, ESS
Student Development
Room 269, John Thomas Hall
Appalachian State University  
Boone, NC 28608

vox: 828-262-7124
fax: 828-262-2585

> Can you post these so that we can DL/view the code?
>
> http://www.datadx.com/phpwebsite/

Sorry, my mistake.  I forgot Apache won't let you DL *.php files (duh).
Apache was doing its job, so I can't complain.  The files have been renamed
*.php.txt

--Todd

also, when it comes to big scale content management system check out 
http://www.typo3.com
the system is done with php. i installed it a couple of months ago and i 
was suitably impressed (runs on virtual hosting without problems). it has 
somewhat of a learning curve though with its own scripting language for the 
template-engine... plus its quite a complex system.

paivi

> I think we should code according to PEAR standards.

I agree, but there are some things that aren't addressed in PEAR (at least
yet).  Most of the HTML markup is in echo statements now.  I that what we
want to continue to do?

BinaryCloud.com and many others believe that there should not be ANY echo or
print statements.  This from BinaryCloud:

---Markup
--Global Rules
-Do not use echo or print for markup. Using echo & print obscures the
markup, is time consuming to edit, is error prone, and will impede the
progress of any project where non-php authors are involved.
-Do not include complex logic in template files. Conditionals are the most
complex logic allowed in templates. If you need to loop through an array, do
it in the module, and call the template function recursively.
-Declare all of your variables at the top, right under the function. Don't
get globals, etc inside the code. In other words, do all of your setup at
the top of the file.
-It is nice if comments are wrapped to 80 chars, you'll probably get in the
habit anyway - but it is not necessary. Tags cannot and should not be
wrapped to 80 chars. Note that this standard applies to _all_ markup: html,
wml, xml, etc.
-This is a complex example, because this would be used as a 'master'
template for a site. Template files associated with modules should be
simple, and light on php code. They should not scare people who only know
html.
-Note the conspicuous absence of any comment header for the template
function. Master templates must all use $tmpl_obj to get their list of
modules, and some other miscellaneous values like page title, etc. It is not
necessary to document this in every file, and adds quite a lot of redundant
comments to the phtml masters.
-Your module phtml files should be so simple and light on php logic that
commenting them seems like a waste of time. (and is)
-Every file must contain a header
-You must place an html comment at the top & bottom of the html with the
path to the file. (see format below)
-Use html comments _ONLY_ when you are printing html. If the comment is
about PHP code, use PHP comments. The purpose of the html comments is to
allow html authors to locate code embedded in complex pages, so they can fix
it easily. Diagnostic information is the only exception.

Comments anyone, anyone...

--Todd

Thread: [Phpwebsite-developers] Re: Coding Standards

phpwebsite-developers