MemberMetadata.php

<?php


/*
 * This file is part of the Symfony package.
 *
 * (c) Fabien Potencier <fabien@symfony.com>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */
namespace Symfony\Component\Validator\Mapping;

use Symfony\Component\Validator\Constraint;
use Symfony\Component\Validator\Constraints\Composite;
use Symfony\Component\Validator\Exception\ConstraintDefinitionException;

/**
 * Stores all metadata needed for validating a class property.
 *
 * The method of accessing the property's value must be specified by subclasses
 * by implementing the {@link newReflectionMember()} method.
 *
 * This class supports serialization and cloning.
 *
 * @author Bernhard Schussek <bschussek@gmail.com>
 *
 * @see PropertyMetadataInterface
 */
abstract class MemberMetadata extends GenericMetadata implements PropertyMetadataInterface {
    
    /**
     * @internal This property is public in order to reduce the size of the
     *           class' serialized representation. Do not access it. Use
     *           {@link getClassName()} instead.
     */
    public string $class;
    
    /**
     * @internal This property is public in order to reduce the size of the
     *           class' serialized representation. Do not access it. Use
     *           {@link getName()} instead.
     */
    public string $name;
    
    /**
     * @internal This property is public in order to reduce the size of the
     *           class' serialized representation. Do not access it. Use
     *           {@link getPropertyName()} instead.
     */
    public string $property;
    
    /**
     * @var \ReflectionMethod[]|\ReflectionProperty[]
     */
    private array $reflMember = [];
    
    /**
     * @param string $class    The name of the class this member is defined on
     * @param string $name     The name of the member
     * @param string $property The property the member belongs to
     */
    public function __construct(string $class, string $name, string $property) {
        $this->class = $class;
        $this->name = $name;
        $this->property = $property;
    }
    public function addConstraint(Constraint $constraint) : static {
        $this->checkConstraint($constraint);
        parent::addConstraint($constraint);
        return $this;
    }
    public function __sleep() : array {
        return array_merge(parent::__sleep(), [
            'class',
            'name',
            'property',
        ]);
    }
    
    /**
     * Returns the name of the member.
     */
    public function getName() : string {
        return $this->name;
    }
    public function getClassName() : string {
        return $this->class;
    }
    public function getPropertyName() : string {
        return $this->property;
    }
    
    /**
     * Returns whether this member is public.
     */
    public function isPublic(object|string $objectOrClassName) : bool {
        return $this->getReflectionMember($objectOrClassName)
            ->isPublic();
    }
    
    /**
     * Returns whether this member is protected.
     */
    public function isProtected(object|string $objectOrClassName) : bool {
        return $this->getReflectionMember($objectOrClassName)
            ->isProtected();
    }
    
    /**
     * Returns whether this member is private.
     */
    public function isPrivate(object|string $objectOrClassName) : bool {
        return $this->getReflectionMember($objectOrClassName)
            ->isPrivate();
    }
    
    /**
     * Returns the reflection instance for accessing the member's value.
     */
    public function getReflectionMember(object|string $objectOrClassName) : \ReflectionMethod|\ReflectionProperty {
        $className = \is_string($objectOrClassName) ? $objectOrClassName : $objectOrClassName::class;
        if (!isset($this->reflMember[$className])) {
            $this->reflMember[$className] = $this->newReflectionMember($objectOrClassName);
        }
        return $this->reflMember[$className];
    }
    
    /**
     * Creates a new reflection instance for accessing the member's value.
     */
    protected abstract function newReflectionMember(object|string $objectOrClassName) : \ReflectionMethod|\ReflectionProperty;
    private function checkConstraint(Constraint $constraint) : void {
        if (!\in_array(Constraint::PROPERTY_CONSTRAINT, (array) $constraint->getTargets(), true)) {
            throw new ConstraintDefinitionException(\sprintf('The constraint "%s" cannot be put on properties or getters.', get_debug_type($constraint)));
        }
        if ($constraint instanceof Composite) {
            foreach ($constraint->getNestedConstraints() as $nestedConstraint) {
                $this->checkConstraint($nestedConstraint);
            }
        }
    }

}