Page Menu
Home
WickedGov Phorge
Search
Configure Global Search
Log In
Files
F7410033
Description.php
No One
Temporary
Actions
Download File
Edit File
Delete File
View Transforms
Subscribe
Flag For Later
Award Token
Size
3 KB
Referenced Files
None
Subscribers
None
Description.php
View Options
<?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\DocBlock
;
use
phpDocumentor\Reflection\DocBlock\Tags\Formatter
;
use
phpDocumentor\Reflection\DocBlock\Tags\Formatter\PassthroughFormatter
;
use
function
vsprintf
;
/**
* Object representing to description for a DocBlock.
*
* A Description object can consist of plain text but can also include tags. A Description Formatter can then combine
* a body template with sprintf-style placeholders together with formatted tags in order to reconstitute a complete
* description text using the format that you would prefer.
*
* Because parsing a Description text can be a verbose process this is handled by the {@see DescriptionFactory}. It is
* thus recommended to use that to create a Description object, like this:
*
* $description = $descriptionFactory->create('This is a {@see Description}', $context);
*
* The description factory will interpret the given body and create a body template and list of tags from them, and pass
* that onto the constructor if this class.
*
* > The $context variable is a class of type {@see \phpDocumentor\Reflection\Types\Context} and contains the namespace
* > and the namespace aliases that apply to this DocBlock. These are used by the Factory to resolve and expand partial
* > type names and FQSENs.
*
* If you do not want to use the DescriptionFactory you can pass a body template and tag listing like this:
*
* $description = new Description(
* 'This is a %1$s',
* [ new See(new Fqsen('\phpDocumentor\Reflection\DocBlock\Description')) ]
* );
*
* It is generally recommended to use the Factory as that will also apply escaping rules, while the Description object
* is mainly responsible for rendering.
*
* @see DescriptionFactory to create a new Description.
* @see Tags\Formatter for the formatting of the body and tags.
*/
class
Description
{
private
string
$bodyTemplate
;
/** @var Tag[] */
private
array
$tags
;
/**
* Initializes a Description with its body (template) and a listing of the tags used in the body template.
*
* @param Tag[] $tags
*/
public
function
__construct
(
string
$bodyTemplate
,
array
$tags
=
[])
{
$this
->
bodyTemplate
=
$bodyTemplate
;
$this
->
tags
=
$tags
;
}
/**
* Returns the body template.
*/
public
function
getBodyTemplate
():
string
{
return
$this
->
bodyTemplate
;
}
/**
* Returns the tags for this DocBlock.
*
* @return Tag[]
*/
public
function
getTags
():
array
{
return
$this
->
tags
;
}
/**
* Renders this description as a string where the provided formatter will format the tags in the expected string
* format.
*/
public
function
render
(?
Formatter
$formatter
=
null
):
string
{
if
(
$this
->
tags
===
[])
{
return
vsprintf
(
$this
->
bodyTemplate
,
[]);
}
if
(
$formatter
===
null
)
{
$formatter
=
new
PassthroughFormatter
();
}
$tags
=
[];
foreach
(
$this
->
tags
as
$tag
)
{
$tags
[]
=
'{'
.
$formatter
->
format
(
$tag
)
.
'}'
;
}
return
vsprintf
(
$this
->
bodyTemplate
,
$tags
);
}
/**
* Returns a plain string representation of this description.
*/
public
function
__toString
():
string
{
return
$this
->
render
();
}
}
File Metadata
Details
Attached
Mime Type
text/x-php
Expires
Sat, Nov 21, 22:46 (1 d, 21 h)
Storage Engine
local-disk
Storage Format
Raw Data
Storage Handle
9e/b0/8d3d1e3e36c22c1392a12a52f6bc
Default Alt Text
Description.php (3 KB)
Attached To
Mode
rMWPROD MediaWiki Production
Attached
Detach File
Event Timeline
Log In to Comment