icingadb-web/library/Icingadb/Model/DependencyEdge.php

<?php

// SPDX-FileCopyrightText: 2024 Icinga GmbH <https://icinga.com>
// SPDX-License-Identifier: GPL-3.0-or-later

namespace Icinga\Module\Icingadb\Model;

use ipl\Orm\Behavior\Binary;
use ipl\Orm\Behaviors;
use Icinga\Module\Icingadb\Common\Model;
use ipl\Orm\Query;
use ipl\Orm\Relations;

/**
 * Dependency edge model.
 *
 * @property string $id
 * @property string $environment_id
 * @property string $to_node_id
 * @property string $from_node_id
 * @property string $display_name
 * @property string $dependency_edge_state_id
 *
 * @property DependencyNode|Query $child
 * @property DependencyNode|Query $parent
 * @property DependencyEdgeState|Query $state
 */
class DependencyEdge extends Model
{
    public function getTableName(): string
    {
        return 'dependency_edge';
    }

    public function getKeyName(): string
    {
        return 'id';
    }

    public function getColumns(): array
    {
        return [
            'environment_id',
            'to_node_id',
            'from_node_id',
            'display_name',
            'dependency_edge_state_id'
        ];
    }

    public function createBehaviors(Behaviors $behaviors): void
    {
        $behaviors->add(new Binary([
            'id',
            'environment_id',
            'to_node_id',
            'from_node_id',
            'dependency_edge_state_id'
        ]));
    }

    public function createRelations(Relations $relations): void
    {
        $relations->belongsTo('child', DependencyNode::class)
            ->setCandidateKey('from_node_id');
        $relations->belongsTo('parent', DependencyNode::class)
            ->setCandidateKey('to_node_id');
        $relations->hasOne('state', DependencyEdgeState::class)
            ->setCandidateKey('dependency_edge_state_id')
            ->setForeignKey('id');

        // "from" and "to" are only necessary for sub-query filters.
        $relations->belongsTo('from', DependencyNode::class)
            ->setCandidateKey('from_node_id');
        $relations->belongsTo('to', DependencyNode::class)
            ->setCandidateKey('to_node_id');
    }
}