<?php

/*
 * This file is part of the Behat Testwork.
 * (c) Konstantin Kudryashov <ever.zet@gmail.com>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Behat\Testwork\Call;

use ReflectionFunctionAbstract;

/**
 * Represents callable object.
 *
 * @author Konstantin Kudryashov <ever.zet@gmail.com>
 */
interface Callee
{
    /**
     * Returns callee definition path.
     *
     * @return string
     */
    public function getPath();

    /**
     * Returns callee description.
     *
     * @return string
     */
    public function getDescription();

    /**
     * Returns true if callee is a method, false otherwise.
     *
     * @return bool
     */
    public function isAMethod();

    /**
     * Returns true if callee is an instance (non-static) method, false otherwise.
     *
     * @return bool
     */
    public function isAnInstanceMethod();

    /**
     * Returns callable.
     *
     * @return callable|array{class-string, string}
     */
    public function getCallable();

    /**
     * Returns callable reflection.
     *
     * @return ReflectionFunctionAbstract
     */
    public function getReflection();
}
