https://github.com/Lambdish/phunctional

⚡️ λ PHP functional library focused on simplicity and performance
https://github.com/Lambdish/phunctional

functional functional-programming immutability map performance php php-library reduce

Last synced: about 2 months ago
JSON representation

⚡️ λ PHP functional library focused on simplicity and performance

• Host: GitHub
• URL: https://github.com/Lambdish/phunctional
• Owner: Lambdish
• License: mit
• Created: 2015-11-06T16:13:18.000Z (almost 9 years ago)
• Default Branch: master
• Last Pushed: 2023-09-25T08:59:46.000Z (12 months ago)
• Last Synced: 2024-05-17T07:42:20.923Z (4 months ago)
• Topics: functional, functional-programming, immutability, map, performance, php, php-library, reduce
• Language: PHP
• Homepage:
• Size: 193 KB
• Stars: 347
• Watchers: 22
• Forks: 42
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        




> Phunctional, because functional programming matters. 

[![Lambdish](https://img.shields.io/badge/lambdish-phunctional-red.svg?style=flat-square)](https://github.com/Lambdish) [![MIT License](https://img.shields.io/badge/license-MIT-007EC7.svg?style=flat-square)](http://opensource.org/licenses/MIT) [![Version](https://img.shields.io/packagist/v/lambdish/phunctional.svg?style=flat-square)](https://github.com/Lambdish/phunctional/releases) [![Monthly Downloads](https://poser.pugx.org/lambdish/phunctional/d/monthly)](https://packagist.org/packages/lambdish/phunctional) [![Travis Build Status](http://img.shields.io/travis/Lambdish/phunctional.svg?style=flat-square)](https://travis-ci.org/Lambdish/phunctional)

Lambdish's Phunctional is a little library that tries to bring to PHP some aspects of functional programing with __util high order functions__ and __functions for manage iterables__.




## About

Phunctional is heavily inspired by [Clojure](https://clojure.org/) and some other PHP libraries like [iter](https://github.com/nikic/iter), [compose](https://github.com/igorw/compose) and [felpado](https://github.com/pablodip/felpado).

The main principles that we have in mind developing this library are:

 * A collection can be any iterable PHP object, arrays or generators

 * Favor composition vs inheritance

 * Be lazy when you can

 * Avoid state, state is (usually) evil!

 * Simplicity over easiness

 * Break the above rules if it makes sense

All of this can be resumed with a word: __Immutability__.

## Installation

To install it with composer:

```

composer require lambdish/phunctional

```

## Simple usage

The first is to import every function you're going to use, for example:

```php

use function Lambdish\phunctional\map;

```

And then you'll be able to use it:

```php

map(

    function ($number) {

        return $number + 10;

    },

    [1, 2, 3, 4, 5]

);

// => [11, 12, 13, 14, 15]

```

And do something more complex like:

```php

use function Lambdish\Phunctional\pipe;

use const Lambdish\Phunctional\{filter_null, reverse, first};

$lastNonNullableValue = pipe(filter_null, reverse, first);

$lastNonNullableValue(['first', null, 'other', 'last non nullable', null, null]);

// => "last non nullable"

```

Here we're using the provided constants, that acts like an alias for the functions full qualified namespace

(and therefore, are `callable`).

## Documentation

You can find the functions documentation [here](docs/docs.md).