Use object options

Author: asika32764

README.md

@@ -5,8 +5,6 @@
 ](https://packagist.org/packages/asika/autolink)
 [![Packagist Downloads](https://img.shields.io/packagist/dt/asika/autolink?style=for-the-badge)](https://packagist.org/packages/asika/autolink)
 
-
-
 A library to auto convert URLs to links.
 
 ## Table of Content
@@ -23,11 +21,11 @@ A library to auto convert URLs to links.
   * [Convert Email](#convert-email)
   * [Attributes Escaping](#attributes-escaping)
   * [Options](#options)
-    * [`text_limit`](#text_limit)
-    * [`auto_title`](#auto_title)
-    * [`strip_scheme`](#strip_scheme)
+    * [`textLimit`](#textlimit)
+    * [`autoTitle`](#autotitle)
+    * [`stripScheme`](#stripscheme)
     * [`escape`](#escape)
-    * [`link_no_scheme`](#link_no_scheme)
+    * [`linkNoScheme`](#linknoscheme)
   * [Scheme](#scheme)
   * [Link Builder](#link-builder)
 <!-- TOC -->
@@ -74,13 +72,15 @@ $autolink = new Autolink();
 Create with options.
 
 ```php
-$options = [
-    'strip_scheme' => false,
-    'text_limit' => null,
-    'auto_title' => false,
-    'escape' => true,
-    'link_no_scheme' => false
-];
+use Asika\Autolink\AutolinkOptions;
+
+$options = new AutolinkOptions(
+    stripScheme: false,
+    textLimit: null,
+    autoTitle: false,
+    escape: true,
+    linkNoScheme: false
+);
 
 $schemes = ['http', 'https', 'skype', 'itunes'];
 
@@ -170,7 +170,7 @@ $autolink->setEscapeHandler(fn => ...);
 
 ## Options
 
-### `text_limit`
+### `textLimit`
 
 We can set this option by constructor or setter:
 
@@ -208,7 +208,7 @@ Output:
 http://campus.asukademy.com/....../84-find-interns......
 ```
 
-### `auto_title`
+### `autoTitle`
 
 Use AutoTitle to force add title on anchor element.
 
@@ -224,7 +224,7 @@ Output:
 <a href="http://www.google.com.tw" title="http://www.google.com.tw">http://www.google.com.tw</a>
 ```
 
-### `strip_scheme`
+### `stripScheme`
 
 Strip Scheme on link text:
 
@@ -261,7 +261,7 @@ Output
 <a href="http://www.google.com.tw?foo=bar&amp;yoo=baz" >http://www.google.com.tw?foo=bar&amp;yoo=baz</a>
 ```
 
-### `link_no_scheme`
+### `linkNoScheme`
 
 Convert URL which no scheme. If you pass `TRUE` to this option, Autolink will use
 `http` as default scheme, you can also provide your own default scheme.

src/Autolink.php

@@ -11,18 +11,7 @@
  */
 class Autolink
 {
-    /**
-     * Property options.
-     *
-     * @var  array
-     */
-    public array $options = [
-        'strip_scheme' => false,
-        'text_limit' => null,
-        'auto_title' => false,
-        'escape' => true,
-        'link_no_scheme' => false
-    ];
+    public AutolinkOptions $options;
 
     /**
      * Property schemes.
@@ -64,12 +53,12 @@ class Autolink
     /**
      * Class init.
      *
-     * @param array $options Basic options.
-     * @param array $schemes
+     * @param  AutolinkOptions|array  $options  Basic options.
+     * @param  array                  $schemes
      */
-    public function __construct(array $options = [], array $schemes = [])
+    public function __construct(AutolinkOptions|array $options = [], array $schemes = [])
     {
-        $this->options = array_merge($this->options, (array) $options);
+        $this->setOptions($options);
 
         $this->setSchemes(...array_merge($this->schemes, $schemes));
     }
@@ -254,22 +243,26 @@ public function shorten(string $text, int $limit): string
 
     public function stripScheme(bool $value = false): static
     {
-        return $this->setOption('strip_scheme', $value);
+        $this->options->stripScheme = $value;
+
+        return $this;
     }
 
     public function isStripScheme(): bool
     {
-        return (bool) $this->getOption('strip_scheme');
+        return $this->options->stripScheme;
     }
 
     public function autoEscape(bool $value = true): static
     {
-        return $this->setOption('escape', $value);
+        $this->options->escape = $value;
+
+        return $this;
     }
 
     public function isAutoEscape(): bool
     {
-        return (bool) $this->getOption('escape');
+        return (bool) $this->options->escape;
     }
 
     /**
@@ -279,12 +272,18 @@ public function isAutoEscape(): bool
      */
     public function textLimit(int|callable|null $value = null): static
     {
-        return $this->setOption('text_limit', $value);
+        if (is_callable($value)) {
+            $value = $value(...);
+        }
+
+        $this->options->textLimit = $value;
+
+        return $this;
     }
 
     public function getTextLimit(): int|callable|null
     {
-        $value = $this->getOption('text_limit');
+        $value = $this->options->textLimit;
 
         // Fix for B/C
         if ($value === false) {
@@ -294,21 +293,16 @@ public function getTextLimit(): int|callable|null
         return $value;
     }
 
-    /**
-     * autoTitle
-     *
-     * @param mixed $value
-     *
-     * @return  static
-     */
     public function autoTitle(bool $value = false): static
     {
-        return $this->setOption('auto_title', $value);
+        $this->options->autoTitle = $value;
+
+        return $this;
     }
 
     public function isAutoTitle(): bool
     {
-        return (bool) $this->getOption('auto_title');
+        return $this->options->autoTitle;
     }
 
     /**
@@ -320,12 +314,14 @@ public function isAutoTitle(): bool
      */
     public function linkNoScheme(bool|string $value = false): static
     {
-        return $this->setOption('link_no_scheme', $value);
+        $this->options->linkNoScheme = $value;
+
+        return $this;
     }
 
     public function getLinkNoScheme(): bool|string
     {
-        return $this->getOption('link_no_scheme');
+        return $this->options->linkNoScheme;
     }
 
     /**
@@ -335,22 +331,34 @@ public function getLinkNoScheme(): bool|string
      * @param mixed  $value
      *
      * @return  static
+     *
+     * @deprecated  Use {@see AutolinkOptions} instead.
      */
     protected function setOption(string $name, mixed $value = null): static
     {
-        $this->options[$name] = $value;
+        $name = AutolinkOptions::mapOptionKey($name);
+
+        $this->options->$name = $value;
 
         return $this;
     }
 
+    /**
+     * @param  string      $name
+     * @param  mixed|null  $default
+     *
+     * @return  mixed
+     *
+     * @deprecated  Use {@see AutolinkOptions} instead.
+     */
     protected function getOption(string $name, mixed $default = null): mixed
     {
-        return $this->options[$name] ?? $default;
+        $name = AutolinkOptions::mapOptionKey($name);
+
+        return $this->options->$name ?? $default;
     }
 
     /**
-     * addScheme
-     *
      * @param string ...$schemes
      *
      * @return  static
@@ -368,8 +376,6 @@ public function addScheme(string ...$schemes): static
     }
 
     /**
-     * removeScheme
-     *
      * @param string $scheme
      *
      * @return  static
@@ -385,26 +391,21 @@ public function removeScheme(string $scheme): static
         return $this;
     }
 
-    /**
-     * Method to get property Options
-     *
-     * @return  array
-     */
-    public function getOptions(): array
+    public function getOptions(): AutolinkOptions
     {
         return $this->options;
     }
 
     /**
      * Method to set property options
      *
-     * @param array $options
+     * @param  AutolinkOptions|array  $options
      *
      * @return  static  Return self to support chaining.
      */
-    public function setOptions(array $options): static
+    public function setOptions(AutolinkOptions|array $options): static
     {
-        $this->options = $options;
+        $this->options = AutolinkOptions::wrap($options);
 
         return $this;
     }

src/AutolinkOptions.php

@@ -0,0 +1,45 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Asika\Autolink;
+
+class AutolinkOptions
+{
+    public function __construct(
+        public bool $stripScheme = false,
+        public int|\Closure|null $textLimit = null,
+        public bool $autoTitle = false,
+        public bool $escape = true,
+        public bool|string $linkNoScheme = false,
+    )
+    {
+    }
+
+    public static function wrap(AutolinkOptions|array $options): AutolinkOptions
+    {
+        if ($options instanceof static) {
+            return $options;
+        }
+
+        return new static(
+            stripScheme: $options['strip_scheme'] ?? false,
+            textLimit: $options['text_limit'] ?? null,
+            autoTitle: $options['auto_title'] ?? false,
+            escape: $options['escape'] ?? true,
+            linkNoScheme: $options['link_no_scheme'] ?? false,
+        );
+    }
+
+    public static function mapOptionKey(string $key): string
+    {
+        return match ($key) {
+            'strip_scheme' => 'stripScheme',
+            'text_limit' => 'textLimit',
+            'auto_title' => 'autoTitle',
+            'escape' => 'escape',
+            'link_no_scheme' => 'linkNoScheme',
+            default => $key,
+        };
+    }
+}