Documentation corrections

Author: ringunger

LICENSE renamed to LICENSE.md

@@ -46,24 +46,50 @@ php artisan vendor:publish --tag="laravel-selectable-views"
 ```
 The output for this code will be as follows
 
-```html
+```bladehtml
 <option value="{{$user->id}}">{{$user->name}}</option>
 ...
 ```
 
 ### 2. Custom text and value for options
-```html
+```bladehtml
 <select name="user_id" >
     {!! \\App\\Model\\User::all()->toSelectOptions('email', 'uuid'); !!}}
 </select>
 ```
 The output for this code will be as follows
 
-```html
+```bladehtml
 <option value="{{$user->uuid}}">{{$user->email}}</option>
 ...
 ```
 
+### 3. Advanced use
+The method `toSelectable` is used to convert the collection into a `Selectable` object. The `Selectable` object has several methods that allow you to customize the options and their properties.
+
+```bladehtml
+<select name="user_id" multiple="multiple">
+    {!!
+        $x = \App\Models\User::all()
+        ->toSelectable()
+        ->withValue('id')
+        ->withLabel(fn($user) => "{$user->first_name} {$user->last_name}")
+        ->withSelected([4, 5])
+        ->withDisabled(fn($item) => $item->status = 'inactive')
+        ->toSelectOptions();
+    !!}
+</select>
+```
+### 4. Available methods
+- `toSelectable()`: This method returns the current selectable object.
+- `withLabel(string|callable $label)`: This method allows you to customize the label for each option. A string will be used as the collection field from which the label will be generated, while a callable will be used to generate the label.
+- `withValue(string|callable $value)`: This method allows you to customize the value for each option. A string will be used as the collection field from which the value will be generated, while a callable will be used to generate the value.
+- `withSelected(mixed|callable $selected)`: This method allows you to customize the selected options. Can be a `string`, `int`, an array of `string`/`int`, a `model` or a callable that returns a boolean value.
+- `withDisabled(mixed|callable $disabled)`: This method allows you to customize the disabled options. Can be a `string`, `int`, an array of `string`/`int`, a `model` or a callable that returns a boolean value.
+- `toSelectOptions()`: This method converts the selectable collection to an HTML select options string.
+- `toSelectItems()`: This method converts the selectable collection to an array of selectable items. Useful for Ajax responses or SPA.
+- 
+
 > <small><strong>Note:</strong> Writing queries within blade templates is not recommended. This is only for simplifying demonstration</small>
 
 ## Testing

README.md

@@ -2,7 +2,7 @@
 
 ## Supported Versions
 
-The following versions of laravel process approval package are
+The following versions of laravel selectable package are
 currently being supported with security updates.
 
 | Version | Supported          |
@@ -11,7 +11,7 @@ currently being supported with security updates.
 
 ## Reporting a Vulnerability
 
-We take the security of the Laravel Process Approval package seriously. If you have discovered a vulnerability, we appreciate your assistance in disclosing it responsibly. This ensures that we can address and resolve the issue promptly to maintain the security of our users.
+We take the security of the Laravel Selectable package seriously. If you have discovered a vulnerability, we appreciate your assistance in disclosing it responsibly. This ensures that we can address and resolve the issue promptly to maintain the security of our users.
 
 ### Reporting Process
 To report a vulnerability, please follow these steps:
@@ -29,7 +29,7 @@ We strive to acknowledge all vulnerability reports promptly. Our team will revie
 
 ### Vulnerability Handling
 #### Accepted Vulnerabilities
-If the reported vulnerability is accepted, we will work on a fix and release a new version of the Laravel Process Approval package. We will credit you for the responsible disclosure unless you prefer to remain anonymous.
+If the reported vulnerability is accepted, we will work on a fix and release a new version of the Laravel Selectable package. We will credit you for the responsible disclosure unless you prefer to remain anonymous.
 
 #### Declined Vulnerabilities
 If the reported vulnerability is deemed not to be a valid issue, we will provide a detailed explanation of our findings. You can appeal our decision if you believe there has been a misunderstanding.
@@ -40,4 +40,4 @@ We understand the sensitivity of security-related information. We will handle al
 ### Responsible Disclosure
 We appreciate your responsible disclosure of security vulnerabilities. We encourage you to avoid publicizing the vulnerability until we have had an opportunity to address it. We will keep you informed of the progress and coordinate the public disclosure timeline.
 
-Thank you for helping us keep Laravel Process Approval secure for everyone. Your efforts contribute to the safety and well-being of our user community.
+Thank you for helping us keep Laravel Selectable secure for everyone. Your efforts contribute to the safety and well-being of our user community.

SECURITY.md

@@ -2,17 +2,26 @@
 
 namespace RingleSoft\LaravelSelectable;
 
+use Closure;
 use Illuminate\Support\Collection;
