2010-06-24 09:40:05 +01:00
|
|
|
<?php
|
|
|
|
|
2010-10-02 11:42:31 +01:00
|
|
|
/*
|
2011-01-15 13:29:43 +00:00
|
|
|
* This file is part of the Symfony package.
|
2010-10-02 11:42:31 +01:00
|
|
|
*
|
2011-03-06 11:40:06 +00:00
|
|
|
* (c) Fabien Potencier <fabien@symfony.com>
|
2010-10-02 11:42:31 +01:00
|
|
|
*
|
2011-01-15 13:29:43 +00:00
|
|
|
* For the full copyright and license information, please view the LICENSE
|
|
|
|
* file that was distributed with this source code.
|
2010-10-02 11:42:31 +01:00
|
|
|
*/
|
|
|
|
|
2011-01-15 13:29:43 +00:00
|
|
|
namespace Symfony\Component\Validator\Mapping;
|
|
|
|
|
2010-11-16 22:41:46 +00:00
|
|
|
use Symfony\Component\Validator\Constraint;
|
2011-01-19 14:30:43 +00:00
|
|
|
use Symfony\Component\Validator\Exception\ConstraintDefinitionException;
|
2014-03-17 15:44:19 +00:00
|
|
|
use Symfony\Component\Validator\ValidationVisitorInterface;
|
2010-06-24 09:40:05 +01:00
|
|
|
|
2014-02-21 17:00:47 +00:00
|
|
|
/**
|
|
|
|
* 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
|
|
|
|
*/
|
2015-09-30 14:39:58 +01:00
|
|
|
abstract class MemberMetadata extends GenericMetadata implements PropertyMetadataInterface
|
2010-06-24 09:40:05 +01:00
|
|
|
{
|
2014-02-21 17:00:47 +00:00
|
|
|
/**
|
|
|
|
* @var string
|
|
|
|
*
|
|
|
|
* @internal This property is public in order to reduce the size of the
|
|
|
|
* class' serialized representation. Do not access it. Use
|
|
|
|
* {@link getClassName()} instead.
|
|
|
|
*/
|
2010-06-29 16:20:29 +01:00
|
|
|
public $class;
|
2014-02-21 17:00:47 +00:00
|
|
|
|
|
|
|
/**
|
|
|
|
* @var string
|
|
|
|
*
|
|
|
|
* @internal This property is public in order to reduce the size of the
|
|
|
|
* class' serialized representation. Do not access it. Use
|
|
|
|
* {@link getName()} instead.
|
|
|
|
*/
|
2010-06-29 16:20:29 +01:00
|
|
|
public $name;
|
2014-02-21 17:00:47 +00:00
|
|
|
|
|
|
|
/**
|
|
|
|
* @var string
|
|
|
|
*
|
|
|
|
* @internal This property is public in order to reduce the size of the
|
|
|
|
* class' serialized representation. Do not access it. Use
|
|
|
|
* {@link getPropertyName()} instead.
|
|
|
|
*/
|
2010-06-29 16:20:29 +01:00
|
|
|
public $property;
|
2014-02-21 17:00:47 +00:00
|
|
|
|
|
|
|
/**
|
|
|
|
* @var \ReflectionMethod[]|\ReflectionProperty[]
|
|
|
|
*/
|
2013-03-05 15:41:51 +00:00
|
|
|
private $reflMember = array();
|
2010-06-24 09:40:05 +01:00
|
|
|
|
2010-06-24 10:24:08 +01:00
|
|
|
/**
|
|
|
|
* Constructor.
|
|
|
|
*
|
2010-10-15 22:49:09 +01:00
|
|
|
* @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
|
2010-06-24 10:24:08 +01:00
|
|
|
*/
|
|
|
|
public function __construct($class, $name, $property)
|
|
|
|
{
|
|
|
|
$this->class = $class;
|
|
|
|
$this->name = $name;
|
|
|
|
$this->property = $property;
|
|
|
|
}
|
2010-06-24 09:40:05 +01:00
|
|
|
|
2010-11-16 22:41:46 +00:00
|
|
|
/**
|
2014-04-15 06:57:34 +01:00
|
|
|
* {@inheritdoc}
|
2010-11-16 22:41:46 +00:00
|
|
|
*/
|
|
|
|
public function addConstraint(Constraint $constraint)
|
|
|
|
{
|
2011-03-31 13:02:00 +01:00
|
|
|
if (!in_array(Constraint::PROPERTY_CONSTRAINT, (array) $constraint->getTargets())) {
|
2011-01-19 14:30:43 +00:00
|
|
|
throw new ConstraintDefinitionException(sprintf(
|
2011-01-26 08:54:11 +00:00
|
|
|
'The constraint %s cannot be put on properties or getters',
|
|
|
|
get_class($constraint)
|
|
|
|
));
|
2011-01-19 14:30:43 +00:00
|
|
|
}
|
|
|
|
|
2014-02-18 17:03:59 +00:00
|
|
|
parent::addConstraint($constraint);
|
2010-11-16 22:41:46 +00:00
|
|
|
|
|
|
|
return $this;
|
|
|
|
}
|
|
|
|
|
2010-06-29 16:20:29 +01:00
|
|
|
/**
|
2014-02-21 17:00:47 +00:00
|
|
|
* {@inheritdoc}
|
2010-06-29 16:20:29 +01:00
|
|
|
*/
|
|
|
|
public function __sleep()
|
|
|
|
{
|
|
|
|
return array_merge(parent::__sleep(), array(
|
|
|
|
'class',
|
|
|
|
'name',
|
2010-11-16 22:41:46 +00:00
|
|
|
'property',
|
2010-06-29 16:20:29 +01:00
|
|
|
));
|
|
|
|
}
|
|
|
|
|
2010-06-24 10:24:08 +01:00
|
|
|
/**
|
2014-02-21 17:00:47 +00:00
|
|
|
* Returns the name of the member.
|
2010-06-24 10:24:08 +01:00
|
|
|
*
|
|
|
|
* @return string
|
|
|
|
*/
|
|
|
|
public function getName()
|
|
|
|
{
|
|
|
|
return $this->name;
|
|
|
|
}
|
2010-06-24 09:40:05 +01:00
|
|
|
|
2010-06-24 10:24:08 +01:00
|
|
|
/**
|
2014-02-21 17:00:47 +00:00
|
|
|
* {@inheritdoc}
|
2010-06-24 10:24:08 +01:00
|
|
|
*/
|
|
|
|
public function getClassName()
|
|
|
|
{
|
|
|
|
return $this->class;
|
|
|
|
}
|
2010-06-24 09:40:05 +01:00
|
|
|
|
2010-06-24 10:24:08 +01:00
|
|
|
/**
|
2014-02-21 17:00:47 +00:00
|
|
|
* {@inheritdoc}
|
2010-06-24 10:24:08 +01:00
|
|
|
*/
|
|
|
|
public function getPropertyName()
|
|
|
|
{
|
|
|
|
return $this->property;
|
|
|
|
}
|
2010-06-24 09:40:05 +01:00
|
|
|
|
2010-06-24 10:24:08 +01:00
|
|
|
/**
|
2014-02-21 17:00:47 +00:00
|
|
|
* Returns whether this member is public.
|
2010-06-24 10:24:08 +01:00
|
|
|
*
|
2013-03-05 15:41:51 +00:00
|
|
|
* @param object|string $objectOrClassName The object or the class name
|
|
|
|
*
|
2014-04-16 11:30:19 +01:00
|
|
|
* @return bool
|
2010-06-24 10:24:08 +01:00
|
|
|
*/
|
2013-03-05 15:41:51 +00:00
|
|
|
public function isPublic($objectOrClassName)
|
2010-06-24 10:24:08 +01:00
|
|
|
{
|
2013-03-05 15:41:51 +00:00
|
|
|
return $this->getReflectionMember($objectOrClassName)->isPublic();
|
2010-06-24 10:24:08 +01:00
|
|
|
}
|
2010-06-24 09:40:05 +01:00
|
|
|
|
2010-06-24 10:24:08 +01:00
|
|
|
/**
|
2014-12-21 17:00:50 +00:00
|
|
|
* Returns whether this member is protected.
|
2010-06-24 10:24:08 +01:00
|
|
|
*
|
2013-03-05 15:41:51 +00:00
|
|
|
* @param object|string $objectOrClassName The object or the class name
|
|
|
|
*
|
2014-04-16 11:30:19 +01:00
|
|
|
* @return bool
|
2010-06-24 10:24:08 +01:00
|
|
|
*/
|
2013-03-05 15:41:51 +00:00
|
|
|
public function isProtected($objectOrClassName)
|
2010-06-24 10:24:08 +01:00
|
|
|
{
|
2013-03-05 15:41:51 +00:00
|
|
|
return $this->getReflectionMember($objectOrClassName)->isProtected();
|
2010-06-24 10:24:08 +01:00
|
|
|
}
|
2010-06-24 09:40:05 +01:00
|
|
|
|
2010-06-24 10:24:08 +01:00
|
|
|
/**
|
2014-02-21 17:00:47 +00:00
|
|
|
* Returns whether this member is private.
|
2010-06-24 10:24:08 +01:00
|
|
|
*
|
2013-03-05 15:41:51 +00:00
|
|
|
* @param object|string $objectOrClassName The object or the class name
|
|
|
|
*
|
2014-04-16 11:30:19 +01:00
|
|
|
* @return bool
|
2010-06-24 10:24:08 +01:00
|
|
|
*/
|
2013-03-05 15:41:51 +00:00
|
|
|
public function isPrivate($objectOrClassName)
|
2010-06-24 10:24:08 +01:00
|
|
|
{
|
2013-03-05 15:41:51 +00:00
|
|
|
return $this->getReflectionMember($objectOrClassName)->isPrivate();
|
2010-06-24 10:24:08 +01:00
|
|
|
}
|
2012-05-18 11:22:33 +01:00
|
|
|
|
2010-06-24 10:24:08 +01:00
|
|
|
/**
|
2014-02-21 17:00:47 +00:00
|
|
|
* Returns the reflection instance for accessing the member's value.
|
2010-06-24 10:24:08 +01:00
|
|
|
*
|
2013-03-05 15:41:51 +00:00
|
|
|
* @param object|string $objectOrClassName The object or the class name
|
|
|
|
*
|
2014-02-21 17:00:47 +00:00
|
|
|
* @return \ReflectionMethod|\ReflectionProperty The reflection instance
|
2010-06-24 10:24:08 +01:00
|
|
|
*/
|
2013-03-05 15:41:51 +00:00
|
|
|
public function getReflectionMember($objectOrClassName)
|
2010-06-24 09:40:05 +01:00
|
|
|
{
|
2013-03-05 15:41:51 +00:00
|
|
|
$className = is_string($objectOrClassName) ? $objectOrClassName : get_class($objectOrClassName);
|
|
|
|
if (!isset($this->reflMember[$className])) {
|
|
|
|
$this->reflMember[$className] = $this->newReflectionMember($objectOrClassName);
|
2010-06-24 10:24:08 +01:00
|
|
|
}
|
2010-06-24 09:40:05 +01:00
|
|
|
|
2013-03-05 15:41:51 +00:00
|
|
|
return $this->reflMember[$className];
|
2010-06-24 10:24:08 +01:00
|
|
|
}
|
2010-06-24 09:40:05 +01:00
|
|
|
|
2010-06-24 10:24:08 +01:00
|
|
|
/**
|
2014-02-21 17:00:47 +00:00
|
|
|
* Creates a new reflection instance for accessing the member's value.
|
|
|
|
*
|
|
|
|
* Must be implemented by subclasses.
|
2010-06-24 10:24:08 +01:00
|
|
|
*
|
2013-03-05 15:41:51 +00:00
|
|
|
* @param object|string $objectOrClassName The object or the class name
|
|
|
|
*
|
2014-02-21 17:00:47 +00:00
|
|
|
* @return \ReflectionMethod|\ReflectionProperty The reflection instance
|
2010-06-24 10:24:08 +01:00
|
|
|
*/
|
2013-03-05 15:41:51 +00:00
|
|
|
abstract protected function newReflectionMember($objectOrClassName);
|
2011-06-08 11:16:48 +01:00
|
|
|
}
|