Skip to content

Commit 9dcaef2

Browse files
author
riccardodallavia
committedAug 29, 2022
ADD HelperMacro interface for better consistency
1 parent 7287b59 commit 9dcaef2

10 files changed

+31
-10
lines changed
 

Diff for: ‎README.md

+4-2
Original file line numberDiff line numberDiff line change
@@ -232,14 +232,16 @@ hlp()->sanitizeUrl('') // returns an empty string
232232

233233
If needed, you can easily add your own helper methods.
234234

235-
All you have to do is define your custom helper method using an invokable class:
235+
All you have to do is define your custom helper class and implement the `HelperMacro` interface:
236236

237237
```php
238238
<?php
239239

240240
namespace App\Helpers\Macros;
241241

242-
class Ping
242+
use Maize\Helpers\HelperMacro;
243+
244+
class Ping implements HelperMacro
243245
{
244246
public function __invoke(): \Closure
245247
{

Diff for: ‎src/HelperMacro.php

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
<?php
2+
3+
namespace Maize\Helpers;
4+
5+
interface HelperMacro
6+
{
7+
public function __invoke(): \Closure;
8+
}

Diff for: ‎src/Macros/AnonymizeFilename.php

+2-1
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,9 @@
33
namespace Maize\Helpers\Macros;
44

55
use Illuminate\Support\Str;
6+
use Maize\Helpers\HelperMacro;
67

7-
class AnonymizeFilename
8+
class AnonymizeFilename implements HelperMacro
89
{
910
public function __invoke(): \Closure
1011
{

Diff for: ‎src/Macros/ClassUsesTrait.php

+3-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,9 @@
22

33
namespace Maize\Helpers\Macros;
44

5-
class ClassUsesTrait
5+
use Maize\Helpers\HelperMacro;
6+
7+
class ClassUsesTrait implements HelperMacro
68
{
79
public function __invoke(): \Closure
810
{

Diff for: ‎src/Macros/InstanceofTypes.php

+2-1
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,9 @@
33
namespace Maize\Helpers\Macros;
44

55
use Illuminate\Support\Arr;
6+
use Maize\Helpers\HelperMacro;
67

7-
class InstanceofTypes
8+
class InstanceofTypes implements HelperMacro
89
{
910
public function __invoke(): \Closure
1011
{

Diff for: ‎src/Macros/IsUrl.php

+3-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,9 @@
22

33
namespace Maize\Helpers\Macros;
44

5-
class IsUrl
5+
use Maize\Helpers\HelperMacro;
6+
7+
class IsUrl implements HelperMacro
68
{
79
public function __invoke(): \Closure
810
{

Diff for: ‎src/Macros/ModelKeyName.php

+2-1
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,9 @@
33
namespace Maize\Helpers\Macros;
44

55
use Illuminate\Database\Eloquent\Model;
6+
use Maize\Helpers\HelperMacro;
67

7-
class ModelKeyName
8+
class ModelKeyName implements HelperMacro
89
{
910
public function __invoke(): \Closure
1011
{

Diff for: ‎src/Macros/MorphClassOf.php

+2-1
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,9 @@
33
namespace Maize\Helpers\Macros;
44

55
use Illuminate\Database\Eloquent\Model;
6+
use Maize\Helpers\HelperMacro;
67

7-
class MorphClassOf
8+
class MorphClassOf implements HelperMacro
89
{
910
public function __invoke(): \Closure
1011
{

Diff for: ‎src/Macros/PaginationLimit.php

+3-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,9 @@
22

33
namespace Maize\Helpers\Macros;
44

5-
class PaginationLimit
5+
use Maize\Helpers\HelperMacro;
6+
7+
class PaginationLimit implements HelperMacro
68
{
79
public function __invoke(): \Closure
810
{

Diff for: ‎src/Macros/SanitizeUrl.php

+2-1
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,9 @@
33
namespace Maize\Helpers\Macros;
44

55
use Illuminate\Support\Str;
6+
use Maize\Helpers\HelperMacro;
67

7-
class SanitizeUrl
8+
class SanitizeUrl implements HelperMacro
89
{
910
public function __invoke(): \Closure
1011
{

0 commit comments

Comments
 (0)
Please sign in to comment.