Akelos PHP Framework Wiki

Naming Conventions

Fri, 16 May 2008 23:22:42 +0200

Classes Classes use MixedCase and have no underscores, each word starts with a uppercase letter, e.g. InvoiceItem Database Table Table names have all lowercase letters and underscores between words, also all table names need to be plural, e.g. invoice_items, orders

Methods - created

Fri, 16 May 2008 17:42:26 +0200

Methods Methods are functions defined within a class declaration. They are of two types, those which can be accessed without first declaring an instance of the class and those which can only be accessed by an instance of a class. Ruby calls the first type a “class method” and the second type an “instance method”. It implements them this way:

Convert Ruby To PHP

Fri, 16 May 2008 16:55:56 +0200

Convert Ruby To PHP This section is for those who are porting Ruby code to PHP. Sometimes a hack is required to get some code to work that involves features of Ruby that are not found in PHP. If you create such a hack, please add it here. * Mixins * Methods

Acts as versioned plugin for Akelos Active Records

Wed, 14 May 2008 13:50:03 +0200

Acts as versioned plugin for Akelos Active Records This plugin adds versioning capabilities to you Active Record Models. Installation ./script/plugin install acts_as_versioned Enabling versioning in your models Say you have a Chapter model and you want to keep the latest 20 modifications for each chapter.

Acts as nested set - little bug

Tue, 13 May 2008 10:00:59 +0200

Acts as nested set The information below is copied from the API documentation in the source code This acts provides Nested Set functionality. Nested Set is similiar to Tree, but with the added feature that you can select the children and all of it's descendants with a single query. A good use case for this is a threaded post system, where you want to display every reply to a comment without multiple selects.

Akelos Modules - decaring -> declaring

Thu, 08 May 2008 18:57:20 +0200

Akelos Modules Akelos Modules allow you to group, multiple controllers into an organized manner. So instead of having all your controllers in one single place you can break them into different places. In order to tell Akelos which modules are available, you need to add a rule to map requests to the new module so it can be dispatched by the specific controller.

display-acts-as-tree-recursively - fixed display_tree_recursive(), original inserted extra ...

Thijs Mathijssen — Sat, 03 May 2008 14:08:34 +0200

Having in the controller $this->Models =& $this->Model->findAll(); where Model acts as a tree, you can have a simple and flexible helper function for displaying trees as a list by adding this to your helper: function display_tree_recursive($tree, $parent_id = null, $options = array()) { if(!empty($tree)){ foreach(array_keys($tree) as $k){ $Node =& $tree[$k]; if($Node->parent_id == $parent_id){ @$result .= "

"; $result .…

Mixins - error noted

Wed, 23 Apr 2008 18:18:46 +0200

Mixins FIXME Cannot reference $this in a function that is mixed into another class. A Mixin provides some of the features of multiple inheritance. There is no direct conversion capability from a Ruby Mixin to PHP, but here is code that permits you to do PHP Mixins.

Tue, 22 Apr 2008 16:16:07 +0200

Welcome to the community driven Akelos documentation! We rely on the contributions of others to keep the wiki accurate and useful, so please don't hesitate to update anything that could be improved on, you can also help improving this wiki by adapting content from the RoR wiki.

Implementing Many-To_Many Relationships - One closing parenthesis was missing

Tue, 15 Apr 2008 13:16:58 +0200

There have been a number of questions about this in the Forum, so I though I would write a short tutorial on what I have learned so far. Let me caution you, I am new to Akelos and new to RoR but this all seems to work for me. If there are errors or better ways to do this, please make the necessary changes.

Akismet Plugin - created

Sat, 12 Apr 2008 21:33:14 +0200

This plugin uses the Akismet service to filter comment spam. Installation ./script/plugin install akismet You will need to add the key and site to your config/config.php file like: define('AK_AKISMET_API_KEY', 'here the key you can get at wordpress.org (signup and say you just want the just the key)'); define('AK_AKISMET_SITE_URL', 'http://the-url-you-signed-up-for');

Available plug-in repositories.

Sat, 12 Apr 2008 21:27:50 +0200

Available plug-in repositories. Right now Akelos only supports mod_svn repository access without SSL like the one available at . These repositories will be listed when typing ./script/plugin discover In order to install a plugin you just need to type