<?php
declare(strict_types=1);
/**
* This file is part of phpDocumentor.
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*
* @link http://phpdoc.org
*/
namespace phpDocumentor\Reflection\Php;
use Override;
use phpDocumentor\Reflection\DocBlock;
use phpDocumentor\Reflection\Element;
use phpDocumentor\Reflection\Fqsen;
use phpDocumentor\Reflection\Location;
use phpDocumentor\Reflection\Metadata\MetaDataContainer as MetaDataContainerInterface;
use phpDocumentor\Reflection\Type;
use phpDocumentor\Reflection\Types\Mixed_;
/**
* Descriptor representing a Method in a Class, Interface or Trait.
*
* @api
*/
final class Method implements Element, MetaDataContainerInterface, AttributeContainer
{
use MetadataContainer;
use HasAttributes;
/** @var Argument[] */
private array $arguments = [];
private readonly Location $location;
private readonly Location $endLocation;
private readonly Type $returnType;
/**
* Initializes the all properties.
*
* @param Visibility|null $visibility when null is provided a default 'public' is set.
*/
public function __construct(
/** @var Fqsen Full Qualified Structural Element Name */
private readonly Fqsen $fqsen,
private Visibility|null $visibility = null,
/** @var DocBlock|null documentation of this method. */
private readonly DocBlock|null $docBlock = null,
private readonly bool $abstract = false,
private readonly bool $static = false,
private readonly bool $final = false,
Location|null $location = null,
Location|null $endLocation = null,
Type|null $returnType = null,
private readonly bool $hasReturnByReference = false,
) {
if ($this->visibility === null) {
$this->visibility = new Visibility('public');
}
if ($location === null) {
$location = new Location(-1);
}
if ($endLocation === null) {
$endLocation = new Location(-1);
}
if ($returnType === null) {
$returnType = new Mixed_();
}
$this->location = $location;
$this->endLocation = $endLocation;
$this->returnType = $returnType;
}
/**
* Returns true when this method is abstract. Otherwise returns false.
*/
public function isAbstract(): bool
{
return $this->abstract;
}
/**
* Returns true when this method is final. Otherwise returns false.
*/
public function isFinal(): bool
{
return $this->final;
}
/**
* Returns true when this method is static. Otherwise returns false.
*/
public function isStatic(): bool
{
return $this->static;
}
/**
* Returns the Visibility of this method.
*/
public function getVisibility(): Visibility|null
{
return $this->visibility;
}
/**
* Returns the arguments of this method.
*
* @return Argument[]
*/
public function getArguments(): array
{
return $this->arguments;
}
/**
* Add new argument to this method.
*/
public function addArgument(Argument $argument): void
{
$this->arguments[] = $argument;
}
/**
* Returns the Fqsen of the element.
*/
#[Override]
public function getFqsen(): Fqsen
{
return $this->fqsen;
}
/**
* Returns the name of the element.
*/
#[Override]
public function getName(): string
{
return $this->fqsen->getName();
}
/**
* Returns the DocBlock of this method if available.
*/
public function getDocBlock(): DocBlock|null
{
return $this->docBlock;
}
public function getLocation(): Location
{
return $this->location;
}
public function getEndLocation(): Location
{
return $this->endLocation;
}
/**
* Returns the in code defined return type.
*
* Return types are introduced in php 7.0 when your could doesn't have a
* return type defined this method will return Mixed_ by default. The return value of this
* method is not affected by the return tag in your docblock.
*/
public function getReturnType(): Type
{
return $this->returnType;
}
public function getHasReturnByReference(): bool
{
return $this->hasReturnByReference;
}
}