namespace WPForms\Helpers;
use BadFunctionCallException;
* Chain monad, useful for chaining a certain array or string related functions.
* @method Chain array_change_key_case()
* @method Chain array_chunk()
* @method Chain array_column()
* @method Chain array_combine()
* @method Chain array_count_values()
* @method Chain array_diff_assoc()
* @method Chain array_diff_key()
* @method Chain array_diff_uassoc()
* @method Chain array_diff_ukey()
* @method Chain array_diff(array $var)
* @method Chain array_fill_keys()
* @method Chain array_fill()
* @method Chain array_filter()
* @method Chain array_flip()
* @method Chain array_intersect_assoc()
* @method Chain array_intersect_key()
* @method Chain array_intersect_uassoc()
* @method Chain array_intersect_ukey()
* @method Chain array_intersect(array $var)
* @method Chain array_key_first()
* @method Chain array_key_last()
* @method Chain array_keys()
* @method Chain array_map()
* @method Chain array_merge_recursive()
* @method Chain array_merge(array $var)
* @method Chain array_pad()
* @method Chain array_pop()
* @method Chain array_product()
* @method Chain array_rand()
* @method Chain array_reduce()
* @method Chain array_replace_recursive()
* @method Chain array_replace()
* @method Chain array_reverse()
* @method Chain array_shift()
* @method Chain array_slice()
* @method Chain array_splice()
* @method Chain array_sum()
* @method Chain array_udiff_assoc()
* @method Chain array_udiff_uassoc()
* @method Chain array_udiff()
* @method Chain array_uintersect_assoc()
* @method Chain array_uintersect_uassoc()
* @method Chain array_uintersect()
* @method Chain array_unique()
* @method Chain array_values()
* @method Chain current()
* @method Chain str_getcsv()
* @method Chain str_ireplace()
* @method Chain str_pad()
* @method Chain str_repeat()
* @method Chain str_rot13()
* @method Chain str_shuffle()
* @method Chain str_split()
* @method Chain str_word_count()
* @method Chain strcasecmp()
* @method Chain strcoll()
* @method Chain strcspn()
* @method Chain strip_tags()
* @method Chain stripcslashes()
* @method Chain stripos()
* @method Chain stripslashes()
* @method Chain stristr()
* @method Chain strnatcasecmp()
* @method Chain strnatcmp()
* @method Chain strncasecmp()
* @method Chain strncmp()
* @method Chain strpbrk()
* @method Chain strrchr()
* @method Chain strripos()
* @method Chain strrpos()
* @method Chain strtolower()
* @method Chain strtoupper()
* @method Chain substr_compare()
* @method Chain substr_count()
* @method Chain substr_replace()
* @method Chain ucfirst()
* @method Chain ucwords()
* @method Chain vfprintf()
* @method Chain vprintf()
* @method Chain vsprintf()
* @method Chain wordwrap()
* @param mixed $value Current value to start working with.
public function __construct( $value ) {
* Bind some function to value.
* @param mixed $fn Some function.
public function bind( $fn ) {
$this->value = $fn( $this->value );
public function value() {
* @param string $name Method name.
* @param array $params Parameters.
* @throws BadFunctionCallException Invalid function is called.
public function __call( $name, $params ) {
if ( in_array( $name, $this->allowed_methods(), true ) ) {
$params = $params === null ? [] : $params;
array_unshift( $params, $this->value );
$this->value = call_user_func_array( $name, array_values( $params ) );
throw new BadFunctionCallException( esc_html( "Provided function { $name } is not allowed. See Chain::allowed_methods()." ) );
* Join array elements with a string.
* @param string $glue Defaults to an empty string.
public function implode( $glue = '' ) {
$this->value = implode( $glue, $this->value );
* Split a string by a string.
* @param string $delimiter The boundary string.
public function explode( $delimiter ) {
$this->value = explode( $delimiter, $this->value );
* Apply the callback to the elements of the given arrays.
* @param callable $cb Callback.
public function map( $cb ) {
$this->value = array_map( $cb, $this->value );
$this->value = array_pop( $this->value );
* Run first or second callback based on a condition.
* @param callable $condition Condition function.
* @param callable $true_result If condition will return true we run this function.
* @param callable $false_result If condition will return false we run this function.
public function iif( $condition, $true_result, $false_result = null ) {
if ( ! is_callable( $false_result ) ) {
$false_result = function() {
$this->value = array_map(
function( $el ) use ( $condition, $true_result, $false_result ) {
if ( call_user_func( $condition, $el ) ) {
return call_user_func( $true_result, $el );
return call_user_func( $false_result, $el );
* All allowed methods to work with data.
public function allowed_methods() {
'array_intersect_uassoc',
'array_replace_recursive',
'array_uintersect_assoc',
'array_uintersect_uassoc',
* @param mixed $value Current.
public static function of( $value = null ) {
return new self( $value );