+use ReflectionFunction;
 
 class Selectable
 {
     private Collection $_collection;
-    private string $_value;
-    private string $_label;
+    private string|Closure $_value;
+    private string|Closure $_label;
     private mixed $_selected = null;
     private mixed $_disabled = null;
 
-    public function __construct(Collection $collection, string|null $label = null, string|null $value = null, mixed $selected = null, mixed $disabled = null)
+    /**
+     * @param Collection $collection
+     * @param string|Closure|null $label
+     * @param string|Closure|null $value
+     * @param mixed|null $selected
+     * @param mixed|null $disabled
+     */
+    public function __construct(Collection $collection, string|Closure|null $label = null, string|Closure|null $value = null, mixed $selected = null, mixed $disabled = null)
     {
         $this->_collection = $collection;
         $this->_label = $label ?? 'name';
@@ -49,55 +58,54 @@ public static function collectionToSelectOptions(
      */
     public function toSelectOptions(): string
     {
-
-
         $html = "";
         foreach ($this->_collection as $index => $item) {
-            $lineLabel = $item->{$this->_label} ?? "N/A";
-            $lineValue = $item->{$this->_value} ?? "";
-            $html .= "<option value=\"{$lineValue}\"";
-            if($this->_shouldSelect($item)){
+            $optionLabel = ($this->_label instanceof Closure) ? call_user_func($this->_label, $item, $index) : $item->{$this->_label} ?? "N/A";
+            $optionValue = ($this->_value instanceof Closure) ? call_user_func($this->_value, $item, $index) : $item->{$this->_value} ?? "";
+            $html .= "<option value=\"{$optionValue}\"";
+            if ($this->_shouldSelect($item, $index)) {
                 $html .= " selected";
             }
-            if($this->_shouldDisable($item)){
+            if ($this->_shouldDisable($item, $index)) {
                 $html .= " disabled";
             }
-            $html .= " >{$lineLabel}</option>";
+            $html .= " >{$optionLabel}</option>";
         }
         return $html;
     }
 
     /**
      * Check if the item should be selected
      * @param object $item
+     * @param int|null $index
      * @return bool
      */
-    private function _shouldSelect(object $item): bool
+    private function _shouldSelect(object $item, int|null $index = null): bool
     {
-        $lineValue = $item->{$this->_value} ?? "";
-        if (is_callable($this->_selected)) {
+        $optionValue = ($this->_value instanceof Closure) ? call_user_func($this->_value, $item, $index) : $item->{$this->_value} ?? "";
+        if ($this->_selected instanceof Closure) {
             if (call_user_func($this->_selected, $item) === true) {
                 return true;
             }
-        } else if(is_object($this->_selected)){
-            if((string)$this->_selected->{$this->_value} === (string)$lineValue){
+        } else if (is_object($this->_selected)) {
+            if ((string)$this->_selected->{$this->_value} === (string)$optionValue) {
                 return true;
             }
         } else if (is_array($this->_selected)) {
             foreach ($this->_selected as $selectedItem) {
                 if (is_object($selectedItem)) {
-                    if ((string)$selectedItem->{$this->_value} === (string)$lineValue) {
+                    if ((string)$selectedItem->{$this->_value} === (string)$optionValue) {
                         return true;
                     }
                 } else if (is_array($selectedItem)) {
-                    if (array_key_exists($this->_value, $selectedItem) && (string)$selectedItem[$this->_value] === (string)$lineValue) {
+                    if (array_key_exists($this->_value, $selectedItem) && (string)$selectedItem[$this->_value] === (string)$optionValue) {
                         return true;
                     }
-                } else if ((string)$selectedItem === (string)$lineValue) {
+                } else if ((string)$selectedItem === (string)$optionValue) {
                     return true;
                 }
             }
-        } else if ((string)$this->_selected === (string)$lineValue) {
+        } else if ((string)$this->_selected === (string)$optionValue) {
             return true;
         }
         return false;
@@ -106,17 +114,18 @@ private function _shouldSelect(object $item): bool
     /**
      * Check if the item should be selected
      * @param object $item
+     * @param int|null $index
      * @return bool
      */
-    private function _shouldDisable(object $item): bool
+    private function _shouldDisable(object $item, int|null $index = null): bool
     {
         $lineValue = $item->{$this->_value} ?? "";
         if (is_callable($this->_disabled)) {
             if (call_user_func($this->_disabled, $item) === true) {
                 return true;
             }
-        } else if(is_object($this->_disabled)){
-            if((string)$this->_disabled->{$this->_value} === (string)$lineValue){
+        } else if (is_object($this->_disabled)) {
+            if ((string)$this->_disabled->{$this->_value} === (string)$lineValue) {
                 return true;
             }
         } else if (is_array($this->_disabled)) {
@@ -133,7 +142,7 @@ private function _shouldDisable(object $item): bool
                     return true;
                 }
             }
-        } else if ((string) $this->_disabled === (string) $lineValue) {
+        } else if ((string)$this->_disabled === (string)$lineValue) {
             return true;
         }
         return false;
@@ -145,33 +154,33 @@ private function _shouldDisable(object $item): bool
      */
     public function toSelectItems(): Collection
     {
-        return $this->_collection->map(function ($item) {
+        return $this->_collection->map(function ($item, $index) {
             return [
                 'value' => $item->{$this->_value} ?? "",
-                'label' => $item->{$this->_label},
-                'isSelected' => $this->_shouldSelect($item),
-                'isDisabled' => $this->_shouldDisable($item),
+                'label' => $index,
+                'isSelected' => $this->_shouldSelect($item, $index),
+                'isDisabled' => $this->_shouldDisable($item, $index),
             ];
         });
     }
 
     //// Builders
 
     /**
-     * @param string $label name of the field to be used as label
+     * @param string|Closure $label name of the field to be used as label
      * @return $this
      */
-    public function withLabel(string $label): self
+    public function withLabel(string|Closure $label): self
     {
         $this->_label = $label;
         return $this;
     }
 
     /**
-     * @param string $value name of the field to be used as value
+     * @param string|Closure $value name of the field to be used as value
      * @return $this
      */
-    public function withValue(string $value): self
+    public function withValue(string|Closure $value): self
     {
         $this->_value = $value;
         return $this;