README

functional programming utilities for PHP ! Inspired by Ramda, Javascript, lodash and many other things !

Why ?

• Because PHP lacks of simple and easy-to-use utilities for functional programming !
• To prove that we can still have fun with PHP (despite the fact that it's PHP) !!!

Installation

composer require boehm_s/fun

How to use it ?

You can review the API Documentation

Or, if you're familiar with Ramda, you can start writing code right now. As with Ramda, fun-php methods are automatically curried :

F::map($fn, $array)   ⇔   F::map($fn)($array)   ⇔   F::map()($fn)($array)

Also placeholders are implemented. fun-php placeholder is F::_ :

F::map(F::_, $array)($fn)   ⇔   F::map($fn)(F::_)($array)   ⇔   F::map(F::_)($fn)($array)

Example

{
  "items": [{
      "id":1,
      "type":"train",
      "users":[
        { "id":1, "name":"Jimmy Page"},
        { "id":5, "name":"Roy Harper"}
      ]
    }, {
      "id":421,
      "type":"hotel",
      "users":[
        { "id":1, "name":"Jimmy Page" }, 
        { "id":2, "name":"Robert Plant" }
      ]
    }, {
      "id":876,
      "type":"flight",
      "users":[
        { "id":3, "name":"John Paul Jones" },
        { "id":4, "name":"John Bonham" }
      ]
    }]
}

Get all users names

$get_all_users_names = F::pipe(
    F::prop('items'),
    F::flatMap(F::prop('users')),
    F::map(F::prop('name')),
    F::uniq()
);

$travel = json_decode($travelJSON);

$travels_users = $get_all_users_names($travel);

var_dump($travels_users);  //  ["Jimmy Page", "Roy Harper", "Robert Plant", "John Paul Jones", "John Bonham"]

Implemented methods

fun-php is just a bunch of static methods. To use them, juste prefix the following functions with F::

For Lists / Arrays

For Objects / Associative arrays

For function composition

Logical operations

Notes (to myself)

Deploying the doc :

git subtree push --prefix doc/dist/html origin gh-pages