cycle / orm

src/FactoryInterface.php

<?php

declare(strict_types=1);

namespace Cycle\ORM;

use Cycle\Database\DatabaseInterface;
use Cycle\Database\DatabaseProviderInterface;
use Cycle\ORM\Collection\CollectionFactoryInterface;
use Cycle\ORM\Parser\TypecastInterface;
use Cycle\ORM\Service\SourceProviderInterface;
use Cycle\ORM\Relation\RelationInterface;
use Cycle\ORM\Select\LoaderInterface;
use Cycle\ORM\Select\SourceInterface;
use Spiral\Core\FactoryInterface as CoreFactory;

/**
 * Must provide access to generic DI.
 */
interface FactoryInterface extends DatabaseProviderInterface, CoreFactory
{
    public const PARENT_LOADER = '::parent::';
    public const CHILD_LOADER = '::child::';

    /**
     * Create mapper associated with given role.
     */
    public function mapper(
        ORMInterface $orm,
        string $role,
    ): MapperInterface;

    /**
     * Create loader associated with specific entity and relation.
     */
    public function loader(
        SchemaInterface $schema,
        SourceProviderInterface $sourceProvider,
        string $role,
        string $relation,
    ): LoaderInterface;

    /**
     * @template TEntity
     *
     * Create repository associated with given role.
     *
     * @param non-empty-string|class-string<TEntity> $role

The doc comment non-empty-string|class-string<TEntity> at position 0 could not be parsed: Unknown type name 'non-empty-string' at position 0 in non-empty-string|class-string<TEntity>.

     * @return ($role is class-string<TEntity> ? RepositoryInterface<TEntity> : RepositoryInterface<object>)

The doc comment ($role at position 1 could not be parsed: Unknown type name '$role' at position 1 in ($role.

     */
    public function repository(
        ORMInterface $orm,
        SchemaInterface $schema,
        string $role,
        ?Select $select,
    ): RepositoryInterface;

    /**
     * Create typecast implementation associated with given role.
     */
    public function typecast(
        SchemaInterface $schema,
        DatabaseInterface $database,
        string $role,
    ): ?TypecastInterface;

    /**
     * Create source associated with given role.
     */
    public function source(
        SchemaInterface $schema,
        string $role,
    ): SourceInterface;

    /**
     * @param class-string|string|null $name Collection factory name.

The doc comment class-string|string|null at position 0 could not be parsed: Unknown type name 'class-string' at position 0 in class-string|string|null.

     *        Can be class name or alias that can be configured in the {@see withCollectionFactory()} method.
     */
    public function collection(
        ?string $name = null,
    ): CollectionFactoryInterface;

    /**
     * Create relation associated with specific entity and relation.
     */
    public function relation(
        ORMInterface $orm,
        SchemaInterface $schema,
        string $role,
        string $relation,
    ): RelationInterface;

    /**
     * Add default classes for producing
     */
    public function withDefaultSchemaClasses(array $defaults): self;

    /**
     * Configure additional collection factories.
     *
     * @param string $alias Collection alias name that can be used in {@see Relation::COLLECTION_TYPE} parameter.
     * @param class-string|null $interface An interface or base class that is common to the collections produced.

The doc comment class-string|null at position 0 could not be parsed: Unknown type name 'class-string' at position 0 in class-string|null.

     */
    public function withCollectionFactory(
        string $alias,
        CollectionFactoryInterface $factory,
        ?string $interface = null,
    ): self;
}