README

TypehintableBehavior 行为允许您向生成的方法（在 Base 类中）添加类型提示。

安装

将 TypehintableBehavior.php 文件 cherry-pick 到 src/ 目录中，将其放置到某个位置，然后在您的 propel.ini 或 build.properties 配置文件中添加以下行

propel.behavior.typehintable.class = path.to.TypehintableBehavior

使用方法

只需在您的 schema.xml 文件中添加以下 XML 标签

<behavior name="typehintable">
    <parameter name="COLUMN_NAME" value="TYPEHINT" />
    <parameter name="RELATED_TABLE_NAME" value="TYPEHINT" />
</behavior>

如果您以列名称作为参数名称，则类型提示将添加到相应的设置方法（例如 setRoles()）。如果您以相关表名称作为参数名称，则类型提示将添加到添加/删除方法（例如 addGroup()、removeGroup()）。

您还可以指定可空的方法签名（例如 setFoo(Foo $foo = null)）

<parameter name="nullable_columns" value="COLUMN_NAME, RELATED_TABLE_NAME" />

示例

<table name="user">
    <column name="id" type="integer" required="true" primaryKey="true" autoIncrement="true" />
    <column name="username" type="varchar" size="255" primaryString="true" />
    <column name="roles" type="array" />

    <behavior name="typehintable">
		<!-- A column -->
        <parameter name="roles" value="array" />
        <!-- A related table -->
		<parameter name="group" value="\FOS\UserBundle\Model\GroupInterface" />
    </behavior>
</table>

<table name="group">
	<column name="id" type="integer" required="true" primaryKey="true" autoIncrement="true" />
	<column name="name" type="varchar" size="255" required="true" primaryString="true" />
</table>

<table name="user_group" isCrossRef="true">
	<column name="user_id" type="integer" required="true" primaryKey="true" />
	<column name="group_id" type="integer" required="true" primaryKey="true" />

	<foreign-key foreignTable="user">
		<reference local="user_id" foreign="id" />
	</foreign-key>

	<foreign-key foreignTable="group">
		<reference local="group_id" foreign="id" />
	</foreign-key>
</table>

它将在 BaseUser 类中生成以下代码

<?php

use FOS\UserBundle\Model\GroupInterface;

// ...

public function setRoles(array $v)
{
    if ($this->roles_unserialized !== $v) {
        $this->roles_unserialized = $v;
        $this->roles = '| ' . implode(' | ', $v) . ' |';
        $this->modifiedColumns[] = UserPeer::ROLES;
    }

    return $this;
}

public function addGroup(GroupInterface $group)
{
    if ($this->collGroups === null) {
        $this->initGroups();
    }
    if (!$this->collGroups->contains($group)) { // only add it if the **same** object is not already associated
        $this->doAddGroup($group);

        $this->collGroups[]= $group;
    }
}

致谢

William Durand [email protected]