pipes

Tuberías para PHP con una API simple basada en la composición funcional

En pocas palabras, toma la salida del último y la vaya al siguiente. Como cat ./file | grep -e 'waldo'

Instalación

Puede instalar el paquete a través del compositor:

composer require inmanturbo/pipes

O simplemente copie o descargue el archivo functions.php de este repositorio.

Uso

tubo()

 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

No retrasa la ejecución

 $ fifty = pipe ( 1 );

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

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

También puede pasar una clase o una cadena de clase

 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 ();

Resultados de regreso

Los resultados se pueden devolver de tres maneras:

then() o thenReturn() Tanto una devolución de llamada final como devuelva el resultado, o result() , que simplemente devuelve el resultado.

 $ 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 ();

Detener la tubería

detener()

Puede devolver halt() de una devolución de llamada para detener la cadena. halt toma un resultado opcional como argumento que puede pasar como result() de la cadena. Las llamadas posteriores a ->pipe() no afectarán el resultado final.

    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

También puede llamar al detenerse en la tubería en sí

    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 

reanudar()

Puede reanudar la tubería con currículum. pipe()->resume() toma una devolución de llamada opcional y se comporta lo mismo que pipe()->pipe() si se pasa una devolución de llamada

 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 () y Laravel

Este paquete no requiere que Laravel use Pipe o hop() , pero hop() (Pipe de orden superior) es una función de orden superior destinada a trabajar con el ayudante de tubería de Laravel. Esta función de orden superior requiere una devolución de llamada que toma un solo argumento y envuelve la $callback en un cierre que implementa 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

Opcionalmente, puede pasar un solo middleware como segundo argumento para hop() , y se llamará antes del primer argumento, lo que le permite determinar si la tubería debe detenerse antes de que la $callback se ejecute.

 $ 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