PHP development style questions

EricHagen

Hey everyone.

I'm working on a fairly large project (about 70% done, running about 4000 lines right now). I've done it entirely myself so far, but I recently recruited a friend to help out.

Now he's taking issue with how I have my functions organized. It's not so much that I care whether he or I is right. I care more about making the work easier in the future and making it look good. heh... But seriously, I want others to consider it easy to work with, but I also want it to be secure.

The project is a message board, similar to phpBB. It is partially that I have some unique requirements and partially that i wanted to "see if I could" do it by myself.

Now that I know that I can do it, I'm sensing that we're close to the final product.

Right now, I have the system set up as such:

index.php is the main index and merely calls several functions which display headers, generate the main SQL query and display the index line by line. This function REQUIRE()s one other file that has all of it's sub-routines for displaying the index in it.

there is also a MESSAGE file that displays the content of messages, which calls one OTHER file where all of the code for displaying a message is stored.

In addition, there is a POST file which handles posting of new messages. This file also REQUIRE()s another file which contain the primary functionality to post new messages and replies.

Each of these modules is divided up into between 2-10 functions, each having a specific purpose.

There are several files which are independent functions used both in posting, browsing and reading which have their own file and are included as needed. The authentication file is one of these, which checks user names and such.

There is also an administrative file, which calls a few of it's own functions from another file, as well as pulling a few of the funcitons off the remainder of the database.

Does this sound way out there? or is it solid? Any suggestions?

The problem I have is that my friend has decided it's best to put ALL of the routines in one file. so now every request is handled by the index.php file.

to view a message, your pass the variable "action=message" such as:
index.php?action=message&m=200

He also wants to run all of the functions that are REQUIRE()d together into one central "repository". He says it is more secure and easire to find things when the system is set up this way.

I'm asking because I don't want to put my foot down and say "no, this is HOW IT IS" and the only reason I have is "because I think it's better"

If someone can let me know what they think and perhaps cite some examples, I would appreciate it.

