drkthunder02/w4rpservices
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

composer update

Browse Source
This commit is contained in:
drkthunder02
2020-05-10 09:29:56 +00:00
parent c6f807ebad
commit 8e93eececf
919 changed files with 11790 additions and 7005 deletions
Download Patch File Download Diff File Expand all files Collapse all files
vendor/phpdocumentor/reflection-docblock/src/DocBlock.php
Vendored
+34 -66
View File
@@ -1,12 +1,13 @@
<?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.
*
* @copyright 2010-2015 Mike van Riel<mike@phpdoc.org>
* @license http://www.opensource.org/licenses/mit-license.php MIT
* @link http://phpdoc.org
*/
@@ -18,94 +19,77 @@ use Webmozart\Assert\Assert;
final class DocBlock
{
/** @var string The opening line for this docblock. */
private $summary = '';
private $summary;
/** @var DocBlock\Description The actual description for this docblock. */
private $description = null;
private $description;
/** @var Tag[] An array containing all the tags in this docblock; except inline. */
private $tags = [];
/** @var Types\Context Information about the context of this DocBlock. */
private $context = null;
/** @var Types\Context|null Information about the context of this DocBlock. */
private $context;
/** @var Location Information about the location of this DocBlock. */
private $location = null;
/** @var Location|null Information about the location of this DocBlock. */
private $location;
/** @var bool Is this DocBlock (the start of) a template? */
private $isTemplateStart = false;
private $isTemplateStart;
/** @var bool Does this DocBlock signify the end of a DocBlock template? */
private $isTemplateEnd = false;
private $isTemplateEnd;
/**
* @param string $summary
* @param DocBlock\Description $description
* @param DocBlock\Tag[] $tags
* @param Types\Context $context The context in which the DocBlock occurs.
* @param Location $location The location within the file that this DocBlock occurs in.
* @param bool $isTemplateStart
* @param bool $isTemplateEnd
* @param Types\Context $context The context in which the DocBlock occurs.
* @param Location $location The location within the file that this DocBlock occurs in.
*/
public function __construct(
$summary = '',
DocBlock\Description $description = null,
string $summary = '',
?DocBlock\Description $description = null,
array $tags = [],
Types\Context $context = null,
Location $location = null,
$isTemplateStart = false,
$isTemplateEnd = false
?Types\Context $context = null,
?Location $location = null,
bool $isTemplateStart = false,
bool $isTemplateEnd = false
) {
Assert::string($summary);
Assert::boolean($isTemplateStart);
Assert::boolean($isTemplateEnd);
Assert::allIsInstanceOf($tags, Tag::class);
$this->summary = $summary;
$this->summary = $summary;
$this->description = $description ?: new DocBlock\Description('');
foreach ($tags as $tag) {
$this->addTag($tag);
}
$this->context = $context;
$this->context = $context;
$this->location = $location;
$this->isTemplateEnd = $isTemplateEnd;
$this->isTemplateEnd = $isTemplateEnd;
$this->isTemplateStart = $isTemplateStart;
}
/**
* @return string
*/
public function getSummary()
public function getSummary() : string
{
return $this->summary;
}
/**
* @return DocBlock\Description
*/
public function getDescription()
public function getDescription() : DocBlock\Description
{
return $this->description;
}
/**
* Returns the current context.
*
* @return Types\Context
*/
public function getContext()
public function getContext() : ?Types\Context
{
return $this->context;
}
/**
* Returns the current location.
*
* @return Location
*/
public function getLocation()
public function getLocation() : ?Location
{
return $this->location;
}
@@ -128,10 +112,8 @@ final class DocBlock
* elements that follow until another DocBlock is found that contains the closing marker (`#@-`).
*
* @see self::isTemplateEnd() for the check whether a closing marker was provided.
*
* @return boolean
*/
public function isTemplateStart()
public function isTemplateStart() : bool
{
return $this->isTemplateStart;
}
@@ -140,10 +122,8 @@ final class DocBlock
* Returns whether this DocBlock is the end of a Template section.
*
* @see self::isTemplateStart() for a more complete description of the Docblock Template functionality.
*
* @return boolean
*/
public function isTemplateEnd()
public function isTemplateEnd() : bool
{
return $this->isTemplateEnd;
}
@@ -153,7 +133,7 @@ final class DocBlock
*
* @return Tag[]
*/
public function getTags()
public function getTags() : array
{
return $this->tags;
}
@@ -166,13 +146,10 @@ final class DocBlock
*
* @return Tag[]
*/
public function getTagsByName($name)
public function getTagsByName(string $name) : array
{
Assert::string($name);
$result = [];
/** @var Tag $tag */
foreach ($this->getTags() as $tag) {
if ($tag->getName() !== $name) {
continue;
@@ -188,14 +165,9 @@ final class DocBlock
* Checks if a tag of a certain type is present in this DocBlock.
*
* @param string $name Tag name to check for.
*
* @return bool
*/
public function hasTag($name)
public function hasTag(string $name) : bool
{
Assert::string($name);
/** @var Tag $tag */
foreach ($this->getTags() as $tag) {
if ($tag->getName() === $name) {
return true;
@@ -208,11 +180,9 @@ final class DocBlock
/**
* Remove a tag from this DocBlock.
*
* @param Tag $tag The tag to remove.
*
* @return void
* @param Tag $tagToRemove The tag to remove.
*/
public function removeTag(Tag $tagToRemove)
public function removeTag(Tag $tagToRemove) : void
{
foreach ($this->tags as $key => $tag) {
if ($tag === $tagToRemove) {
@@ -226,10 +196,8 @@ final class DocBlock
* Adds a tag to this DocBlock.
*
* @param Tag $tag The tag to add.
*
* @return void
*/
private function addTag(Tag $tag)
private function addTag(Tag $tag) : void
{
$this->tags[] = $tag;
}