<?php

declare(strict_types=1);

namespace Doctrine\Persistence\Mapping;

use ReflectionClass;

/**
 * Contract for a Doctrine persistence layer ClassMetadata class to implement.
 *
 * @template-covariant T of object
 * @method mixed getFieldValue(object $entity, string $field)
 * @method void  setFieldValue(object $entity, string $field, mixed $value)
 */
interface ClassMetadata
{
    /**
     * Gets the fully-qualified class name of this persistent class.
     *
     * @phpstan-return class-string<T>
     */
    public function getName(): string;

    /**
     * Gets the mapped identifier field name.
     *
     * The returned structure is an array of the identifier field names.
     *
     * @return array<int, string>
     * @phpstan-return list<string>
     */
    public function getIdentifier(): array;

    /**
     * Gets the ReflectionClass instance for this mapped class.
     *
     * @return ReflectionClass<covariant T>
     */
    public function getReflectionClass(): ReflectionClass;

    /** Checks if the given field name is a mapped identifier for this class. */
    public function isIdentifier(string $fieldName): bool;

    /** Checks if the given field is a mapped property for this class. */
    public function hasField(string $fieldName): bool;

    /** Checks if the given field is a mapped association for this class. */
    public function hasAssociation(string $fieldName): bool;

    /** Checks if the given field is a mapped single valued association for this class. */
    public function isSingleValuedAssociation(string $fieldName): bool;

    /** Checks if the given field is a mapped collection valued association for this class. */
    public function isCollectionValuedAssociation(string $fieldName): bool;

    /**
     * A numerically indexed list of field names of this persistent class.
     *
     * This array includes identifier fields if present on this class.
     *
     * @return array<int, string>
     */
    public function getFieldNames(): array;

    /**
     * Returns an array of identifier field names numerically indexed.
     *
     * @return array<int, string>
     */
    public function getIdentifierFieldNames(): array;

    /**
     * Returns a numerically indexed list of association names of this persistent class.
     *
     * This array includes identifier associations if present on this class.
     *
     * @return array<int, string>
     */
    public function getAssociationNames(): array;

    /**
     * Returns a type name of this field.
     *
     * This type names can be implementation specific but should at least include the php types:
     * integer, string, boolean, float/double, datetime.
     */
    public function getTypeOfField(string $fieldName): string|null;

    /**
     * Returns the target class name of the given association.
     *
     * @phpstan-return class-string|null
     */
    public function getAssociationTargetClass(string $assocName): string|null;

    /** Checks if the association is the inverse side of a bidirectional association. */
    public function isAssociationInverseSide(string $assocName): bool;

    /** Returns the target field of the owning side of the association. */
    public function getAssociationMappedByTargetField(string $assocName): string;

    /**
     * Returns the identifier of this object as an array with field name as key.
     *
     * Has to return an empty array if no identifier isset.
     *
     * @return array<string, mixed>
     */
    public function getIdentifierValues(object $object): array;
}
