pipes

Rohre für PHP mit einer einfachen API, die auf funktionaler Zusammensetzung basiert

Einfach ausgedrückt, nimmt es die Ausgabe des letzten und wechselt es zum nächsten. Sorta wie Bash cat ./file | grep -e 'waldo'

Installation

Sie können das Paket über Komponist installieren:

composer require inmanturbo/pipes

Oder kopieren Sie einfach die Datei functions.php aus diesem Repository.

Verwendung

Rohr()

 require __DIR__ . ' /../vendor/autoload.php ' ;

use function Inmanturbo  Pipes  pipe ;

$ addOne = fn ( $ number = 0 ) => $ number + 1 ;

$ five = pipe ( $ addOne ) // 1
    -> pipe ( fn ( $ number ) => $ number + 1 ) // 2
    -> pipe ( $ addOne ) // 3
    -> pipe ( $ addOne ) // 4
    -> thenReturn (); // 4

Es verzögert die Ausführung nicht

 $ fifty = pipe ( 1 );

    while ( $ fifty -> result () < 50 ) {
        $ fifty -> pipe ( fn ( $ number ) => ++ $ number );
    }

echo $ fifty -> result ();
// 50
     

Sie können auch eine Klasse oder eine Klassenzeichenfolge übergeben

 use function Inmanturbo  Pipes  pipe ;

class Subtract
{
    public function __invoke ( $ number )
    {
        return $ number - 1 ;
    }
}

$ addOne = fn ( $ number = 0 ) => $ number + 1 ;

$ six = pipe ( $ addOne , 1 )
    -> pipe ( $ addOne )
    -> pipe ( $ addOne )
    -> pipe ( $ addOne )
    -> then ( fn ( $ number ) => ++ $ number );

$ five = pipe ( $ six )
    -> pipe (Subtract::class)
    -> thenReturn ();

$ three = pipe ( new Subtract , $ five )
    -> pipe ( new Subtract )
    -> thenReturn ();

Rückgabeergebnisse

Die Ergebnisse können auf drei Möglichkeiten zurückgegeben werden:

then() oder thenReturn() sowohl ein abschließender Rückruf als auch zurückgegeben und das Ergebnis zurückgeben, oder result() , der das Ergebnis einfach zurückgibt.

 $ addOne = fn ( $ number = 0 ) => $ number + 1 ;

$ six = pipe ( $ addOne , 1 )
    -> pipe ( $ addOne )
    -> pipe ( $ addOne )
    -> pipe ( $ addOne )
    -> then ( fn ( $ number ) => ++ $ number );

$ sixAgain = pipe ( $ addOne , 1 )
    -> pipe ( $ addOne )
    -> pipe ( $ addOne )
    -> pipe ( $ addOne )
    -> thenReturn ( fn ( $ number ) => ++ $ number );

$ five = pipe ( $ addOne , 1 )
    -> pipe ( $ addOne )
    -> pipe ( $ addOne )
    -> pipe ( $ addOne )
    -> result ();

Die Pipeline anhalten

Halt()

Sie können halt() aus einem Rückruf zurückgeben, um die Kette zu stoppen. halt nimmt ein optionales Ergebnis als Argument, das Sie als result() der Kette verabschieden können. Nachfolgende Anrufe zu ->pipe() wirken sich nicht auf das Endergebnis aus.

    use function Inmanturbo  Pipes { pipe , halt };

    $ fortyFive = pipe ( 1 );

    $ count = 1 ;
    while ( $ count < 50 ) {
        $ fortyFive -> pipe ( fn ( $ number ) => $ number < 45 ? ++ $ number : halt ( $ number ));

        $ count ++;
    }

    echo $ fortyFive -> result ();

    // 45

    echo $ fortyFive -> pipe ( fn ( $ number ) => ++ $ number )-> result ();

    // 45

Sie können auch das Rohr selbst anrufen

    use function Inmanturbo  Pipes { pipe , halt };

    $ fortyFive = pipe ( 1 );

    $ count = 1 ;
    while ( $ count < 50 ) {
        
        if (( $ number = $ fortyFive -> result ()) >= 45 ) {
            $ fortyFive -> halt ( $ number );
        }

        $ fortyFive -> pipe ( fn ( $ number ) => ++ $ number );

        $ count ++;
    }

    echo $ fortyFive -> result ();

    // 45

    echo $ fortyFive -> pipe ( fn ( $ number ) => ++ $ number )-> result ();

    // 45 

wieder aufnehmen()

Sie können die Rohrleitungen mit Lebenslauf wieder aufnehmen. pipe()->resume() nimmt einen optionalen Rückruf und verhält sich genauso wie bei pipe()->pipe() wenn ein Rückruf übergeben wird

 use function Inmanturbo  Pipes { pipe , halt };

$ fortySix = pipe ( 1 );

$ count = 1 ;
while ( $ count < 50 ) {
    
    if (( $ number = $ fortySix -> result ()) >= 45 ) {
        $ fortySix -> halt ( $ number );
    }

    $ fortySix -> pipe ( fn ( $ number ) => ++ $ number );

    $ count ++;
}

echo $ fortySix -> result ();

// 45

echo $ fortySix -> resume ( fn ( $ number ) => ++ $ number )-> result ();

// 46 

Hop () und Laravel

Dieses Paket erfordert nicht, dass Laravel Pipe oder hop() verwendet, aber hop() (Pipe höherer Ordnung) ist eine Funktion höherer Ordnung, die für die Arbeit mit Laravels Pipeline-Helfer bestimmt ist. Diese Funktion höherer Ordnung nimmt einen Rückruf ab, der ein einziges Argument nimmt und den $callback für Sie in einer Schließung einbringt, die function($next, $passable) .

 use Illuminate  Pipeline  Pipeline ;

use function Inmanturbo  Pipes  hop ;

class Add {
    public function add ( $ number )
    {
        return $ number + 1 ;
    }
}
class InvokeAdd {
    public function __invoke ( $ number )
    {
        return $ number + 1 ;
    }
}

$ five = ( new Pipeline )-> send ( 1 )
    -> pipe ( hop ( fn ( $ number ) => $ number + 1 ))
    -> pipe ( hop ( new InvokeAdd ))
    -> pipe ( hop (InvokeAdd::class))
    -> pipe ( hop ( fn ( $ number ) => ( new Add )-> add ( $ number )))
-> thenReturn ();

// 5

Sie können optional eine einzelne middleware als zweites Argument für hop() übergeben, und es wird vor dem ersten Argument aufgerufen, mit dem Sie feststellen können, ob die Pipeline anhalten sollte, bevor der $callback jemals ausgeführt wird.

 $ limitThreeMiddleware = function ( $ number , $ next ) {
    if ( $ number >= 3 ) {
        Log:: info ( ' Limit hit ' );
        return $ number ;
    }

    return $ next ( $ number );
};

$ five = ( new Pipeline )-> send ( 1 )
    -> pipe ( hop ( fn ( $ number ) => $ number + 1 , $ limitThreeMiddleware ))
    -> pipe ( hop ( new InvokeAdd , $ limitThreeMiddleware ))
    // Limit hit
    -> pipe ( hop (InvokeAdd::class, $ limitThreeMiddleware ))
    -> pipe ( hop ( fn ( $ number ) => ( new Add )-> add ( $ number ), $ limitThreeMiddleware ))
-> thenReturn ();

// 3