edmondscommerce/typesafe-functions

Type safe wrappers around internal functions that return mixed types

0.2 2019-06-13 15:53 UTC

Requires

• php: ^7.2
• ext-curl: *
• ext-json: *

Requires (Dev)

• edmondscommerce/phpqa: ^2.0
• mockery/mockery: ^1.2
• phpstan/phpstan-mockery: ^0.11.0

MIT

README

To assist with boilerplate around working with internal functions but ensuing that your code keeps tools like phpstan and phpqa happy

See Alternative:

https://github.com/thecodingmachine/safe

This is a more comprehensive library of functions that is auto generated.

I prefer to only include functions that I actually use in this library, the vast majority of functions above will never be used and so I'm reluctant to bring them all in.

Functions Replaced:

File Functions

file_get_contents

returns false|string by default

replaced with \ts\file_get_contents

String Functions

strpos

returns false|int by default

multiple replacements depending on use case:

\ts\strpos to get the actual string position when it is known that the haystack contains the needle

\ts\stringContains to check if the haystack contains the needle

\ts\stringStartsWith to check if the haystack begins with the needle

stripos

//TODO - but will be as above, but case insensitive

Array Functions

in_array

By default this is not strict and requires a third parameter of true.

Simply replace with \ts\arrayContains instead to have this handled automatically.

This improves readability and also prevents various mutation testing escapees that would be otherwise hard to catch

Find: (|\\)in_array\((.+?),(.+?),.+?\)

Replace: \\ts\\arrayContains($2, $3)

Debug Functions

print_r

When passing true, this returns a string, for example

<?php
$string=\print_r(['a'=>1], true);

To make this type safe, we replace with

<?php
$string = \ts\varToString(['a'=>1]);

Reflection

ReflectionClass

Always returns a single type

Normalises the type, for example to empty strings or throws exceptions on failure

Find Replace

Find	Replace
new \ReflectionClass	new \ts\Reflection\ReflectionClass
: \ReflectionClass	: \ts\Reflection\ReflectionClass
@var \ReflectionClass	@var \ts\Reflection\ReflectionClass
(\ReflectionClass $	(\ts\Reflection\ReflectionClass $
@param \ReflectionClass $	@param \ts\Reflection\ReflectionClass $