<?php
/**
 * @version 1.3beta1
 * @copyright Copyright (C) 2005-2007 eZ systems as. All rights reserved.
 * @license http://ez.no/licenses/new_bsd New BSD License
 * @package PersistentObject
 */

/**
 * Defines a persistent object id field.
 * The column must be of type int both in PHP and in the database.
 * The default value will always be null.
 *
 * @see ezcPersisentObjectProperty for descriptions for some the constants used in this class.
 *
 * @package PersistentObject
 */
class ezcPersistentObjectIdProperty extends ezcBaseStruct
{
    /**
     * The name of the database field that stores the value.
     *
     * @var string
     */
    public $columnName;

    /**
     * The name of the PersistentObject property that holds the value in the PHP object.
     *
     * @var string
     */
    public $propertyName;

    /**
     * The visibility of the field. Can be either VISIBILITY_PRIVATE, VISIBILITY_PROTECTED or VISIBILITY_PUBLIC.
     *
     * @var int
     */
    public $visibility;

    /**
     * The type of generator to use for the identifier.
     *
     * The identifier generator must be an object that extends the
     * abstract class ezcPersistentIdentifierGenerator. The current
     * options that are part of this package are:
     * - ezcPersistentSequenceGenerator
     * - ezcPersistentManualGenerator
     *
     * @var ezcPersistentIdentifierGenerator
     */
    public $generator; // sequence

    /**
     * Constructs a new PersistentObjectField
     */
    public function __construct( $columnName = '',
                                 $propertyName = '',
                                 $visibility = '',
                                 ezcPersistentGeneratorDefinition $generator = null )
    {
        $this->columnName = $columnName;
        $this->propertyName = $propertyName;
        $this->visibility = $visibility;
        $this->generator = $generator;
    }

    /**
     * Returns a new instance of this class with the data specified by $array.
     *
     * $array contains all the data members of this class in the form:
     * array('member_name'=>value).
     *
     * __set_state makes this class exportable with var_export.
     * var_export() generates code, that calls this method when it
     * is parsed with PHP.
     *
     * @param array(string=>mixed)
     * @return ezcPersistentObjectIdProperty
     */
    public static function __set_state( array $array )
    {
        return new ezcPersistentObjectIdProperty( $array['columnName'],
                                                  $array['propertyName'],
                                                  $array['visibility'],
                                                  $array['generator'] );
    }
}

?>