0 follower

Final Class Yiisoft\Yii\Gii\Generator\ActiveRecord\InverseRelation

All Classes | Methods

Inheritance	Yiisoft\Yii\Gii\Generator\ActiveRecord\InverseRelation » Yiisoft\Yii\Gii\Generator\ActiveRecord\AbstractRelation

Represents an inverse relation (incoming foreign key from another table).

For example, if a Post table has a FK to User, then User has an inverse hasMany relation to Post.

Public Methods

Hide inherited methods

Method	Description	Defined By
__construct()		Yiisoft\Yii\Gii\Generator\ActiveRecord\InverseRelation
getGetterMethodName()	Returns the method name for the relation getter (e.g., "getProfile").	Yiisoft\Yii\Gii\Generator\ActiveRecord\AbstractRelation
getGetterReturnType()	Returns the return type for the getter method.	Yiisoft\Yii\Gii\Generator\ActiveRecord\AbstractRelation
getInverseOf()		Yiisoft\Yii\Gii\Generator\ActiveRecord\InverseRelation
getLink()		Yiisoft\Yii\Gii\Generator\ActiveRecord\InverseRelation
getName()		Yiisoft\Yii\Gii\Generator\ActiveRecord\AbstractRelation
getQueryMethodName()	Returns the method name for the relation query (e.g., "getProfileQuery").	Yiisoft\Yii\Gii\Generator\ActiveRecord\AbstractRelation
getRelatedModel()		Yiisoft\Yii\Gii\Generator\ActiveRecord\InverseRelation
isHasMany()	Returns true if this is a hasMany relation.	Yiisoft\Yii\Gii\Generator\ActiveRecord\AbstractRelation
isHasOne()	Returns true if this is a hasOne relation.	Yiisoft\Yii\Gii\Generator\ActiveRecord\AbstractRelation

Method Details

Hide inherited methods

__construct() public method

public mixed __construct ( \Yiisoft\Db\Constraint\ForeignKey $foreignKey, string $relatedTableName )
$foreignKey	\Yiisoft\Db\Constraint\ForeignKey
$relatedTableName	string

Source code

                public function __construct(
    private readonly ForeignKey $foreignKey,
    private readonly string $relatedTableName,
) {}

getGetterMethodName() public method

Defined in: Yiisoft\Yii\Gii\Generator\ActiveRecord\AbstractRelation::getGetterMethodName()

Returns the method name for the relation getter (e.g., "getProfile").

public string getGetterMethodName ( )

Source code

                public function getGetterMethodName(): string
{
    return 'get' . $this->getRelatedModel();
}

getGetterReturnType() public method

Defined in: Yiisoft\Yii\Gii\Generator\ActiveRecord\AbstractRelation::getGetterReturnType()

Returns the return type for the getter method.

public string getGetterReturnType ( )

Source code

                public function getGetterReturnType(): string
{
    if ($this->isHasMany()) {
        return 'array';
    }
    return '?' . $this->getRelatedModel();
}

getInverseOf() public method

public string getInverseOf ( )

Source code

                public function getInverseOf(): string
{
    return lcfirst((new Inflector())->tableToClass($this->foreignKey->foreignTableName));
}

getLink() public method

public array getLink ( )

Source code

                public function getLink(): array
{
    $link = [];
    foreach ($this->foreignKey->columnNames as $index => $columnName) {
        $link[$columnName] = $this->foreignKey->foreignColumnNames[$index];
    }
    return $link;
}

getName() public method

Defined in: Yiisoft\Yii\Gii\Generator\ActiveRecord\AbstractRelation::getName()

public string getName ( )

Source code

                public function getName(): string
{
    return lcfirst($this->getRelatedModel());
}

getQueryMethodName() public method

Defined in: Yiisoft\Yii\Gii\Generator\ActiveRecord\AbstractRelation::getQueryMethodName()

Returns the method name for the relation query (e.g., "getProfileQuery").

public string getQueryMethodName ( )

Source code

                public function getQueryMethodName(): string
{
    return 'get' . $this->getRelatedModel() . 'Query';
}

getRelatedModel() public method

public string getRelatedModel ( )

Source code

                public function getRelatedModel(): string
{
    return (new Inflector())->tableToClass($this->relatedTableName);
}

isHasMany() public method

Defined in: Yiisoft\Yii\Gii\Generator\ActiveRecord\AbstractRelation::isHasMany()

Returns true if this is a hasMany relation.

public boolean isHasMany ( )

Source code

                public function isHasMany(): bool
{
    return false;
}

isHasOne() public method

Defined in: Yiisoft\Yii\Gii\Generator\ActiveRecord\AbstractRelation::isHasOne()

Returns true if this is a hasOne relation.

public boolean isHasOne ( )

Source code

                public function isHasOne(): bool
{
    return true;
}