I am open to whatever you all have to say about this, but I really am curious what most people consider "good practice" in programming. (I think I already know, but maybe I'm wrong)

Oh, yes. Also, what do you think of having "REQUIRE" files to be named .inc instead of .php? I've been doing some thinking on that and seems to me it might be very bad because a browser will read a *.inc file as a text document and display all the code. The .php file will only show a blank page, since it has only functions in it. It could even log an attempt to read an include file as a hacking attempt. :-) Still, maybe there are benefits the other way. Let me know what you think.

Thanks,
Eric

planetsim

I think the maximum size any file with PHP should be is around 15kb which ive worked out to be roughly 500lines long.

Now i consider that about what PHPBB do it. Its how i made my Forum(Typo Still Am)

Now depending on the function.
I usually make a seperate file if the issue is exactly the same no matter what page its on. A good example of that is a mysql class.

A Configuration file.

tomhath

I think its more personal preference than right vs. wrong.

People who use an Integrated Development Environment (IDE) tend to have more smaller files because the IDE makes it easy to move among them. People who like text editors like vi tend to want everything in one big file where they can search for what they want.

Both ways work. IMHO good programmers shouldn't mind following whatever standard is being used on the project. Some will want to start a religious war over that kind of thing, they're welcome to find a project they like better somewhere else...

If you aren't using a source control system yet you'll probably soon realize why it was invented (as soon as you and your friend start stepping on eachother's changes).

If there are documented performance or security reasons (not just opinions) for combining the project into fewer files you can package it that way after the main development is complete.

EricHagen

So the general idea is... smaller functions, but it's just personal preference as to how many files they are in.

I guess that makes sense. I, for one, know that functions are SUPPOSED to be single-purpose, since complex functions are difficult to read and almost impossible to debug sometimes.

Then again, having thousands of tiny little functions can cause more bugs than it solves...

eh Shrugs

thanks,
eric

Elizabeth

My personal preference is to use multiple files, as I have a paranoia about putting all my eggs in one basket, so to speak. If you have everything in one huge file and something happens to that file and its backup (or my downfall - forgetting to backup) - then you are totally screwed and to re-create that file is a way mammoth job.

-Elizabeth

Tekime

I tend to classify things a lot. It helps me manage my code, as well as making it more reusable. The idea of plopping everything into one file makes my skin crawl... but then again I only use vi for iptables and shell scripts.

It's been a few years since my Perl days, but I developed a 'threaded' bbs with just a few files and tons of code... it was a flop, to say the least. Not that it didn't work, but it was ugly as hell. Now that I'm using PHP I make a lot of classes. DB class, user class, auth class, etc. It seems like some people dislike this method, but it solves a few problems for me. It helps deal with globals (ex I can declare a class global and refer to $this->whatevervar without declaring a global inside every function), with a few changes I can use the object in another application, and it keeps bug control and maintenence consistent across my programs.

I generally use a single file for each logical portion of a program, and generalize as many functions to classes as possible. But I'm no Rasmus; and it could all backfire on me one day... :o :p

[deleted]

Many small files has the advantage that you can edit one while somebody else edits another, and that every script does just one task.

But putting everything into one large file has the advantage that you can use a 'switch' to perform many different tasks, so you don't have to switch from script to script all the time.

I prefer to use classes and create seperate files only for different functionalities inside the application, like a forum, product management, order processing etc, 'big' things inside the app.

If you plan to work on the code with more people at the same time you will have to either devide the code into smaller scripts so as not to overwrite eachothers modifications, or work out a plan so that you will each work on a seperate script and stay away from the scripts that the other people are editing.

If you write clean and neat code, you can use CVS to merge your modifications. That way you can edit the same script with several people at the same time, providing they submit their changes regularly so that CVS can track the changes.

" I think the maximum size any file with PHP should be is around 15kb which ive worked out to be roughly 500lines long. "

What do you base this on?

" If there are documented performance or security reasons (not just opinions) for combining the project into fewer files you can package it that way after the main development is complete."

There used to be a performance issue with script-size, due to the compile-time. Larger scripts took longer to compile. But with caching tools such as PHPA, this is nolonger relevant. Splitting scripts up to increase performance is not a valid argument anymore.

"If you have everything in one huge file and something happens to that file and its backup (or my downfall - forgetting to backup)"

splitting code as a failsafe mechanism. Interesting idea, though I don't think that your 'forgetfulness' regarding backups is a valid argument for your choice of coding style. Practical yes, but valid... hm.... 😉

"Oh, yes. Also, what do you think of having "REQUIRE" files to be named .inc instead of .php?"

.php, no question. They are php files after all. .inc must be protected through a htaccess configuration, which you will forget to do sooner or later.

amcgrath

Vincent,

It's been a long time, it's nice to see you are still dispensing your pearls of wisdom.

I agree with everything you say, except the .php versus .inc . I've found this to be really useful in identifying what the file is used for: .qry for queries, .templ for templates, etc. I guess it's because my style is to have the "guts" of the program deeper within the OS where .htaccess is not needed and say in a case where I have a home page open and it's logic, I could concievably have index.php, index.inc, index.templ, and index.qry open at the same time (it may sound confusing but it really isn't.

Just my 2 cents, and again, it's good to see you still in the game, and me getting back into the game (though I still must suffer through Cold Fusion ugh).

amc

Tekime

Forgot to mention, I use .inc.php (i.e. config.inc.php). Best of both worlds..

edit: Also, for classes I usually do myClassname.class.php.

[deleted]

"I've found this to be really useful in identifying what the file is used for: .qry for queries, .templ for templates, etc. I

I do the exact opposite, the files are allways PHP files, so they get the .php extention, but I prepend the filetype. So you'd get class_something.php for classes and lib_somethingelse.php for function libraries, tpl_foobar.html for templates. That way they are neatly sorted by type in the filelist of your editor.

" it's good to see you still in the game,"

You didn't yeally think I'd leave did you? 🙂