laudis-technologies/neo4j-php-client

<?php

declare(strict_types=1);

/*
 * This file is part of the Neo4j PHP Client and Driver package.
 *
 * (c) Nagels <https://nagels.tech>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Laudis\Neo4j\Databags;

use Laudis\Neo4j\Types\AbstractCypherObject;
use Laudis\Neo4j\Types\CypherList;
use Laudis\Neo4j\Types\CypherMap;

/**
 * This describes the plan that the database planner produced and used (or will use) to execute your query.
 *
 * @see https://neo4j.com/docs/cypher-manual/current/execution-plans/
 *
 * @psalm-immutable
 *
 * @extends AbstractCypherObject<string, mixed>
 */
final class Plan extends AbstractCypherObject
{
    /**
     * @param CypherMap<mixed>   $arguments
     * @param CypherList<Plan>   $list
     * @param CypherList<string> $identifiers
     */
    public function __construct(
        private readonly CypherMap $arguments,
        private readonly CypherList $list,
        private readonly CypherList $identifiers,
        private readonly string $operator
    ) {}

    /**
     * Returns the arguments for the operator.
     *
     * @return CypherMap<mixed>
     */
    public function getArguments(): CypherMap
    {
        return $this->arguments;
    }

    /**
     * Returns the sub-plans.
     *
     * @return CypherList<Plan>
     */
    public function getList(): CypherList
    {
        return $this->list;
    }

    /**
     * Identifiers used by this part of the plan.
     *
     * @return CypherList<string>
     */
    public function getIdentifiers(): CypherList
    {
        return $this->identifiers;
    }

    /**
     * The operation this plan is performing.
     */
    public function getOperator(): string
    {
        return $this->operator;
    }

    public function toArray(): array
    {
        return [
            'arguments' => $this->arguments,
            'list' => $this->list,
            'identifiers' => $this->identifiers,
            'operator' => $this->operator,
        ];
    }
}