Chris@0: <?php
Chris@0: 
Chris@0: /*
Chris@0:  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
Chris@0:  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
Chris@0:  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
Chris@0:  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
Chris@0:  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
Chris@0:  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
Chris@0:  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
Chris@0:  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
Chris@0:  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
Chris@0:  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
Chris@0:  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
Chris@0:  *
Chris@0:  * This software consists of voluntary contributions made by many individuals
Chris@0:  * and is licensed under the MIT license. For more information, see
Chris@0:  * <http://www.doctrine-project.org>.
Chris@0:  */
Chris@0: 
Chris@0: namespace Doctrine\Common\Annotations\Annotation;
Chris@0: 
Chris@0: /**
Chris@0:  * Annotation that can be used to signal to the parser
Chris@0:  * to check the available values during the parsing process.
Chris@0:  *
Chris@0:  * @since  2.4
Chris@0:  * @author Fabio B. Silva <fabio.bat.silva@gmail.com>
Chris@0:  *
Chris@0:  * @Annotation
Chris@0:  * @Attributes({
Chris@0:  *    @Attribute("value",   required = true,  type = "array"),
Chris@0:  *    @Attribute("literal", required = false, type = "array")
Chris@0:  * })
Chris@0:  */
Chris@0: final class Enum
Chris@0: {
Chris@0:     /**
Chris@0:      * @var array
Chris@0:      */
Chris@0:     public $value;
Chris@0: 
Chris@0:     /**
Chris@0:      * Literal target declaration.
Chris@0:      *
Chris@0:      * @var array
Chris@0:      */
Chris@0:     public $literal;
Chris@0: 
Chris@0:     /**
Chris@0:      * Annotation constructor.
Chris@0:      *
Chris@0:      * @param array $values
Chris@0:      *
Chris@0:      * @throws \InvalidArgumentException
Chris@0:      */
Chris@0:     public function __construct(array $values)
Chris@0:     {
Chris@0:         if ( ! isset($values['literal'])) {
Chris@0:             $values['literal'] = array();
Chris@0:         }
Chris@0: 
Chris@0:         foreach ($values['value'] as $var) {
Chris@0:             if( ! is_scalar($var)) {
Chris@0:                 throw new \InvalidArgumentException(sprintf(
Chris@0:                     '@Enum supports only scalar values "%s" given.',
Chris@0:                     is_object($var) ? get_class($var) : gettype($var)
Chris@0:                 ));
Chris@0:             }
Chris@0:         }
Chris@0: 
Chris@0:         foreach ($values['literal'] as $key => $var) {
Chris@0:             if( ! in_array($key, $values['value'])) {
Chris@0:                 throw new \InvalidArgumentException(sprintf(
Chris@0:                     'Undefined enumerator value "%s" for literal "%s".',
Chris@0:                     $key , $var
Chris@0:                 ));
Chris@0:             }
Chris@0:         }
Chris@0: 
Chris@0:         $this->value    = $values['value'];
Chris@0:         $this->literal  = $values['literal'];
Chris@0:     }
Chris@0: }