A Quick and Friendly Introduction to eZPersistentObject

Step 2: Creating our class

We start creating the file extension/ezpotutorial/classes/tutorialfriendshipobject.php:

Code :

<?php

class TutorialFriendshipObject extends eZPersistentObject
{
     const STATUS_ACCEPTED = 1;
     const STATUS_PENDING = 0;
     /**
     * Construct, use {@link UserExpObject::create()} to create new objects.
     * 
     * @param array $row
     */
    protected function __construct(  $row )
    {
        parent::eZPersistentObject( $row );
    }

    public static function definition()
    {
        static $def = array( 'fields' => array(
                    'user1_id' => array(
                                       'name' => 'user1_id',
                                       'datatype' => 'integer',
                                       'default' => 0,
                                       'required' => true ),
                    'user2_id' => array(
                                       'name' => 'user2_id',
                                       'datatype' => 'integer',
                                       'default' => 0,
                                       'required' => true ),
                    'status' => array(
                                       'name' => 'status',
                                       'datatype' => 'integer',
                                       'default' => self::STATUS_PENDING,
                                       'required' => true ),
                  ),
                  'keys' => array( 'user1_id', 'user2_id' ),
                  'class_name' => 'TutorialFriendshipObject',
                  'name' => 'tutorial_friendship' );
        return $def;
    }

    public static function create( array $row = array() )
    {    
        if( $row['status'] != self::STATUS_ACCEPTED 
                    and $row['status']!= self::STATUS_PENDING )
        {
            $row['status']= self::STATUS_PENDING;
        }
        $object = new self( $row );
        return $object;
    }
    
}
?>

In this example class, the constructor receives an associative array with the name and values of the object attributes ( user1_id, user2_id, and/or status ) and create the eZPersistentObject. The definition function returns an associative array that specify the object metadata by declaring its fields, keys, database table and so on. When creating a class that inherits from eZPersistentObject you need to implement this function. Here's a brief description of all the necessary information: