PHruts

• Index
• Download
• User Guide
• PHP doc

• 1. Introduction
• 2. Building Model Components
• 3. Building View Components
• 4. Building Controller Components
• 5. Configuring Applications
• Annex

Annex

A. PHPBeans

PHPBeans are reusable software components for PHP that can be manipulated visually in a builder tool. In order to function as a PHPBean class, an object class must obey certain conventions about method naming, construction, and behavior. These conventions make it possible to have tools that can use, reuse, replace, and connect PHPBeans.

The required conventions are:

• The class must have a no-argument public constructor. This allows easy instantiation within editing and activation frameworks.
• The class properties must be accessible using get, set, and other methods (so-called accessor methods), following a standard naming convention. This allows easy automated inspection and updating of bean state within frameworks, many of which include custom editors for various types of properties.

Properties naming convention: a PHPBean defines a property foo of type bar if it has accessor methods that follow these patterns (if bar is boolean, a special form of getter method is allowed):

• Getter:
  

  /**
   * @var bar
   */
  public function getFoo();

• Boolean getter:
  

  /**
   * @var boolean
   */
  public function isFoo();

• Setter:
  

  /**
   * @param bar $foo
   */
  public function setFoo($foo);