README

Quality Assurance

The above badges represent the current development branch. As a rule, I don't push to GitHub unless tests, coverage and usability are acceptable. This may not be true for short periods of time; on holiday, need code for some other downstream project etc. If you need stable code, use a tagged version. Read 'Further Documentation' and 'Installation'.

Test Contract in the docs directory.

Developer support for PHP5.4 & 5.5 was withdrawn at version 2.0.0 of this library. If you need support for PHP 5.4 or 5.5, please use a version>=1,<2

Developer support for PHP <8 was withdrawn at version 3.0.0 of this library. If you need support for PHP 7.x, please use a version>=2,<3

What?

Provides a Monadic type

According to my mentor, Monads are either difficult to explain or difficult to code, i.e. you can say how or what but not at the same time. If you need further illumination, start with wikipedia

Types supported

Monadic Interface
Abstract Monad
Identity Monad
Option Monad
- Some
- None
FTry Monad
- Success
- Failure
FMatch Monad
Collection Monad
Map Monad
Set Monad

Why?

PHP is coming under increasing attack from functional hybrid languages such as Scala. The difference is the buzzword of functional programming. PHP can support this paradigm, and this library introduces some basic monadic types. Indeed, learning functional programming practices can make solutions in PHP far more robust.

Much of the power of monadic types comes through the use of the functional FMatch, Try and For Comprehension language constructs. PHP doesn't have these. This library provides:

FMatch
FTry
FFor This is provided in the Assembly-Builder package

Key to functional programming is the use of strict typing and elevating functions as first class citizens within the language syntax. PHP5.4+ allows functions to be used as a typed parameter (Closure). It also appears that PHP devs are coming to terms with strict or hard types as the uptake of my strong-type library testifies.

How

The Monadic interface

A Monad has three things (according to my understanding of it):

a value (which may be no value at all, a simple type, an object or a function)
method of getting its value, often referred to as return()
a way of binding (or using) the value into some function, often referred to as bind(), the return value of which is another Monad, often but not always of the same type as the donor Monad. (Rarely, it could be another class type.)

The Monadic Interface supplied here defines

bind(\Closure $function, array $args = []):Monadic
- The function signature should contain at least one parameter to receive the value of the Monad. e.g. function($val){return $val * 2;} If you are using additional arguments in the $args array, you'll need to add them to the parameter list e.g.

$ret = $m->bind(function($val, $mult){return $val * $mult;}, [4]);

Bear in mind that you can use the use clause as normal when defining your function to expose external parameter values. Caveat: start using this stuff in pure Async PHP programming and you can't use the use clause. You have been warned!

value():mixed - the return() method as return is a reserved word in PHP

Additionally, two helper methods are defined for the interface

flatten():mixed - the monadic value flattened to a PHP native type or non Monadic object
static create(mixed $value):Monadic A factory method to create an instance of the concrete descendant Monad

Monads have an immutable value, that is to say, the result of the bind() method is another (Monadic) class. The original value is left alone.

The Monad Abstract class

Contains the Monad value holder and a syntatic sugar helper magic __invoke() method that proxies to value() if no parameters supplied or bind() if a Closure (with/without optional arguments) are supplied.

Neither the Monadic interface or the abstract Monad class define how to set a value on construction of a concrete Monad. It usually makes sense to set the Monad's value on construction. Therefore in most circumstances you would create concrete Monad classes with some form of constructor.

Concrete Monad classes supplied

Identity

The simplest type of Monad

use Monad\Identity;

$id = new Identity('foo');
//or
$id = Identity::create('foo');

$fConcat = function($value, $fudge){return $value . $fudge};
$concat = $id->bind($fConcat, ['bar'])
             ->bind($fConcat, ['baz']);

echo $concat->value();      //'foobarbaz'
echo $id->value();          //'foo'

Option

An Option is a polymorphic Maybe Monad that can exist in one of two states:

Some - an option with a value
None - an option with no value

As PHP does not have the language construct to create a polymorphic object by construction, you'll need to use the Option::create() static method. You can however use Option as a type hint for other class methods and returns

use Monad\Option;
use Monad\Option\Some;
use Monad\Option\None;

/**
 * @param Option $opt
 * @return Option
 */
function doSomethingWithAnOption(Option $opt) {
    if ($opt instanceof None) {
        return $opt;
    }
    
    //must be a Some
    return $opt(doMyOtherThing()); //use magic invoke to bind

}

$someOption = Option::create('foo');
$noneOption = Option::create();

