Page Menu
Home
WickedGov Phorge
Search
Configure Global Search
Log In
Files
F7433883
InvalidTag.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
InvalidTag.php
View Options
<?php
declare
(
strict_types
=
1
);
namespace
phpDocumentor\Reflection\DocBlock\Tags
;
use
Closure
;
use
Exception
;
use
phpDocumentor\Reflection\DocBlock\Tag
;
use
ReflectionClass
;
use
ReflectionException
;
use
ReflectionFunction
;
use
Throwable
;
use
function
array_map
;
use
function
get_class
;
use
function
get_resource_type
;
use
function
is_array
;
use
function
is_object
;
use
function
is_resource
;
use
function
sprintf
;
/**
* This class represents an exception during the tag creation
*
* Since the internals of the library are relaying on the correct syntax of a docblock
* we cannot simply throw exceptions at all time because the exceptions will break the creation of a
* docklock. Just silently ignore the exceptions is not an option because the user as an issue to fix.
*
* This tag holds that error information until a using application is able to display it. The object will just behave
* like any normal tag. So the normal application flow will not break.
*/
final
class
InvalidTag
implements
Tag
{
private
string
$name
;
private
string
$body
;
private
?
Throwable
$throwable
=
null
;
private
function
__construct
(
string
$name
,
string
$body
)
{
$this
->
name
=
$name
;
$this
->
body
=
$body
;
}
public
function
getException
():
?
Throwable
{
return
$this
->
throwable
;
}
public
function
getName
():
string
{
return
$this
->
name
;
}
public
static
function
create
(
string
$body
,
string
$name
=
''
):
self
{
return
new
self
(
$name
,
$body
);
}
public
function
withError
(
Throwable
$exception
):
self
{
$this
->
flattenExceptionBacktrace
(
$exception
);
$tag
=
new
self
(
$this
->
name
,
$this
->
body
);
$tag
->
throwable
=
$exception
;
return
$tag
;
}
/**
* Removes all complex types from backtrace
*
* Not all objects are serializable. So we need to remove them from the
* stored exception to be sure that we do not break existing library usage.
*/
private
function
flattenExceptionBacktrace
(
Throwable
$exception
):
void
{
$traceProperty
=
(
new
ReflectionClass
(
Exception
::
class
))->
getProperty
(
'trace'
);
$traceProperty
->
setAccessible
(
true
);
do
{
$trace
=
$exception
->
getTrace
();
if
(
isset
(
$trace
[
0
][
'args'
]))
{
$trace
=
array_map
(
function
(
array
$call
):
array
{
$call
[
'args'
]
=
array_map
([
$this
,
'flattenArguments'
],
$call
[
'args'
]
??
[]);
return
$call
;
},
$trace
);
}
$traceProperty
->
setValue
(
$exception
,
$trace
);
$exception
=
$exception
->
getPrevious
();
}
while
(
$exception
!==
null
);
$traceProperty
->
setAccessible
(
false
);
}
/**
* @param mixed $value
*
* @return mixed
*
* @throws ReflectionException
*/
private
function
flattenArguments
(
$value
)
{
if
(
$value
instanceof
Closure
)
{
$closureReflection
=
new
ReflectionFunction
(
$value
);
$value
=
sprintf
(
'(Closure at %s:%s)'
,
$closureReflection
->
getFileName
(),
$closureReflection
->
getStartLine
()
);
}
elseif
(
is_object
(
$value
))
{
$value
=
sprintf
(
'object(%s)'
,
get_class
(
$value
));
}
elseif
(
is_resource
(
$value
))
{
$value
=
sprintf
(
'resource(%s)'
,
get_resource_type
(
$value
));
}
elseif
(
is_array
(
$value
))
{
$value
=
array_map
([
$this
,
'flattenArguments'
],
$value
);
}
return
$value
;
}
public
function
render
(?
Formatter
$formatter
=
null
):
string
{
if
(
$formatter
===
null
)
{
$formatter
=
new
Formatter\PassthroughFormatter
();
}
return
$formatter
->
format
(
$this
);
}
public
function
__toString
():
string
{
return
$this
->
body
;
}
}
File Metadata
Details
Attached
Mime Type
text/x-php
Expires
Sun, Nov 22, 12:07 (2 h, 19 m)
Storage Engine
local-disk
Storage Format
Raw Data
Storage Handle
a2/8f/36f72af072fc26e7becd02a0464a
Default Alt Text
InvalidTag.php (3 KB)
Attached To
Mode
rMWPROD MediaWiki Production
Attached
Detach File
Event Timeline
Log In to Comment