API Standards (WIP)

[Jesse Burns]

I have been doing a lot of studying lately, trying to implement everything the way I'd like to. I've been balancing getting something out the door with getting something high quality out the door. There's been a lot of give and take.

The truth of the matter is that any project's v1.0 release isn't going to be a masterpiece, and incremental improvement is the way to go.

One thing I do want to do from the get-go is have a consistent API.

So I've put together a little naming scheme that is inspired by a document in the Solar framework manual. That's what the reference link points to:

https://gist.github.com/jburns131/6957228

It's a standard way to label methods so you know what the method's intent is. I'm trying to make it non specific, so we can use these for any class/object, i.e. database, template, users, etc...

The first thing I'm going to modify using this method is the sql class. I'm going to try to remove any reference to how the data is stored, modified and retrieved. I'm not going to go too crazy on it right now, but I want to try to have a good base now so when I do go crazy on it there won't be a crap load of modification to do.

Then I'm going to work on the Template and User classes. The hope is that as I modify the public API in this order I'll have a better idea of what works, what doesn't, and what needs to be added.

If you've got any suggestion feel free to leave feedback!

Jesse Burns
jbWebWare.com - Bringing The Web To You!!!
AllianceCMS.com - Bringing Us Together!!!