/vendor/propel/test/testsuite/runtime/map/ColumnMapTest.php

<?php

/**
 * This file is part of the Propel package.
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 *
 * @license    MIT License
 */

require_once dirname(__FILE__) . '/../../../tools/helpers/bookstore/BookstoreTestBase.php';

/**
 * Test class for TableMap.
 *
 * @author     François Zaninotto
 * @version    $Id$
 * @package    runtime.map
 */
class ColumnMapTest extends BookstoreTestBase
{
  protected $databaseMap;

  protected function setUp()
  {
    parent::setUp();
    $this->dmap = new DatabaseMap('foodb');
    $this->tmap = new TableMap('foo', $this->dmap);
    $this->columnName = 'bar';
    $this->cmap = new ColumnMap($this->columnName, $this->tmap);
  }

  protected function tearDown()
  {
    // nothing to do for now
    parent::tearDown();
  }

  public function testConstructor()
  {
    $this->assertEquals($this->columnName, $this->cmap->getName(), 'constructor sets the column name');
    $this->assertEquals($this->tmap, $this->cmap->getTable(), 'Constructor sets the table map');
    $this->assertNull($this->cmap->getType(), 'A new column map has no type');
  }

  public function testPhpName()
  {
    $this->assertNull($this->cmap->getPhpName(), 'phpName is empty until set');
    $this->cmap->setPhpName('FooBar');
    $this->assertEquals('FooBar', $this->cmap->getPhpName(), 'phpName is set by setPhpName()');
  }

  public function testType()
  {
    $this->assertNull($this->cmap->getType(), 'type is empty until set');
    $this->cmap->setType('FooBar');
    $this->assertEquals('FooBar', $this->cmap->getType(), 'type is set by setType()');
  }

  public function tesSize()
  {
    $this->assertEquals(0, $this->cmap->getSize(), 'size is empty until set');
    $this->cmap->setSize(123);
    $this->assertEquals(123, $this->cmap->getSize(), 'size is set by setSize()');
  }

  public function testPrimaryKey()
  {
    $this->assertFalse($this->cmap->isPrimaryKey(), 'primaryKey is false by default');
    $this->cmap->setPrimaryKey(true);
    $this->assertTrue($this->cmap->isPrimaryKey(), 'primaryKey is set by setPrimaryKey()');
  }

  public function testNotNull()
  {
    $this->assertFalse($this->cmap->isNotNull(), 'notNull is false by default');
    $this->cmap->setNotNull(true);
    $this->assertTrue($this->cmap->isNotNull(), 'notNull is set by setPrimaryKey()');
  }

  public function testDefaultValue()
  {
    $this->assertNull($this->cmap->getDefaultValue(), 'defaultValue is empty until set');
    $this->cmap->setDefaultValue('FooBar');
    $this->assertEquals('FooBar', $this->cmap->getDefaultValue(), 'defaultValue is set by setDefaultValue()');
  }

  public function testGetForeignKey()
  {
    $this->assertFalse($this->cmap->isForeignKey(), 'foreignKey is false by default');
    try {
      $this->cmap->getRelatedTable();
      $this->fail('getRelatedTable throws an exception when called on a column with no foreign key');
    } catch (PropelException $e) {
      $this->assertTrue(true, 'getRelatedTable throws an exception when called on a column with no foreign key');
    }
    try {
      $this->cmap->getRelatedColumn();
      $this->fail('getRelatedColumn throws an exception when called on a column with no foreign key');
    } catch (PropelException $e) {
      $this->assertTrue(true, 'getRelatedColumn throws an exception when called on a column with no foreign key');
    }
    $relatedTmap = $this->dmap->addTable('foo2');
    // required to let the database map use the foreign TableMap
    $relatedCmap = $relatedTmap->addColumn('BAR2', 'Bar2', 'INTEGER');
    $this->cmap->setForeignKey('foo2', 'BAR2');
    $this->assertTrue($this->cmap->isForeignKey(), 'foreignKey is true after setting the foreign key via setForeignKey()');
    $this->assertEquals($relatedTmap, $this->cmap->getRelatedTable(), 'getRelatedTable returns the related TableMap object');
    $this->assertEquals($relatedCmap, $this->cmap->getRelatedColumn(), 'getRelatedColumn returns the related ColumnMap object');
  }

  public function testGetRelation()
  {
    $bookTable = BookPeer::getTableMap();
    $titleColumn = $bookTable->getColumn('TITLE');
    $this->assertNull($titleColumn->getRelation(), 'getRelation() returns null for non-foreign key columns');
    $publisherColumn = $bookTable->getColumn('PUBLISHER_ID');
    $this->assertEquals($publisherColumn->getRelation(), $bookTable->getRelation('Publisher'), 'getRelation() returns the RelationMap object for this foreign key');
    $bookstoreTable = BookstoreEmployeePeer::getTableMap();
    $supervisorColumn = $bookstoreTable->getColumn('SUPERVISOR_ID');
    $this->assertEquals($supervisorColumn->getRelation(), $supervisorColumn->getRelation('Supervisor'), 'getRelation() returns the RelationMap object even whit ha specific refPhpName');

  }

  public function testNormalizeName()
  {
    $this->assertEquals('', ColumnMap::normalizeName(''), 'normalizeColumnName() returns an empty string when passed an empty string');
    $this->assertEquals('BAR', ColumnMap::normalizeName('bar'), 'normalizeColumnName() uppercases the input');
    $this->assertEquals('BAR_BAZ', ColumnMap::normalizeName('bar_baz'), 'normalizeColumnName() does not mind underscores');
    $this->assertEquals('BAR', ColumnMap::normalizeName('FOO.BAR'), 'normalizeColumnName() removes table prefix');
    $this->assertEquals('BAR', ColumnMap::normalizeName('BAR'), 'normalizeColumnName() leaves normalized column names unchanged');
    $this->assertEquals('BAR_BAZ', ColumnMap::normalizeName('foo.bar_baz'), 'normalizeColumnName() can do all the above at the same time');
  }

  public function testIsPrimaryString()
  {
    $bookTable = BookPeer::getTableMap();
    $idColumn = $bookTable->getColumn('ID');
    $titleColumn = $bookTable->getColumn('TITLE');
    $isbnColumn = $bookTable->getColumn('ISBN');

    $this->assertFalse($idColumn->isPrimaryString(), 'isPrimaryString() returns false by default.');
    $this->assertTrue($titleColumn->isPrimaryString(), 'isPrimaryString() returns true if set in schema.');
    $this->assertFalse($isbnColumn->isPrimaryString(), 'isPrimaryString() returns false if not set in schema.');

    $titleColumn->setPrimaryString(false);
    $this->assertFalse($titleColumn->isPrimaryString(), 'isPrimaryString() returns false if unset.');

    $titleColumn->setPrimaryString(true);
    $this->assertTrue($titleColumn->isPrimaryString(), 'isPrimaryString() returns true if set.');
  }
}