$one = doSomethingWithAnOption($someOption);
$two = doSomethingWithAnOption($noneOption);

Under normal circumstances, Option uses the null value to determine whether or not to create a Some or a None; that is, the value passed into create() is tested against null. If it === null, then a None is created, else a Some. You can provide an alternative test value as a second parameter to create()

$mySome = Option::create(true, false);
$myNone = Option::create(false, false);

Once a None, always a None. No amount of binding will return anything other than a None.
On the other hand, a Some can become a None through binding, (or rather the result of the bind() as of course the original Some remains immutable.) To assist in this, Some->bind() can take an optional third parameter, which is the value to test against for None (i.e. like the optional second parameter to Option::create() )

You should also note that calling ->value() on a None will generate a RuntimeException because of course, a None does not have a value!

Other methods supported

getOrElse(mixed:elseValue) If the Option is a Some, return the Option->value() else return the elseValue

FTry

An FTry is a polymorphic Try Monad that can exist in one of two states:

Success - an FTry with a value
Failure - an FTry with a PHP Exception as a value

Try is a reserved word in PHP, so I have called this class FTry to mean Functional Try.

As PHP does not have the language construct to create a polymorphic object by construction, you'll need to use the FTry::with() (or FTry::create()) static method. You can however use FTry as a type hint for other class methods and returns

FTry::on(value) will catch any Exception incurred in processing the value, and return a Success or Failure class appropriately. This makes it ideal for the simple case of wrapping a PHP transaction in a Try - Catch block:

use Monad\FTry;
use Monad\FMatch;

FMatch::on(FTry::with($myFunction($initialValue())))
    ->Monad_FTry_Success(function ($v) {doSomethingGood($v);})
    ->Monad_FTry_Failure(
        function (\Exception $e) {
            echo "Exception: " . $e->getMessage(); 
        }
    );

A fairly simplistic example, and one where you might question its value, as it could have been written as easily using conventional PHP. But: A Success or Failure is still a Monad, and so you can still bind (map) onto the resultant class, flatten it etc.

Like Option, FTry also supports the getOrElse(mixed:elseValue) method allowing for implementing default behaviours:

echo FTry::with(myComplexPrintableTransaction())
    ->getOrElse('Sorry - that failed');

For completeness, FTry also supports isSuccess():

echo 'The colour is' . FTry::with(myTest())->isSuccess() ? 'blue' : 'red';

Once a Failure, always a Failure. However, A Success can yield either a Success or a Failure as a result of binding.

If you really want to throw the exception contained in a Failure use the pass() method

$try = FTry::with($myFunction());
if (!$try->isSuccess()) $try->pass();

FMatch

The FMatch Monad allows you to carry out type pattern matching to create powerful and dynamic functional equivalents of case statements.

'Match' is a reserved word since PHP8. Thus for V3 of this library, I've renamed Match to FMatch.

The basic syntax is

use Monad\FMatch;

$result = FMatch::on($initialValue)
            ->test()
            ->test()
            ->value();

where test() can be the name of a native PHP type or the name of a class, e.g.:

$result = FMatch::on($initialValue)
            ->string()
            ->Monad_Option()
            ->Monad_Identity()
            ->value()

You can use the FMatch::any() method to catch anything not matched by a specific matcher:

$result = FMatch::on($initialValue)
            ->string()
            ->int()
            ->any()
            ->value();

You can provide a concrete value as a parameter to each test, or a function. e.g.

$result = FMatch::on($initialValue)
              ->string('foo')
              ->Monad_Option(
                  function ($v) {
                      return FMatch::on($v)
                          ->Monad_Option_Some(function ($v) {
                              return $v->value();
                          })
                          ->Monad_Option_None(function () {
                              throw new \Exception();
                          })
                          ->value();
                      }
              )
              ->Monad_Identity(
                  function ($v) {
                      return $v->value() . 'bar';
                  }
              )
              ->any(function(){return 'any';})
              ->value();

You can find this being tested in FMatchTest::testYouCanNestFMatches()

Supported native type matches

string
integer|int|long
float|double|real
null
array
bool|boolean
callable|function|closure
file
dir|directory
object
scalar
numeric
resource

Supported class matching

Use the fully namespaced name of the class to match, substituting the backslash \ with an underscore e.g. to test for Monad\Option use Monad_Option

Collection

The Monad Collection provides a structured array that behaves as a Monad. It is based on the SPL ArrayObject.

Very important to note however is that unlike a PHP array, the Collection is type specific, i.e. you specify Collection type specifically or by default as the first member of its construction array.

Another 'gotcha': As the Collection is an object, calling Collection->value() will just return the Collection itself. If you want to get a PHP array from the Collection then use toArray() which proxies the underlying getArrayCopy() and is provided as most PHPers are familiar with toArray as being a missing 'magic' call.

Why re-invent the wheel? ArrayObject (underpinning Collection,) behaves in subtly different ways than a plain vanilla array. One: it's an object and can therefore be passed by reference, Two: because of One, it (hopefully TBC,) stops segfaults occurring in a multi thread environment. Even if Two doesn't pan out, then One still holds.

use Monad\Collection;

$c = Collection::create([1,2,3,4]);
//or
$c = Collection::create([1,2,3,4], 'integer');

//to create an empty collection, you must specify type
$c = Collection::create([], 'integer');
$c = Collection::create([], 'Monad\Option');

You can get and test a Collection:

$c = Collection::create([1,2,3,4]);
$v = $c[2] // == 3

if (!isset($c[6]) { 
... 
}

Although the Collection implements the ArrayAccess interface, trying to set or unset a value $mCollection[0] = 'foo' or unset($mCollection[0]) will throw an exception, as Collections are immutable by default. In some circumstances, you may want to change this. Use the MutableCollection to allow mutability.

As usual, this is not really a problem, as you can bind() or use each() on a Collection to return another Collection, (which can contain values of a different type.)
Wherever possible, I've expressed the Collection implementation in terms of FMatch statements, not only because it usually means tighter code, but as something that you can look at (and criticise hopefully!) by example.

You can append to a Collection, returning a new Collection

$s1 = new Collection([1,2,3]);
$s2 = $s1->append(4);
//or
$s2 = $s1->append(['foo'=>4]);

You can get the difference of two collections:

$s1 = Collection::create([1, 2, 3, 6, 7]);
$s2 = Collection::create([6,7]);
$s3 = $s1->vDiff($s2);  //difference on values
$s4 = $s1->kDiff($s2);  //difference on keys

And the intersection:

$s1 = Collection::create([1, 2, 3, 6, 7]);
$s2 = Collection::create([6,7]);
$s3 = $s1->vIntersect($s2); //intersect on values
$s4 = $s1->kIntersect($s2); //intersect on keys

uDiff, kDiff, vIntersect and kIntersect can take a second optional Closure parameter which is used as the comparator method.

You can get the union of two collections, either by value or key:

$s1 = Collection::create([1, 2, 3, 6, 7]);
$s2 = Collection::create([3, 6, 7, 8]);
$valueUnion = $s1->vUnion($s2);
$keyUnion =  $s1->kUnion($s2);

You can get the head and the tail of a collection:

$s1 = Collection::create([1, 2, 3, 6, 7]);
echo $s1->head()[0] // 1
echo $s1->tail()[0] // 2
echo $s1->tail()[3] // 7

There are four function mapping methods for a Collection:

the standard Monadic bind(), whose function takes the entire value array of the Collection as its parameter. You should return an array as a result of the function but in the event that you do not, it will be forced to a Collection.
the each() method. Like bind(), this takes a function and an optional array of additional parameter values to pass on. However, the each function is called for each member of the collection. The results of the function are collected into a new Collection and returned. In this way, it behaves rather like the PHP native array_map.
the reduce() method. Acts just like array_reduce and returns a single value as a result of function passed in as a paramter.
the filter() method. Acts just like array_filter, but returns a new Collection as a result of the reduction.

Note that you can change the base type of a resultant Collection as a result of these mapping methods().

I chose Collection as the name as it doesn't clash with list which is a PHP reserved name. In essence, Collection will to all intents and purposes be a List, but for die hard PHPers still behave as an array.

A secondary design consideration, is that you should be able to use Collection oblivious of that fact that it is a Monad, except that it is type specific.

Map

A Map is a simple extension of a Collection that requires its entries to have a string (hash) key. It obeys all the rules of a Collection except that

use Monad/Map;

$m1 = new Map(['foo']);

will not work, but

$m1 = new Map(['foo'=>'bar']);

will work. You can as usual, specify the type as a second parameter. The vUnion, vIntersect and vDiff methods are unspecified for Maps and will throw a BadMethodCallException.

Set

A Set is a simple extension of Collection that enforces the following rules

A Set can only have unique values (of the same type)
A Set doesn't care about the keys, its the values that are important
Operations on a Set return a Set

use Monad/Set;

$setA = new Set(['a','b','c']);
$setB = new Set(['a','c']);

$setC = $setA->vIntersect($setB);
$setD = $setA->vUnion($setB);
$setE = $setA->vDiff($setB);

As with a Collection, you can specify an empty construction value and a second type value. You can also append to a Set to return a new Set.

The kUnion, kIntersect and kDiff methods are unspecified for Maps and will throw a BadMethodCallException.

All other Collection methods are supported, returning Sets where expected.

The ->vIntersect(), ->vUnion() and ->diff() methods all accept a second equality function parameter as per Collection. However, for Set, if none is provided it will default to using a sane default, that is to casting non stringifiable values to a serialized hash of the value and using that for comparison. Supply your own functions if this default is inadequate for your purposes.

Further documentation

Please note that what you are seeing of this documentation displayed on Github is always the latest dev-master. The features it describes may not be in a released version yet. Please check the documentation of the version you Compose in, or download.

Test Contract in the docs directory.

Check out ZF4 Packages for more packages

UML

Changing the library

fork it
write the test
amend it
do a pull request

Found a bug you can't figure out?

fork it
write the test
do a pull request

NB. Make sure you rebase to HEAD before your pull request

Or - raise an issue ticket.

Where?

The library is hosted at Github. It is available at Packagist.org

Installation

Install Composer

For production

    "chippyash/monad": "~3.0"

Or to use the latest, possibly unstable version:

    "chippyash/monad": "dev-master"

For development

Clone this repo, and then run Composer in local repo root to pull in dependencies

    git clone git@github.com:chippyash/Monad.git Monad
    cd Monad
    composer install

To run the tests:

    cd Monad
    vendor/bin/phpunit -c test/phpunit.xml test/

Debugging

Because PHP doesn't really support functional programming at it's core level, debugging using XDebug etc becomes a nested mess. Some things I've found helpful:

isolate your tests, at least at the initial stage. If you get a problem, create a test that does one thing - the thing you are trying to debug. Use that as your start point.
be mindful of value() and flatten(), the former gets the immediate Monad value, the latter gives you a PHP fundamental.
when constructing FMatches, ensure the value contained in the FMatch conforms to the type you are expecting. Remember, FMatch returns a FMatch with a value. And yes, I've tripped up on this myself.
keep running the other tests. Seems simple, but in the headlong pursuit of your single objective, it's easy to forget that the library is interdependent (and will become increasingly so as we are able to wrap new functionality back into the original code. e.g. Collection is dependent on FMatch: when FFor is implemented, FMatch will change.) Run the whole test suite on a regular basis. That way you catch anything that has broken upstream functionality. This library will be complete when it, as far as possible, expresses itself in terms of itself!
the tests that are in place are there for a good reason: open an issue if you think they are wrong headed, misguided etc

License

This software library is released under the BSD 3 Clause license

This software library contains code items that are derived from other works:

None of the contained code items breaks the overriding license, or vice versa, as far as I can tell. If at all unsure, please seek appropriate advice.

If the original copyright owners of the derived code items object to this inclusion, please contact the author.

Thanks

I didn't do this by myself. I'm deeply indebted to those that trod the path before me.

The following have done work on which this library is based:

Sean Crystal

Anthony Ferrara

Johannes Schmidt

History

V1.0.0 Initial Release

V1.1.0 Added FTry

V1.2.0 Added Collection

V1.2.1 fixes on Collection

V1.2.2 add sort order for vUnion method

V1.2.3 allow descendent monadic types

V1.2.4 add each() method to Collection

V1.2.5 move from coveralls to codeclimate

V1.2.6 Add link to packages

V1.2.7 Code cleanup - verify PHP7 compatibility

V1.3.0 Collection is immutable. Added MutableCollection for convenience

V1.4.0 Add Map class - enforced string type keys for collection members

   Add convenience method append() to Collection === ->vUnion(new Collection([$nValue]))

V1.5.0 Add Set class

V1.5.1 Add additional checking for Maps and Sets. diff() and intersect() deprecated, use the kDiff(), uDiff, kIntersect() and uIntersect() methods;

V1.5.2 build script update

V1.5.3 update composer - forced by packagist composer.json format change

V2.0.0 BC Break. Support for PHP <5.6 withdrawn

V2.0.1 fixes for PHP >= 7.1

V2.1.0 Change of license from GPL V3 to BSD 3 Clause

V2.1.1 Flatten value in the bind method of FTry, so in case the binded function returns a Success, we do not end up with nested Success. PR by josselinauguste

V3.0.0 BC Break. Support for PHP <8 withdrawn. Match renamed to FMatch.

chippyash / monad

Maintainers

Details