| 1 |
<?php namespace WPDeveloper\BetterDocs\Dependencies\SuperClosure; |
| 2 |
|
| 3 |
use WPDeveloper\BetterDocs\Dependencies\SuperClosure\Exception\ClosureUnserializationException; |
| 4 |
|
| 5 |
/** |
| 6 |
* Interface for a serializer that is used to serialize Closure objects. |
| 7 |
*/ |
| 8 |
interface SerializerInterface |
| 9 |
{ |
| 10 |
/** |
| 11 |
* Takes a Closure object, decorates it with a SerializableClosure object, |
| 12 |
* then performs the serialization. |
| 13 |
* |
| 14 |
* @param \Closure $closure Closure to serialize. |
| 15 |
* |
| 16 |
* @return string Serialized closure. |
| 17 |
*/ |
| 18 |
public function serialize(\Closure $closure); |
| 19 |
|
| 20 |
/** |
| 21 |
* Takes a serialized closure, performs the unserialization, and then |
| 22 |
* extracts and returns a the Closure object. |
| 23 |
* |
| 24 |
* @param string $serialized Serialized closure. |
| 25 |
* |
| 26 |
* @throws ClosureUnserializationException if unserialization fails. |
| 27 |
* @return \Closure Unserialized closure. |
| 28 |
*/ |
| 29 |
public function unserialize($serialized); |
| 30 |
|
| 31 |
/** |
| 32 |
* Retrieves data about a closure including its code, context, and binding. |
| 33 |
* |
| 34 |
* The data returned is dependant on the `ClosureAnalyzer` implementation |
| 35 |
* used and whether the `$forSerialization` parameter is set to true. If |
| 36 |
* `$forSerialization` is true, then only data relevant to serializing the |
| 37 |
* closure is returned. |
| 38 |
* |
| 39 |
* @param \Closure $closure Closure to analyze. |
| 40 |
* @param bool $forSerialization Include only serialization data. |
| 41 |
* |
| 42 |
* @return \Closure |
| 43 |
*/ |
| 44 |
public function getData(\Closure $closure, $forSerialization = false); |
| 45 |
} |
| 46 |
|
