ezdatatype_abstract_test.php

<?php
/**
 * File containing the eZDatatypeTest class
 *
 * @copyright Copyright (C) 1999-2010 eZ Systems AS. All rights reserved.
 * @license http://ez.no/licenses/gnu_gpl GNU GPLv2
 * @package tests
 */

/**
 * Base class for all datatype implementations
 */
abstract class eZDatatypeAbstractTest extends ezpDatabaseTestCase
{
    protected $backupGlobals = false;

    /**
     * The tested datatype. Set by children constructor.
     * @var string
     */
    protected $datatype = null;

    /**
     * Registered test data sets
     * @see setDataSet()
     * @var array(ezpDatatypeTestDataSet)
     */
    protected $dataSets = array();

    /**
     * The test attribute identifier
     * @var string
     */
    protected $attributeIdentifier;

    /**
     * Test content class
     * @var ezpClass
     */
    protected $class;

    /**
     * Test content object
     * @var ezpObject
     */
    protected $object;

    /**
     * The currently tested attribute
     * @var eZContentObjectAttribute
     */
    protected $attribute;

    public function __construct( $name = null, array $data = array(), $dataName = '' )
    {
        parent::__construct( $name, $data, $dataName );

        if ( $this->datatype === null )
            throw new ezcBaseValueException( "The test datatype hasn't been set" );
    }

    /**
    * Setup:
    * - creates a new content class with the tested datatype
    * - instanciates a content object of that class with the default dataset
    */
    public function setUp()
    {
        // create a content class with this datatype
        // @todo Add naming pattern handling
        try {
            $contentClassName = "Datatype {$this->datatype} test";
            $contentClassIdentifier = "datatype_{$this->datatype}_test";
            $this->attributeIdentifier = "{$this->datatype}_test";
            $this->class = new ezpClass( $contentClassName, $contentClassIdentifier, '<name>' );
            $this->class->add( 'Title', 'title', 'ezstring' );
            $this->class->add( "Test {$this->datatype}", $this->attributeIdentifier, $this->datatype );
            $this->class->store();
        }
        catch( Exception $e )
        {
            print_r ($e);
        }
    }

    public function tearDown()
    {
        if ( $this->object !== null )
            $this->destroyObject();
        eZContentClassOperations::remove( $this->class->id );
        parent::tearDown();
    }

    public function createObject( ezpDatatypeTestDataSet $dataSet )
    {
        static $counter = 0;

        $this->object = new ezpObject( $this->class->identifier, 2 );
        $this->object->title = "{$this->datatype} test #" . ++$counter;
        $dataMap = $this->object->dataMap();
        $this->attribute = $dataMap[$this->attributeIdentifier];

        try {
            $attribute = $this->attribute->fromString( $dataSet->fromString );
        } catch( PHPUnit_Framework_Error_Notice $e ) {
            self::fail( "A notice has been thrown when calling fromString: " . $e->getMessage() );
        }
        $this->object->publish();
    }

    protected function destroyObject()
    {
        eZContentObjectOperations::remove( $this->object->id );
        $this->object = null;
        $this->attribute = null;
    }

    /**
     * Adds a test dataset
     * @param string $name The set's name
     * @param ezpDatatypeTestDataSet $dataSet
     */
    protected function setDataSet( $name, $dataSet )
    {
        if ( !$dataSet instanceof ezpDatatypeTestDataSet )
            throw new ezcBaseValueException( '\$dataSet argument isn\'t an ezpDatatypeTestDataSet' );

        $this->dataSets[$name] = $dataSet;
    }

    /**
     * Sets the test datatype
     * @param string $datatype The tested datatype: ezstring, ezmatrix...
     */
    protected function setDatatype( $datatype )
    {
        $this->datatype = $datatype;
    }

    /**
     * Returns a dataset
     *
     * @param string $dataSetName The dataset's name. Ex: default.
     * @return ezpDatatypeTestDataSet
     */
    public function dataSet( $dataSetName = 'default' )
    {
        if ( !isset( $this->dataSets[$dataSetName] ) )
            throw new ezcBaseValueException( "No such dataset '$dataSetname'" );

        return $this->dataSets[$dataSetName];
    }

    public function globalDataProvider()
    {
        return array( $this->dataSets );
    }

    /**
     * Tests the attribute's content
     */
    public function testContent()
    {
        $this->createObject( $this->dataSet() );
        self::assertEquals( $this->attribute->content(), $this->dataSet()->content );
        $this->destroyObject();
    }

    /**
     * Tests the attribute's content
     */
    public function testDataText()
    {
        $this->createObject( $this->dataSet() );
        self::assertEquals( $this->attribute->attribute( 'data_text' ), $this->dataSet()->dataText );
        $this->destroyObject();
    }

    /**
     * Tests the attribute's content
     */
    public function testDataInt()
    {
        $this->createObject( $this->dataSet() );
        self::assertEquals( $this->attribute->attribute( 'data_int' ), $this->dataSet()->dataInt );
        $this->destroyObject();
    }

    /**
     * Tests the attribute's content
     */
    public function testDataFloat()
    {
        $this->createObject( $this->dataSet() );
        self::assertEquals( $this->attribute->attribute( 'data_float' ), $this->dataSet()->dataFloat );
        $this->destroyObject();
    }
}

/**
 * Struct used to represent a datatype for testing
 */
class ezpDatatypeTestDataSet extends ezcBaseStruct
{
    /**
     * The fromString value
     *
     * @var string
     */
    public $fromString = '';

