Updated

functions.php

@@ -2,6 +2,13 @@
 
 namespace Opis\Closure;
 
+use Opis\Closure\Security\SecurityProviderInterface;
+
+/**
+ * @param Security\SecurityProviderInterface|string|null $security The security provider used to sign data
+ * @param bool $v3Compatible True if you need v3 compatibility at deserialization
+ * @return void
+ */
 function init(
     Security\SecurityProviderInterface|string|null $security = null,
     bool                                           $v3Compatible = false
@@ -10,6 +17,68 @@ function init(
     Serializer::init($security, $v3Compatible);
 }
 
+/**
+ * Changes the security provider
+ * @param Security\SecurityProviderInterface|string|null $security
+ * @return void
+ */
+function set_security_provider(Security\SecurityProviderInterface|string|null $security): void
+{
+    Serializer::setSecurityProvider($security);
+}
+
+/**
+ * Get current security provider
+ * @return SecurityProviderInterface|null
+ */
+function get_security_provider(): ?Security\SecurityProviderInterface
+{
+    return Serializer::getSecurityProvider();
+}
+
+/**
+ * Register a custom serializer for class
+ * @param string $class Class name
+ * @param callable(object): array $serialize Serialization function
+ * @param callable(array, callable(object, mixed): void, \ReflectionClass): object $unserialize Unserialization function
+ * @return void
+ */
+function register(
+    string   $class,
+    callable $serialize,
+    callable $unserialize
+): void
+{
+    Serializer::register($class, $serialize, $unserialize);
+}
+
+/**
+ * Unregister a previously registered serializer
+ * @param string $class Class name
+ * @return void
+ */
+function unregister(string $class): void
+{
+    Serializer::register($class, null, null);
+}
+
+/**
+ * Prevent serialization boxing for the specified classes.
+ * If you own the class, you should use Opis\Closure\Attribute\PreventBoxing attribute, instead of this function.
+ * @param string ...$classes
+ * @return void
+ */
+function prevent_boxing(string ...$classes): void
+{
+    Serializer::preventBoxing(...$classes);
+}
+
+/**
+ * Serialize arbitrary data
+ * @param mixed $data The data to be serialized
+ * @param Security\SecurityProviderInterface|null $security Security provider used to sign the serialized data
+ * @return string Serialized data
+ */
 function serialize(
     mixed                               $data,
     ?Security\SecurityProviderInterface $security = null
@@ -18,6 +87,14 @@ function serialize(
     return Serializer::serialize($data, $security);
 }
 
+/**
+ * Unserialize data
+ * @param string $data Data to be deserialized
+ * @param Security\SecurityProviderInterface|array|null $security The security provider used to check the signature
+ * @param array|null $options Options for unserialization
+ * @return mixed The deserialized data
+ * @see https://www.php.net/manual/en/function.unserialize.php
+ */
 function unserialize(
     string                                        $data,
     Security\SecurityProviderInterface|array|null $security = null,

src/Attribute/NoBox.php → src/Attribute/PreventBoxing.php

@@ -5,4 +5,4 @@
 use Attribute;
 
 #[Attribute(Attribute::TARGET_CLASS)]
-class NoBox {}
+class PreventBoxing {}

src/Box.php

@@ -2,12 +2,10 @@
 
 namespace Opis\Closure;
 
-use Opis\Closure\Attribute\NoBox;
-
 /**
  * @internal
  */
-#[NoBox]
+#[Attribute\PreventBoxing]
 final class Box
 {
     public const TYPE_CLOSURE = 1;

src/ClassInfo.php

@@ -3,7 +3,6 @@
 namespace Opis\Closure;
 
 use ReflectionClass;
-use Opis\Closure\Attribute\NoBox;
 
 /**
  * @internal
@@ -28,7 +27,7 @@ class ClassInfo
     public function __construct(string $className)
     {
         $reflection = $this->reflection = new ReflectionClass($className);
-        $this->box = empty($reflection->getAttributes(NoBox::class));
+        $this->box = empty($reflection->getAttributes(Attribute\PreventBoxing::class));
         $this->hasMagicSerialize = $reflection->hasMethod("__serialize");
         $this->hasMagicUnserialize = $reflection->hasMethod("__unserialize");
     }

src/ClosureInfo.php

@@ -3,9 +3,8 @@
 namespace Opis\Closure;
 
 use Closure;
-use Opis\Closure\Attribute\NoBox;
 
-#[NoBox]
+#[Attribute\PreventBoxing]
 final class ClosureInfo
 {
     public const FLAG_IS_SHORT = 1;

src/PriorityWrapper.php

@@ -2,15 +2,13 @@
 
 namespace Opis\Closure;
 
-use Opis\Closure\Attribute\NoBox;
-
 /**
  * In order to correctly unserialize closures we first have to
  * unserialize objects so that bindings of closures to be already resolved.
  * This is used only at the top level.
  * @internal
  */
-#[NoBox]
+#[Attribute\PreventBoxing]
 final class PriorityWrapper
 {
     public function __construct(

src/Serializer.php

@@ -250,17 +250,20 @@ public static function getClassInfo(string $class): ClassInfo
      * Prevent serialization boxing for specified classes
      * @param string ...$class
      * @return void
-     * @throws \ReflectionException
      */
-    public static function noBox(string ...$class): void
+    public static function preventBoxing(string ...$class): void
     {
         foreach ($class as $cls) {
             self::getClassInfo($cls)->box = false;
         }
     }
 
     /**
-     * Register custom serialization/deserialization for a class
+     * Register custom serialization & deserialization for a class
+     * @param string $class
+     * @param null|callable(object): array $serialize
+     * @param null|callable(array, callable(object, mixed): void, \ReflectionClass): object $unserialize
+     * @return void
      */
     public static function register(string $class, ?callable $serialize, ?callable $unserialize): void
     {