atelierspierrot/reflectors

View on GitHub
src/Reflectors/ReflectionValueInterface.php

Summary

Maintainability
A
0 mins
Test Coverage
<?php
/**
 * This file is part of the Reflectors package.
 *
 * Copyright (c) 2015-2016 Pierre Cassat <me@e-piwi.fr> and contributors
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 * The source code of this package is available online at
 * <http://github.com/atelierspierrot/reflectors>.
 */

namespace Reflectors;

/**
 * This interface is designed to build generic objects reflecting a variable with its value and type.
 *
 * @author  piwi <me@e-piwi.fr>
 */
interface ReflectionValueInterface
    extends \Reflector
{

    /**
     * Returns the current value of concerned variable
     *
     * @return mixed
     */
    public function getValue();

    /**
     * Returns the type of the value of concerned variable
     *
     * The returned type MUST be one of the `\Reflectors\ValueType` constants `TYPE_...`.
     *
     * @return  string
     */
    public function getValueType();
}