    /**
     * Integer data
     *
     * @var int
     */
    public $dataInt = null;

    /**
     * Text data
     *
     * @var string
     */
    public $dataText = '';

    /**
     * Float data
     *
     * @var float
     */
    public $dataFloat = '0';

    /**
     * Content the datatype should return
     * @var mixed
     */
    public $content;

    /**
     * Constructs a new ezpDatatypeTestDataSet with initial values.
     *
     * @param string $fromString
     * @param int $dataInt
     * @param string $dataText
     * @param float $dataFloat
     * @param
     */
    public function __construct( $fromString = '', $dataInt = null, $dataText = '', $dataFloat = '0' )
    {
        $this->fromString = $fromString;
        $this->dataFloat = $dataFloat;
        $this->dataInt = $dataInt;
        $this->dataText = $dataText;
    }

    /**
     * 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) $array
     * @return ezpDatatypeTestDataSet
     */
    static public function __set_state( array $array )
    {
        return new self( $array['fromString'], $array['data_int'], $array['data_string'], $array['data_float'] );
    }
}
?>

ezmatrix_datatype_test.php

<?php
/**
 * File containing the eZDatatypeTest class
 *
 * @copyright Copyright (C) 1999-2010 eZ Systems AS. All rights reserved.
 * @license http://ez.no/licenses/gnu_gpl GNU GPLv2
 * @package tests
 */

/**
 * Base class for all datatype implementations
 */
class eZMatrixDatatypeTest extends eZDatatypeAbstractTest
{
    public function __construct( $name = null, array $data = array(), $dataName = '' )
    {
        $this->setDatatype( 'ezmatrix' );
        $this->setDataSet( 'default', $this->defaultDataSet() );

        parent::__construct( $name, $data, $dataName );
        $this->setName( "eZMatrix Datatype Tests" );
    }

    private function defaultDataSet()
    {
        $dataSet = new ezpDatatypeTestDataSet();
        $dataSet->fromString = 'col1|col2&valA1|valA2&valB1|valB2';
        $dataSet->dataText = <<<EOF
<?xml version="1.0" encoding="utf-8"?>
<ezmatrix><name></name><columns number="2"><column num="0" id="col_0">Col_0</column><column num="1" id="col_1">Col_1</column></columns><rows number="0"/></ezmatrix>

EOF;
        $dataSet->content = unserialize( 'O:8:"eZMatrix":5:{s:4:"Name";s:0:"";s:6:"Matrix";a:3:{s:4:"rows";a:1:{s:10:"sequential";a:3:{i:0;a:3:{s:7:"columns";a:2:{i:0;s:4:"col1";i:1;s:4:"col2";}s:10:"identifier";s:5:"row_1";s:4:"name";s:5:"Row_1";}i:1;a:3:{s:7:"columns";a:2:{i:0;s:5:"valA1";i:1;s:5:"valA2";}s:10:"identifier";s:5:"row_2";s:4:"name";s:5:"Row_2";}i:2;a:3:{s:7:"columns";a:2:{i:0;s:5:"valB1";i:1;s:5:"valB2";}s:10:"identifier";s:5:"row_3";s:4:"name";s:5:"Row_3";}}}s:7:"columns";a:2:{s:10:"sequential";a:2:{i:0;a:4:{s:10:"identifier";s:5:"col_0";s:5:"index";i:0;s:4:"name";s:5:"Col_0";s:4:"rows";a:0:{}}i:1;a:4:{s:10:"identifier";s:5:"col_1";s:5:"index";i:1;s:4:"name";s:5:"Col_1";s:4:"rows";a:0:{}}}s:2:"id";a:2:{s:5:"col_0";a:4:{s:10:"identifier";s:5:"col_0";s:5:"index";i:0;s:4:"name";s:5:"Col_0";s:4:"rows";a:0:{}}s:5:"col_1";a:4:{s:10:"identifier";s:5:"col_1";s:5:"index";i:1;s:4:"name";s:5:"Col_1";s:4:"rows";a:0:{}}}}s:5:"cells";a:0:{}}s:10:"NumColumns";s:1:"2";s:7:"NumRows";i:3;s:5:"Cells";a:6:{i:0;s:4:"col1";i:1;s:4:"col2";i:2;s:5:"valA1";i:3;s:5:"valA2";i:4;s:5:"valB1";i:5;s:5:"valB2";}}' );
        return $dataSet;
    }
}

?>

ezstring_datatype_test.php

<?php
/**
* File containing the eZDatatypeTest class
*
* @copyright Copyright (C) 1999-2010 eZ Systems AS. All rights reserved.
* @license http://ez.no/licenses/gnu_gpl GNU GPLv2
* @package tests
*/

/**
* Base class for all datatype implementations
*/
class eZStringDatatypeTest extends eZDatatypeAbstractTest
{
    public function __construct( $name = null, array $data = array(), $dataName = '' )
    {
        $this->setDatatype( 'ezstring' );
        $this->setDataSet( 'default', $this->defaultDataSet() );

        parent::__construct( $name, $data, $dataName );
        $this->setName( "eZString Datatype Tests" );
    }

    private function defaultDataSet()
    {
        $dataSet = new ezpDatatypeTestDataSet();
        $dataSet->fromString = 'this is a string';
        $dataSet->dataText = 'this is a string';
        $dataSet->content = 'this is a string';
        return $dataSet;
    }
}

?>