Commit c9fb769d authored by gnat's avatar gnat

explain short yaml syntax for class generation

parent 102f1068
......@@ -190,4 +190,106 @@ abstract class BaseUserGroup extends sfDoctrineRecord
'foreign' => 'id'));
}
}
</code>
\ No newline at end of file
</code>
++ Additional Schema Options
It isn't necessary to define both sides of a relationship in the schema.yml file as doctrine will attempt to autocomplete the relationships for you. If you choose to define only one side of the relationship, there are two yaml options you can pass to help doctrine decide how to complete the opposite end of the relationship. For example.
schema.yml
<code type="yml">
---
Table1:
tableName: table_1
relations:
Table2Alias:
class: Table2
local: foreign_key
type: one
foreignAlias: Table1Alias
foreignType: one
columns:
column_1: { type: string, length: 128 }
foreign_key: { type: integer, length: 4 }
Table2:
tableName: table_2
columns:
column_1: { type: string, length: 128 }
foreign_key: { type: integer, length: 4 }
</code>
This schema will define a 1-1 relationship between Table1 and Table2. You'll notice there are two new yaml entries, foreignAlias, and foreignType. ForeignAlias will define the as Alias portion of the opposite relationship, and similarily foreignType defines the reverse relationship of the opposite relationship. Defining foreignType is only necessary when you want a one-to-one relationship, but do not want to define both ends of the relationship manually. The above schema produces the following classes.
<code type="php">
/**
* This class has been auto-generated by the Doctrine ORM Framework
*/
class Table1 extends Doctrine_Record
{
public function setTableDefinition()
{
$this->setTableName('table_1');
$this->hasColumn('column_1', 'string', 128);
$this->hasColumn('foreign_key', 'integer', 4);
}
public function setUp()
{
$this->hasOne('Table2 as Table2Alias', array('local' => 'foreign_key',
'foreign' => 'id',
'onDelete' => 'CASCADE'));
}
}
/**
* This class has been auto-generated by the Doctrine ORM Framework
*/
class Table2 extends Doctrine_Record
{
public function setTableDefinition()
{
$this->setTableName('table_2');
$this->hasColumn('column_1', 'string', 128);
$this->hasColumn('foreign_key', 'integer', 4);
}
public function setUp()
{
$this->hasOne('Table1 as Table1Alias', array('local' => 'id',
'foreign' => 'foreign_key'));
}
}
</code>
As you can see doctrine fully completes the relationship for both classes. You can also use this shorter format for m-to-m relationships. Using the same User and Groups models defined previously, we create a simplified schema.yml. Whereas in the one-to-many and one-to-one the foreignAlias isn't a required field. If you choose to create many-to-many relationships using the short yaml syntax, the foreignAlias is required for proper generation.
<code type="yml">
---
User:
columns:
id: { notnull: true, primary: true, autoincrement: true, type: integer, length: 4, name: id }
username: { type: string, length: 255 }
relations:
Groups:
class: Group
refClass: UserGroup
foreignAlias: Users
local: user_id
foreign: group_id
type: many
UserGroup:
columns:
user_id: { type: integer, length: 4, primary: true }
group_id: { type: integer, length: 4, primary: true }
Group:
columns:
id: { notnull: true, primary: true, autoincrement: true, type: integer, length: 4, name: id }
name: { type: string, length: 255 }
</code>
This schema will create identical classes as the fully defined schema.yml above.
\ No newline at end of file
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment