PHP Functional Programming library. Monads and common use functions.
$ composer require whsv26/functional
To improve type inference for particular functions
$ vendor/bin/psalm-plugin enable Fp\\Psalm\\FunctionalPlugin
whsv26@whsv26:~$ sudo apt install pandoc
whsv26@whsv26:~$ make
This PR aim to fix wrong type inference for Option and Either assertion methods.
Example of correct inference:
/**
* @return Option<int>
*/
function getOption(): Option
{
return Option::none();
}
/** @psalm-param (Some<int>) $_some */
function assertIsSome($_some): void {}
/** @psalm-param (None) $_none */
function assertIsNone($_none): void {}
function test(): void
{
$opt = getOption();
if ($opt->isSome()) {
assertIsSome($opt); // $opt is Some<int> at this point
} else {
assertIsNone($opt); // $opt is None, before it was Option<int>
}
}
Been thinking about function but_last, like this
I am not sure if this function is necessary. Also we just may code something like this:
$withoutLast = \Fp\Collection\reverse(
\Fp\Collection\tail(
\Fp\Collection\reverse($collection)
)
);
// or simplified version
$withoutLast = reverse(tail(reverse($collection)));
Maybe native function but_last would be more understandable and less resource consuming?
I would be pleasured to hear your opinion.
Just noticed that Option::get() may return null value.
Are there any specific reasons for this behavior?
I mean, there are other implementations of Option and non of them do return null value.
Java
public T get() {
if (value == null) {
throw new NoSuchElementException("No value present");
}
return value;
}
Scala
def get: Nothing = throw new NoSuchElementException("None.get")
Rust
pub fn unwrap(self) -> T {
match self {
Some(val) => val,
None => panic!("called `Option::unwrap()` on a `None` value"),
}
}
Maybe there is a contract for Option to have that kind of behavior?
Greetings, sir.
Just got a few thoughts about implementing method match on Option and Either.
This would look like
Option:
$hello = Option::of('Hello');
$result = $hello->match(
some: fn(string $v) => "{$v} world",
none: fn() => 'Hello from none'
);
Either:
/** @var Either<string, FooInterface> $found */
$found = Some::of(new FooImpl());
$found->match(
right: \Fp\id,
left: function(string $errorMessage) {
// sorry for side effect here
$this->logger->logWarning($errorMessage);
return new BarImpl();
},
);
So the method signature would look like:
Option:
/**
* @template TR
* @param callable(A): TR $some
* @param callable(): TR $none
* @return TR
*/
public function match(callable $some, callable $none): mixed
{
Either:
/**
* @template TR
* @param callable(R): TR $right
* @param callable(L): TR $left
* @return TR
*/
public function match(callable $right, callable $left): mixed
{
I think this may be useful. What do you think?
In some cases it may be useful to use few functions inside pure context.
Example:
/**
* @psalm-immutable
*/
class Foo
{
/**
* @var list<Bar>
*/
public array $bars;
public function __construct(Bar $first, Bar ...$rest)
{
// Impure method call issue occurred here (because Foo is immutable, so requires pure context)
$this->bars = asList([$first], $rest);
}
}
Of course, there are more ways to compile list, but if we have asList why wouldn't we use it whenever we want?
I was just thinking about function asList, maybe there are few others function that are actually pure but not annotated yet
/**
* @return list<array{mixed, Either<string, int>}>
*/
function getValues() { ... }
$values = getValues();
$res = partition($values, static function (array $v) {
[, $either] = $v; // type of $v is lost somewhere, it actually is array<TKey: array-key, TValue: mixed>
return $either instanceof Right;
});
// but for $res variable - type inference would work correctly
/**
* Returns value from $array by $path if present
*
* @param non-empty-list<string> $path
* @psalm-pure
*/
function dotAccess(array $path, array $array): Option
{
$key = $path[0];
$rest = array_slice($path, offset: 1);
if (empty($rest) && array_key_exists($key, $array)) {
return Option::of($array[$key]);
}
if (array_key_exists($key, $array) && is_array($array[$key])) {
return dotAccess($rest, $array[$key]);
}
return new None();
}
$arr = [
'person' => [
'name' => 'Jhon',
'address' => null,
],
];
// Prints Some('Jhon') - good
print_r(dotAccess(['person', 'name'], $arr));
// Prints None - not good
print_r(dotAccess(['person', 'address'], $arr));
This snippet type checks by psalm, but at runtime it fails:
/**
* @return Option<stdClass>
*/
function toSomething(mixed $_): Option
{
return Option::none();
}
$items = [];
Option::do(function() use ($items) {
$mapped = [];
/** @psalm-suppress MixedAssignment */
foreach ($items as $item) {
$mapped[] = yield toSomething($item);
}
return $mapped;
});
PHP Fatal error: Uncaught Error: Call to a member function isEmpty() on null in /home/app/vendor/whsv26/functional/src/Fp/Functional/Option/Option.php:82
Stack trace:
#0 /home/app/run.php(26): Fp\Functional\Option\Option::do()
#1 {main}
thrown in /home/app/vendor/whsv26/functional/src/Fp/Functional/Option/Option.php on line 82
Process finished with exit code 255
This only happens if no yield has been called in Option::do.
Currently there is no way to change left side of the Either.
Syntactic example where it can be useful:
/**
* @return Either<ApplicationError, OrderOutput>
*/
function createOrder(OrderInput $input, OrderService $service): Either
{
return $service->create($input)
->map(fn(Order $o) => OrderOutput::from($o))
->mapLeft(fn(OrderError $e) => ApplicationError::from($e));
// map concrete domain error to more generic error
}
If you run the following piece of code, it will lead to a runtime error:
<?php
use Fp\Functional\Either\Right;
use Fp\Functional\Either\Left;
use function Fp\Json\jsonDecode;
require __DIR__ . '/vendor/autoload.php';
$decoded = jsonDecode('"kek"')
->map(fn(array $val) => array_merge($val, ['lol' => '_']));
PHP Fatal error: Uncaught TypeError: {closure}(): Argument #1 ($val) must be of type array, string given, called in /home/php/whsv26/functional/src/Fp/Functional/Either/Either.php on line 83 and defined in /home/php/whsv26/functional/run.php:12
Stack trace:
#0 /home/php/whsv26/functional/src/Fp/Functional/Either/Either.php(83): {closure}()
#1 /home/php/whsv26/functional/run.php(15): Fp\Functional\Either\Either->flatMap()
#2 {main}
thrown in /home/php/whsv26/functional/run.php on line 12
Because json_decode can deserialize literals like numbers, strings, booleans.
/**
* @param ArrayList<int> $numbers
*/
function test(ArrayList $numbers): void {}
/**
* @return ArrayList<int>
*/
function getNumbers(): ArrayList
{
return ArrayList::empty();
}
/**
ERROR: MixedArgumentTypeCoercion
at /app/run.php:34:5
Argument 1 of test expects Fp\Collections\ArrayList<int>, parent type Fp\Collections\ArrayList<int|mixed> provided (see https://psalm.dev/194)
getNumbers()->prepended(getNumbers())
*/
test(
getNumbers()->prependedAll(getNumbers())
);
contains: Checks if a value exists in an collection.sequenceEitherMerged: Same as sequenceEither, but merge all errors to non-empty-list.Either::filterOrElse: Passing R to the $left callbackproveUnion($mixed, [proveInt(...), proveNull(...)]) (inferred as Option<int|null>).string|int to enum instance.In addition to new functionality, this release contains backwards-incompatible changes. Read about BC here: https://github.com/fp4php/functional/blob/master/UPGRADING-v5.md
groupBy + map combinatorgroupBy + map + fold combinatorHashMapfirst but use Option data type instead boollast but use Option data type instead bool$callback now is optional. Will be use default PHP comparison mechanism without $callback.iterable<iterable<T>> to iterable<T>Seq<T> to Seq<array{int, T}>Streamarray_merge but as methodtoMergedArraymapN, flatMapN and others...)min and minBy methods has been addedmax and maxBy methods has been addedgroupMapReduce function has been addedImprove type assertions (isLeft/isRight, isSome/isNone, isValid/isInvalid)
Source code(tar.gz)Fix psalm plugin bug for filter function refinement.
Either::getOrThrowStream::sorted operation has been addedOption::when and Option::unless have been addedOption::cond and Option::condLazy. Use Option::whenintersect operationintersect operationdiff operationdiff operation>>> HashSet::collect([1, 2, 3])
->intersect(HashSet::collect([2, 3]))->toArray();
=> [2, 3]
>>> HashSet::collect([1, 2, 3])
->diff(HashSet::collect([2, 3]))->toArray();
=> [1]
asPairs functionasPairsGenerator function>>> asPairs(['a' => 1, 'b' => 2]);
=> [['a', 1], ['b', 2]]
>>> Stream::emits(asPairsGenerator(['a' => 1, 'b' => 2]));
=> [['a', 1], ['b', 2]]
toAssocArray cast>>> Stream::emits([[1, 'a'], [2, 'b']])->toAssocArray(fn($pair) => $pair);
=> [1 => 'a', 2 => 'b']
Option::fold and Either::fold signatures.Option::toArrayList cast method.>>> Option::some(1)
->toArrayList(ArrayList::singleton(...))
->toArray();
=> [1]
>>> Option::some([1])
->toArrayList(ArrayList::collect(...))
->toArray();
=> [1]
>>> Option::none()
->toArrayList(ArrayList::collect(...))
->toArray();
=> []
getOrThrow method>>> Option::some(1)->getOrThrow(fn() => new RuntimeException('???'));
=> 1
>>> Option::none()->getOrThrow(fn() => new RuntimeException('???'));
RuntimeException with message '???'
Fix Either::flatMap signature by @klimick in #45
range collector for Seq0|positive-int with int for range start and stop parameters.>>> ArrayList::range(0, 10, 2)->toArray();
=> [0, 2, 4, 6, 8]
>>> ArrayList::range(0, 3)->toArray();
=> [0, 1, 2]
>>> ArrayList::range(0, 0)->toArray();
=> []
lastOf operation for Seq and NonEmptySeqmkString operation for Seq and Stream>>> LinkedList::collect([1, 2, 3])->mkString()
=> '1,2,3'
>>> LinkedList::collect([1, 2, 3])->mkString("(", ",", ")")
=> '(1,2,3)'
>>> LinkedList::collect([])->mkString("(", ",", ")")
=> '()'
toAssocArray cast for Map>>> HashMap::collectPairs([['a', 1], ['b', 2]])->toAssocArray();
=> Some(['a' => 1, 'b' => 2])
>>> ArrayList::collect([['a', 1], ['b', 2]])->toHashMap(fn($entry) => entry)->toAssocArray();
=> Some(['a' => 1, 'b' => 2])
>>> HashMap::collectPairs([[new Foo(), 1], [new Foo(), 2]])->toAssocArray();
=> None
toNonEmptyArrayList cast for Stream and Seqsingleton and empty collectors for Seqintersperse and zip operations have been added for Seq implementationsStream class has been added. See Streams overviewMap/NonEmptyMap static storage support has been added. See README.md examplesOption::filterOf has been addedOption::tap has been addedOption::flatTap has been addedat function bugOption::condLazy has been addedEither::condLazy has been addedValidated::condLazy has been addedOption::cond method has been addedtap collection operation has been addedSet::subsetOf, NonEmptySet::subsetOf operations have been addedSeq::sorted, NonEmptySeq::sorted methods have been addedobjectOf and classOf functions have been addedEither::try method unsoundness. Change Left type up to ThrowableisSequence functionany, anyOf with exists, existsOfexists function unsoundness. Change needle with just predicate callable.reduceNel, reduceNer functionsfold and reduce function signaturespluck function plugin support for object-like arraysNonEmptySeqOps::groupBy operation has been addedpartitionOf return type generalization via psalm pluginMap::get method return type refining from OptionMap::every signature. Replace Value+key arguments with Entry argumentgetIterator methods for interfaces for better foreach supportNonEmptyHashMap has been addedSemigroup and Monoid instance fabric methods from abstract classesgetNamedTypes function.Semigroup and Monoid instances for collection classesfilterMap operation has been added [by @klimick]group function to groupBytail function return type from array to listMap::reindex to Map::mapKeys. Add Map::mapValues alias for Map::map methodbutLast functionIndexedSeq and LinearSeq interfaces with just Seq interfaceNonEmptyIndexedSeq and NonEmptyLinearSeq interfaces with just NonEmptySeq interface$rhs to $that for HashContractEmptyCollectionException with Option for non-empty collect methodsHashMap::collecIterable to HashMap::collect and HashMap::collect to HashMap::collectPairsHotfix for v3.0.0.
PHP code scanner to use with gettext/gettext
ABOUT TOOL : SPAMX is a all in one Bombing+Spam tool from this tool you can send anonymous messages to your target without showing your real number an
Ubench Ubench is a PHP micro library for benchmark Installation Note: If you are looking for this package for laravel application then install it from
sebastian/lines-of-code Library for counting the lines of code in PHP source code. Installation You can add this library as a local, per-project depen
PHPMD PHPMD is a spin-off project of PHP Depend and aims to be a PHP equivalent of the well known Java tool PMD. PHPMD can be seen as an user friendly
Searching PHP source code made easy Search PHP source code for function & method calls, variable assignments, classes and more directly from PHP. Inst
About PHP_CodeSniffer is a set of two PHP scripts; the main phpcs script that tokenizes PHP, JavaScript and CSS files to detect violations of a define
Phan is a static analyzer for PHP that prefers to minimize false-positives. Phan attempts to prove incorrectness rather than correctness. Phan looks f
PhpMetrics PhpMetrics provides metrics about PHP project and classes, with beautiful and readable HTML report. Documentation | Twitter | Contributing
Better Reflection Better Reflection is a reflection API that aims to improve and provide more features than PHP's built-in reflection API. Why is it b
Welcome to Dissect! master - this branch always contains the last stable version. develop - the unstable development branch. Dissect is a set of tools
Phpactor This project aims to provide heavy-lifting refactoring and introspection tools which can be used standalone or as the backend for a text edit
Rector - Speedup Your PHP Development Rector helps you with 2 areas - major code changes and in daily work. Do you have a legacy code base? Do you wan
Deptrac is a static code analysis tool for PHP that helps you communicate, visualize and enforce architectural decisions in your projects. You can freely define your architectural layers over classes and which rules should apply to them.
phpcs-security-audit v3 About phpcs-security-audit is a set of PHP_CodeSniffer rules that finds vulnerabilities and weaknesses related to security in
PHP Parser This is a PHP 5.2 to PHP 8.0 parser written in PHP. Its purpose is to simplify static code analysis and manipulation. Documentation for ver
PHPPHP A PHP VM implementation written in PHP. This is a basic VM implemented in PHP using the AST generating parser developed by @nikic To see what's
sebastian/environment This component provides functionality that helps writing PHP code that has runtime-specific (PHP / HHVM) execution paths. Instal
A full-scale PHP 7.4+ sandbox class that utilizes PHP-Parser to prevent sandboxed code from running unsafe code. It also utilizes FunctionParser to di
12 Nov 11, 2022
449 Jan 7, 2023
554 Nov 25, 2022
715 Jan 5, 2023
2.1k Jan 8, 2023
22 Nov 24, 2022
9.9k Jan 4, 2023
5.4k Jan 7, 2023
2.3k Dec 22, 2022
1.1k Dec 15, 2022
221 Nov 29, 2022
882 Jan 1, 2023
6.5k Jan 8, 2023
2.2k Dec 30, 2022
655 Jan 3, 2023
15.9k Jan 3, 2023
801 Dec 25, 2022
192 Dec 10, 2022