lodash php
0.1.0
Lodash-PHP é uma porta da biblioteca Lodash JS para PHP. É um conjunto de funções utilitárias fáceis de usar para projetos PHP diários.
Lodash-PHP tenta imitar lodash.js o mais próximo possível
Lodash-PHP requer no mínimo PHP 7.2+, mas a versão mais recente do PHP é sempre recomendada.
Instale o Lodash-PHP através do compositor:
$ composer require lodash-php/lodash-phpCada método no Lodash-PHP é uma função separada que pode ser importada e usada sozinha.
<?php
use function _ each ;
each ([ 1 , 2 , 3 ], function ( int $ item ) {
var_dump ( $ item );
}); Lodash-PHP também vem com uma classe _ global que pode ser usada globalmente.
<?php
_:: each ([ 1 , 2 , 3 ], function ( int $ item ) {
var_dump ( $ item );
}); Cria uma matriz de elementos divididos em grupos com o comprimento de size . Se array não puder ser dividida uniformemente, a parte final serão os elementos restantes.
Argumentos:
@param array $array array O array a ser processado.
@param int $number [size=1] O comprimento de cada pedaço
Retornar:
@return array Retorna o novo array de pedaços.
Exemplo:
<?php
use function _ chunk ;
chunk ([ ' a ' , ' b ' , ' c ' , ' d ' ], 2 )
// => [['a', 'b'], ['c', 'd']]
chunk ([ ' a ' , ' b ' , ' c ' , ' d ' ], 3 )
// => [['a', 'b', 'c'], ['d']] Cria uma matriz com todos os valores falsey removidos. Os valores false , null , 0 , "" , undefined e NaN são falsey.
Argumentos:
@param array $array O array a ser compactado.
Retornar:
@return array Retorna o novo array de valores filtrados.
Exemplo:
<?php
use function _ compact ;
compact ([ 0 , 1 , false , 2 , '' , 3 ])
// => [1, 2, 3] Cria um novo array concatenando array com quaisquer arrays e/ou valores adicionais.
Argumentos:
@param array $array O array a ser concatenado.
@param array<int, mixed> $values Os valores a serem concatenados.
Retornar:
@return array Retorna o novo array concatenado.
Exemplo:
<?php
use function _ concat ;
$ array = [ 1 ];
$ other = concat ( $ array , 2 , [ 3 ], [[ 4 ]]);
var_dump ( $ other )
// => [1, 2, 3, [4]]
var_dump ( $ array )
// => [1] Cria uma matriz de valores array não incluídos nas outras matrizes fornecidas usando SameValueZero para comparações de igualdade. A ordem e as referências dos valores dos resultados são determinadas pela primeira matriz.
Nota: Ao contrário de pullAll , este método retorna um novo array.
Argumentos:
@param array $array O array a ser inspecionado.
@param array ...$values Os valores a serem excluídos.
Retornar:
@return array Retorna o novo array de valores filtrados.
Exemplo:
<?php
use function _ difference ;
difference ([ 2 , 1 ], [ 2 , 3 ])
// => [1] Este método é semelhante à difference exceto que aceita iteratee que é invocado para cada elemento do array e values para gerar o critério pelo qual eles são comparados. A ordem e as referências dos valores dos resultados são determinadas pela primeira matriz. O iteratee é invocado com um argumento: (valor).
Nota: Ao contrário de pullAllBy , este método retorna um novo array.
Argumentos:
@param array $array O array a ser inspecionado.
@param array<int, mixed> ...$values Os valores a serem excluídos.
@param callable $iteratee O iteratee invocado por elemento.
Retornar:
@return array Retorna o novo array de valores filtrados.
Exemplo:
<?php
use function _ differenceBy ;
differenceBy ([ 2.1 , 1.2 ], [ 2.3 , 3.4 ], ' floor ' )
// => [1.2] Este método é semelhante à difference , exceto que aceita comparator que é invocado para comparar elementos do array com values . A ordem e as referências dos valores dos resultados são determinadas pela primeira matriz. O comparador é invocado com dois argumentos: (arrVal, othVal).
Nota: Ao contrário de pullAllWith , este método retorna um novo array.
Argumentos:
@param array<int, mixed> $array O array a ser inspecionado.
@param array ...$values Os valores a serem excluídos.
@param callable $comparator O comparador invocado por elemento.
Retornar:
@return array Retorna o novo array de valores filtrados.
Exemplo:
<?php
use function _ differenceWith ;
$ objects = [[ ' x ' => 1 , ' y ' => 2 ], [ ' x ' => 2 , ' y ' => 1 ]]
differenceWith ( $ objects , [[ ' x ' => 1 , ' y ' => 2 ]], ' _::isEqual ' )
// => [[ 'x' => 2, 'y' => 1 ]] Cria uma fatia do array com n elementos eliminados desde o início.
NOTA: Esta função irá reordenar e redefinir os índices do array
Argumentos:
@param array $array O array a ser consultado.
@param int $n O número de elementos a serem eliminados.
Retornar:
@return array a fatia do array .
Exemplo:
<?php
use function _ drop ;
drop ([ 1 , 2 , 3 ])
// => [2, 3]
drop ([ 1 , 2 , 3 ], 2 )
// => [3]
drop ([ 1 , 2 , 3 ], 5 )
// => []
drop ([ 1 , 2 , 3 ], 0 )
// => [1, 2, 3] Cria uma fatia da array com n elementos eliminados do final. NOTA: Esta função irá reordenar e redefinir os índices do array
Argumentos:
@param array $array O array a ser consultado.
@param int $n O número de elementos a serem eliminados.
Retornar:
@return array a fatia do array .
Exemplo:
<?php
use function _ dropRight ;
dropRight ([ 1 , 2 , 3 ])
// => [1, 2]
dropRight ([ 1 , 2 , 3 ], 2 )
// => [1]
dropRight ([ 1 , 2 , 3 ], 5 )
// => []
dropRight ([ 1 , 2 , 3 ], 0 )
// => [1, 2, 3] Cria uma fatia da array excluindo os elementos eliminados do final. Os elementos são eliminados até que predicate retorne falsey. O predicado é invocado com três argumentos: (valor, índice, array).
Argumentos:
@param array $array O array a ser consultado.
@param callable $predicate A função invocada por iteração.
Retornar:
@return array a fatia do array .
Exemplo:
<?php
use function _ dropRightWhile ;
$ users = [
[ ' user ' => ' barney ' , ' active ' => false ],
[ ' user ' => ' fred ' , ' active ' => true ],
[ ' user ' => ' pebbles ' , ' active ' => true ]
]
dropRightWhile ( $ users , function ( $ user ) { return $ user [ ' active ' ]; })
// => objects for ['barney'] Cria uma fatia da array excluindo os elementos eliminados desde o início. Os elementos são eliminados até que predicate retorne falsey. O predicado é invocado com três argumentos: (valor, índice, array).
Argumentos:
@param array $array O array a ser consultado.
@param callable $predicate A função invocada por iteração.
Retornar:
@return array a fatia do array .
Exemplo:
<?php
use function _ dropWhile ;
$ users = [
[ ' user ' => ' barney ' , ' active ' => true ],
[ ' user ' => ' fred ' , ' active ' => true ],
[ ' user ' => ' pebbles ' , ' active ' => false ]
]
dropWhile ( $ users , function ( $ user ) { return $ user [ ' active ' ]; } )
// => objects for ['pebbles'] Verifica se predicate retorna verdadeiro para todos os elementos do array . A iteração é interrompida quando predicate retorna falsey. O predicado é invocado com três argumentos: (valor, índice, array).
Nota: Este método retorna true para arrays vazios porque tudo é verdadeiro para elementos de arrays vazios.
Argumentos:
@param iterable $collection O array para iterar.
@param callable $predicate A função invocada por iteração.
Retornar:
@return bool true se todos os elementos passarem na verificação de predicado, caso contrário, false .
Exemplo:
<?php
use function _ every ;
every ([ true , 1 , null , ' yes ' ], function ( $ value ) { return is_bool ( $ value );})
// => false
$ users = [
[ ' user ' => ' barney ' , ' age ' => 36 , ' active ' => false ],
[ ' user ' => ' fred ' , ' age ' => 40 , ' active ' => false ],
];
// The `matches` iteratee shorthand.
$ this -> assertFalse ( every ( $ users , [ ' user ' => ' barney ' , ' active ' => false ]));
// false
// The `matchesProperty` iteratee shorthand.
$ this -> assertTrue ( every ( $ users , [ ' active ' , false ]));
// true
// The `property` iteratee shorthand.
$ this -> assertFalse ( every ( $ users , ' active ' ));
//false
Este método é como find , exceto que retorna o índice do primeiro elemento, o predicado retorna verdadeiro em vez do próprio elemento.
Argumentos:
@param array $array O array a ser inspecionado.
@param callable $predicate A função invocada por iteração.
@param int $fromIndex O índice a partir do qual pesquisar.
Retornar:
@return int o índice do elemento encontrado, caso contrário -1 .
Exemplo:
<?php
use function _ findIndex ;
$ users = [
[ ' user ' => ' barney ' , ' active ' => false ],
[ ' user ' => ' fred ' , ' active ' => false ],
[ ' user ' => ' pebbles ' , ' active ' => true ],
];
findIndex ( $ users , function ( $ o ) { return $ o [ ' user ' ] s== ' barney ' ; });
// => 0
// The `matches` iteratee shorthand.
findIndex ( $ users , [ ' user ' => ' fred ' , ' active ' => false ]);
// => 1
// The `matchesProperty` iteratee shorthand.
findIndex ( $ users , [ ' active ' , false ]);
// => 0
// The `property` iteratee shorthand.
findIndex ( $ users , ' active ' );
// => 2 Este método é como findIndex exceto que itera sobre os elementos da collection da direita para a esquerda.
Argumentos:
@param array $array O array a ser inspecionado.
@param mixed $predicate A função invocada por iteração.
@param int $fromIndex O índice a partir do qual pesquisar.
Retornar:
@return int o índice do elemento encontrado, caso contrário -1 .
Exemplo:
<?php
use function _ findLastIndex ;
$ users = [
[ ' user ' => ' barney ' , ' active ' => true ],
[ ' user ' => ' fred ' , ' active ' => false ],
[ ' user ' => ' pebbles ' , ' active ' => false ]
]
findLastIndex ( $ users , function ( $ user ) { return $ user [ ' user ' ] === ' pebbles ' ; })
// => 2 Achata array com um único nível de profundidade.
Argumentos:
@param array $array O array a ser nivelado.
Retornar:
@return array o novo array achatado.
Exemplo:
<?php
use function _ flatten ;
flatten ([ 1 , [ 2 , [ 3 , [ 4 ]], 5 ]])
// => [1, 2, [3, [4]], 5] Achata recursivamente array .
Argumentos:
@param array $array O array a ser nivelado.
Retornar:
@return array Retorna o novo array nivelado.
Exemplo:
<?php
use function _ flattenDeep ;
flattenDeep ([ 1 , [ 2 , [ 3 , [ 4 ]], 5 ]]);
// => [1, 2, 3, 4, 5] Achatar recursivamente array até os tempos depth .
Argumentos:
@param array $array O array a ser nivelado.
@param int $profundidade A profundidade máxima de recursão.
Retornar:
@return array o novo array achatado.
Exemplo:
<?php
use function _ flattenDepth ;
$ array = [ 1 , [ 2 , [ 3 , [ 4 ]], 5 ]]
flattenDepth ( $ array , 1 )
// => [1, 2, [3, [4]], 5]
flattenDepth ( $ array , 2 )
// => [1, 2, 3, [4], 5] O inverso de toPairs , este método retorna um objeto composto de pairs chave-valor.
Argumentos:
@param array $pairs Os pares de valores-chave.
Retornar:
@return stdClass o novo objeto.
Exemplo:
<?php
use function _ fromPairs ;
fromPairs ([[ ' a ' , 1 ], [ ' b ' , 2 ]])
// => stdClass(
// 'a' => 1,
//'b' => 2,
// ) Obtém o primeiro elemento do array .
Argumentos:
@param array $array O array a ser consultado.
Retornar:
@return misto Retorna o primeiro elemento do array .
Exemplo:
<?php
use function _ head ;
head ([ 1 , 2 , 3 ])
// => 1
head ([])
// => null Obtém o índice no qual a primeira ocorrência de value é encontrada na array usando SameValueZero para comparações de igualdade. Se fromIndex for negativo, será usado como deslocamento do final de array .
Argumentos:
@param array $array O array a ser inspecionado.
@param mixed $value O valor a ser pesquisado.
@param int $fromIndex O índice a partir do qual pesquisar.
Retornar:
@return int o índice do valor correspondente, caso contrário -1 .
Exemplo:
<?php
use function _ indexOf ;
indexOf ([ 1 , 2 , 1 , 2 ], 2 )
// => 1
// Search from the `fromIndex`.
indexOf ([ 1 , 2 , 1 , 2 ], 2 , 2 )
// => 3 Obtém tudo, exceto o último elemento do array .
Argumentos:
@param array $array O array a ser consultado.
Retornar:
@return array a fatia do array .
Exemplo:
<?php
use function _ initial ;
initial ([ 1 , 2 , 3 ])
// => [1, 2] Cria uma matriz de valores exclusivos que são incluídos em todas as matrizes fornecidas usando SameValueZero para comparações de igualdade. A ordem e as referências dos valores dos resultados são determinadas pela primeira matriz.
Argumentos:
@param matriz ...$matrizes
Retornar:
@return array o novo array de valores que se cruzam.
Exemplo:
<?php
use function _ intersection ;
intersection ([ 2 , 1 ], [ 2 , 3 ])
// => [2] Este método é como intersection , exceto que aceita iteratee que é invocado para cada elemento de cada arrays para gerar o critério pelo qual eles são comparados. A ordem e as referências dos valores dos resultados são determinadas pela primeira matriz. O iteratee é invocado com um argumento: (valor).
Argumentos:
@param array<int, misto> ...$arrays
@param callable $iteratee O iteratee invocado por elemento.
Retornar:
@return array o novo array de valores que se cruzam.
Exemplo:
<?php
use function _ intersectionBy ;
intersectionBy ([ 2.1 , 1.2 ], [ 2.3 , 3.4 ], Math.floor)
// => [2.1]
// The `property` iteratee shorthand.
intersectionBy ([[ ' x ' => 1 ]], [[ ' x ' => 2 ], [ ' x ' => 1 ]], ' x ' );
// => [[ 'x' => 1 ]] Este método é como intersection , exceto que aceita comparator que é invocado para comparar elementos de arrays . A ordem e as referências dos valores dos resultados são determinadas pela primeira matriz. O comparador é invocado com dois argumentos: (arrVal, othVal).
Argumentos:
@param matriz ...$matrizes
@param callable $comparator O comparador invocado por elemento.
Retornar:
@return array o novo array de valores que se cruzam.
Exemplo:
<?php
use function _ intersectionWith ;
$ objects = [[ ' x ' => 1 , ' y ' => 2 ], [ ' x ' => 2 , ' y ' => 1 ]]
$ others = [[ ' x ' => 1 , ' y ' => 1 ], [ ' x ' => 1 , ' y ' => 2 ]]
intersectionWith ( $ objects , $ others , ' _::isEqual ' )
// => [[ 'x' => 1, 'y' => 2 ]] Obtém o último elemento do array .
Argumentos:
@param array $array O array a ser consultado.
Retornar:
@return misto Retorna o último elemento do array .
Exemplo:
<?php
use function _ last ;
last ([ 1 , 2 , 3 ])
// => 3 Este método é como indexOf , exceto que itera sobre os elementos do array da direita para a esquerda.
Argumentos:
@param array $array O array a ser inspecionado.
@param mixed $value O valor a ser pesquisado.
@param int $fromIndex O índice a partir do qual pesquisar.
Retornar:
@return int o índice do valor correspondente, caso contrário -1 .
Exemplo:
<?php
use function _ lastIndexOf ;
lastIndexOf ([ 1 , 2 , 1 , 2 ], 2 )
// => 3
// Search from the `fromIndex`.
lastIndexOf ([ 1 , 2 , 1 , 2 ], 2 , 2 )
// => 1 Obtém o elemento no índice n do array . Se n for negativo, o enésimo elemento do final será retornado.
Argumentos:
@param array $array O array a ser consultado.
@param int $n O índice do elemento a ser retornado.
Retornar:
@return misto Retorna o enésimo elemento do array .
Exemplo:
<?php
use function _ nth ;
$ array = [ ' a ' , ' b ' , ' c ' , ' d ' ]
nth ( $ array , 1 )
// => 'b'
nth ( $ array , - 2 )
// => 'c' Remove todos os valores fornecidos do array usando SameValueZero para comparações de igualdade.
Nota: Ao contrário de without , este método altera array . Use remove para remover elementos de uma matriz por predicado.
Argumentos:
@param array $array O array a ser modificado.
@param array<int, string> $values Os valores a serem removidos.
Retornar:
matriz @return
Exemplo:
<?php
use function _ pull ;
$ array = [ ' a ' , ' b ' , ' c ' , ' a ' , ' b ' , ' c ' ]
pull ( $ array , ' a ' , ' c ' )
var_dump ( $ array )
// => ['b', 'b'] Este método é semelhante pull exceto que aceita uma matriz de valores para remover.
Nota: Ao contrário de difference , este método altera array .
Argumentos:
@param array $array O array a ser modificado.
@param array $values Os valores a serem removidos.
Retornar:
@return array matriz.
Exemplo:
<?php
use function _ pullAll ;
$ array = [ ' a ' , ' b ' , ' c ' , ' a ' , ' b ' , ' c ' ]
pullAll ( $ array , [ ' a ' , ' c ' ])
var_dump ( $ array )
// => ['b', 'b'] Este método é como pullAll exceto que aceita iteratee que é invocado para cada elemento do array e values para gerar o critério pelo qual eles são comparados. O iteratee é invocado com um argumento: (valor).
Nota: Ao contrário de differenceBy , este método altera array .
Argumentos:
@param array $array O array a ser modificado.
@param array $values Os valores a serem removidos.
@param callable $iteratee O iteratee invocado por elemento.
Retornar:
@return array matriz.
Exemplo:
<?php
use function _ pullAllBy ;
$ array = [[ ' x ' => 1 ], [ ' x ' => 2 ], [ ' x ' => 3 ], [ ' x ' => 1 ]]
pullAllBy ( $ array , [[ ' x ' => 1 ], [ ' x ' => 3 ]], ' x ' )
var_dump ( $ array )
// => [[ 'x' => 2 ]] Este método é como pullAll exceto que aceita comparator que é invocado para comparar elementos do array com values . O comparador é invocado com dois argumentos: (arrVal, othVal).
Nota: Ao contrário de differenceWith , este método altera array .
Argumentos:
@param array $array O array a ser modificado.
@param array $values Os valores a serem removidos.
@param callable $comparator O comparador invocado por elemento.
Retornar:
@return array matriz.
Exemplo:
<?php
use function _ pullAllWith ;
$ array = [[ ' x ' => 1 , ' y ' => 2 ], [ ' x ' => 3 , ' y ' => 4 ], [ ' x ' => 5 , ' y ' => 6 ]]
pullAllWith ( $ array , [[ ' x ' => 3 , ' y ' => 4 ]], ' _isEqual ' )
var_dump ( $ array )
// => [[ 'x' => 1, 'y' => 2 ], [ 'x' => 5, 'y' => 6 ]] Remove elementos do array correspondente aos indexes e retorna um array de elementos removidos.
Nota: Ao contrário de at , este método altera array .
Argumentos:
@param array $array O array a ser modificado.
@param (int | int[]) $indexes Os índices dos elementos a serem removidos.
Retornar:
@return array o novo array de elementos removidos.
Exemplo:
<?php
use function _ pullAt ;
$ array = [ ' a ' , ' b ' , ' c ' , ' d ' ]
$ pulled = pullAt ( $ array , [ 1 , 3 ])
var_dump ( $ array )
// => ['a', 'c']
var_dump ( $ pulled )
// => ['b', 'd'] Remove todos os elementos da array para a qual predicate retorna verdadeiro e retorna uma matriz dos elementos removidos. O predicado é invocado com três argumentos: (valor, índice, array).
Nota: Ao contrário de filter , este método altera array . Use pull para extrair elementos de uma matriz por valor.
Argumentos:
@param array $array O array a ser modificado.
@param callable $predicate A função invocada por iteração.
Retornar:
@return array o novo array de elementos removidos.
Exemplo:
<?php
use function _ remove ;
$ array = [ 1 , 2 , 3 , 4 ]
$ evens = remove ( $ array , function ( $ n ) { return $ n % 2 === 0 ; })
var_dump ( $ array )
// => [1, 3]
var_dump ( $ evens )
// => [2, 4] Obtém um elemento aleatório de array .
Argumentos:
@param array $array O array a ser amostrado.
Retornar:
@return misto Retorna o elemento aleatório.
Exemplo:
<?php
use function _ sample ;
sample ([ 1 , 2 , 3 , 4 ])
// => 2 Obtém n elementos aleatórios em chaves exclusivas de array até o tamanho de array .
Argumentos:
@param array $array O array a ser amostrado.
@param int $n O número de elementos a serem amostrados.
Retornar:
@return array os elementos aleatórios.
Exemplo:
<?php
use function _ sampleSize ;
sampleSize ([ 1 , 2 , 3 ], 2 )
// => [3, 1]
sampleSize ([ 1 , 2 , 3 ], 4 )
// => [2, 3, 1]Cria uma matriz de valores embaralhados
Argumentos:
@param array $array O array a ser embaralhado.
Retornar:
@return array o novo array embaralhado.
Exemplo:
<?php
use function _ shuffle ;
shuffle ([ 1 , 2 , 3 , 4 ])
// => [4, 1, 3, 2] Cria uma fatia da array desde start até, mas não incluindo, end .
Argumentos:
@param array $array O array a ser dividido.
@param int $start A posição inicial.
@param int $end A posição final.
Retornar:
@return array a fatia do array .
Obtém tudo, exceto o primeiro elemento do array .
Argumentos:
@param array $array O array a ser consultado.
Retornar:
@return array a fatia do array .
Exemplo:
<?php
use function _ tail ;
tail ([ 1 , 2 , 3 ])
// => [2, 3] Cria uma fatia do array com n elementos retirados do início.
Argumentos:
@param array $array O array a ser consultado.
@param int $n O número de elementos a serem obtidos.
Retornar:
@return array a fatia do array .
Exemplo:
<?php
use function _ take ;
take ([ 1 , 2 , 3 ])
// => [1]
take ([ 1 , 2 , 3 ], 2 )
// => [1, 2]
take ([ 1 , 2 , 3 ], 5 )
// => [1, 2, 3]
take ([ 1 , 2 , 3 ], 0 )
// => [] Cria uma fatia do array com n elementos retirados do final.
Argumentos:
@param array $array O array a ser consultado.
@param int $n O número de elementos a serem obtidos.
Retornar:
@return array a fatia do array .
Exemplo:
<?php
use function _ takeRight ;
takeRight ([ 1 , 2 , 3 ])
// => [3]
takeRight ([ 1 , 2 , 3 ], 2 )
// => [2, 3]
takeRight ([ 1 , 2 , 3 ], 5 )
// => [1, 2, 3]
takeRight ([ 1 , 2 , 3 ], 0 )
// => [] Cria uma fatia do array com elementos retirados do final. Os elementos são obtidos até que predicate retorne falsey. O predicado é invocado com três argumentos: (valor, índice, array).
Argumentos:
@param array $array O array a ser consultado.
@param callable $predicate A função invocada por iteração.
Retornar:
@return array a fatia do array .
Exemplo:
<?php
use function _ takeRightWhile ;
$ users = [
[ ' user ' => ' barney ' , ' active ' => false ],
[ ' user ' => ' fred ' , ' active ' => true ],
[ ' user ' => ' pebbles ' , ' active ' => true ]
];
takeRightWhile ( $ users , function ( $ value ) { return $ value [ ' active ' ]; })
// => objects for ['fred', 'pebbles'] Cria uma fatia do array com elementos retirados do início. Os elementos são obtidos até que predicate retorne falsey. O predicado é invocado com três argumentos: (valor, índice, array).
Argumentos:
@param array $array O array a ser consultado.
@param mixed $predicate A função invocada por iteração.
Retornar:
@return array a fatia do array .
Exemplo:
<?php
use function _ takeWhile ;
$ users = [
[ ' user ' => ' barney ' , ' active ' => true ],
[ ' user ' => ' fred ' , ' active ' => true ],
[ ' user ' => ' pebbles ' , ' active ' => false ]
]
takeWhile ( $ users , function ( $ value ) { return $ value [ ' active ' ]; })
// => objects for ['barney', 'fred'] Cria uma matriz de valores exclusivos, em ordem, de todas as matrizes fornecidas usando SameValueZero para comparações de igualdade.
Argumentos:
@param array ...$arrays Os arrays a serem inspecionados.
Retornar:
@return array o novo array de valores combinados.
Exemplo:
<?php
use function _ union ;
union ([ 2 ], [ 1 , 2 ])
// => [2, 1] Este método é como union , exceto que aceita iteratee que é invocado para cada elemento de cada arrays para gerar o critério pelo qual a exclusividade é calculada. Os valores dos resultados são escolhidos na primeira matriz em que o valor ocorre. O iteratee é invocado com um argumento: (valor).
Argumentos:
@param array<int, mixed> ...$arrays Os arrays a serem inspecionados.
@param callable $iteratee O iteratee invocado por elemento.
Retornar:
@return array o novo array de valores combinados.
Exemplo:
<?php
use function _ unionBy ;
unionBy ([ 2.1 ], [ 1.2 , 2.3 ], ' floor ' )
// => [2.1, 1.2]
// The `_::property` iteratee shorthand.
unionBy ([[ ' x ' => 1 ]], [[ ' x ' => 2 ], [ ' x ' => 1 ]], ' x ' );
// => [['x' => 1], ['x' => 2]] Este método é como union , exceto que aceita comparator que é invocado para comparar elementos de arrays . Os valores dos resultados são escolhidos na primeira matriz em que o valor ocorre. O comparador é invocado com dois argumentos: (arrVal, othVal).
Argumentos:
@param array<int, mixed> ...$arrays Os arrays a serem inspecionados.
@param callable $comparator O comparador invocado por elemento.
Retornar:
@return array o novo array de valores combinados.
Exemplo:
<?php
use function _ unionWith ;
$ objects = [[ ' x ' => 1 , ' y ' => 2 ], [ ' x ' => 2 , ' y ' => 1 ]]
$ others = [[ ' x ' => 1 , ' y ' => 1 ], [ ' x ' => 1 , ' y ' => 2 ]]
unionWith ( $ objects , $ others , ' _::isEqual ' )
// => [['x' => 1, 'y' => 2], ['x' => 2, 'y' => 1], ['x' => 1, 'y' => 1]] Cria uma versão livre de duplicatas de um array, usando SameValueZero para comparações de igualdade, na qual apenas a primeira ocorrência de cada elemento é mantida. A ordem dos valores dos resultados é determinada pela ordem em que ocorrem na matriz.
Argumentos:
@param array $array O array a ser inspecionado.
Retornar:
@return array o novo array livre duplicado.
Exemplo:
<?php
use function _ uniq ;
uniq ([ 2 , 1 , 2 ])
// => [2, 1]s Este método é como uniq exceto que aceita iteratee que é invocado para cada elemento do array para gerar o critério pelo qual a exclusividade é calculada. A ordem dos valores dos resultados é determinada pela ordem em que ocorrem na matriz. O iteratee é invocado com um argumento: (valor).
Argumentos:
@param array $array O array a ser inspecionado.
@param mixed $iteratee O iteratee invocado por elemento.
Retornar:
@return array o novo array livre duplicado.
Exemplo:
<?php
use function _ uniqBy ;
uniqBy ([ 2.1 , 1.2 , 2.3 ], ' floor ' )
// => [2.1, 1.2] Este método é como uniq exceto que aceita comparator que é invocado para comparar elementos de array . A ordem dos valores dos resultados é determinada pela ordem em que ocorrem na matriz. O comparador é invocado com dois argumentos: (arrVal, othVal).
Argumentos:
@param array $array O array a ser inspecionado.
@param callable $comparator O comparador invocado por elemento.
Retornar:
@return array o novo array livre duplicado.
Exemplo:
<?php
use function _ uniqWith ;
$ objects = [[ ' x ' => 1 , ' y ' => 2 ], [ ' x ' => 2 , ' y ' => 1 ], [ ' x ' => 1 , ' y ' => 2 ]]
uniqWith ( $ objects , ' _::isEqual ' )
// => [['x' => 1, 'y' => 2], ['x' => 2, 'y' => 1]] Este método é como zip exceto que aceita uma matriz de elementos agrupados e cria uma matriz reagrupando os elementos em sua configuração pré-zip.
Argumentos:
@param array $array O array de elementos agrupados a serem processados.
Retornar:
@return array o novo array de elementos reagrupados.
Exemplo:
<?php
use function _ unzip ;
$ zipped = zip ([ ' a ' , ' b ' ], [ 1 , 2 ], [ true , false ])
// => [['a', 1, true], ['b', 2, false]]
unzip ( $ zipped )
// => [['a', 'b'], [1, 2], [true, false]] Este método é como unzip exceto que aceita iteratee para especificar como os valores reagrupados devem ser combinados. O iteratee é invocado com os elementos de cada grupo: (...grupo).
Argumentos:
@param array $array O array de elementos agrupados a serem processados.
@param (callable | null) $iteratee A função para combinar valores reagrupados.
Retornar:
@return array o novo array de elementos reagrupados.
Exemplo:
<?php
use function _ unzipWith ;
$ zipped = zip ([ 1 , 2 ], [ 10 , 20 ], [ 100 , 200 ])
// => [[1, 10, 100], [2, 20, 200]]
unzipWith (zipped, ' _::add ' )
// => [3, 30, 300] Cria uma matriz excluindo todos os valores fornecidos usando SameValueZero para comparações de igualdade.
Nota: Ao contrário de pull , este método retorna um novo array.
Argumentos:
@param array $array O array a ser inspecionado.
@param array<int, mixed> $values Os valores a serem excluídos.
Retornar:
@return array o novo array de valores filtrados.
Exemplo:
<?php
use function _ without ;
without ([ 2 , 1 , 2 , 3 ], 1 , 2 )
// => [3]Cria uma matriz de elementos agrupados, o primeiro dos quais contém os primeiros elementos das matrizes fornecidas, o segundo contém os segundos elementos das matrizes fornecidas e assim por diante.
Argumentos:
@param array ...$arrays Os arrays a serem processados.
Retornar:
@return array o novo array de elementos agrupados.
Exemplo:
<?php
use function _ zip ;
zip ([ ' a ' , ' b ' ], [ 1 , 2 ], [ true , false ])
// => [['a', 1, true], ['b', 2, false]] Este método é como fromPairs exceto que aceita dois arrays, um de identificadores de propriedade e um de valores correspondentes.
Argumentos:
@param array $props Os identificadores de propriedade.
@param array $values Os valores das propriedades.
Retornar:
@return object o novo objeto.
Exemplo:
<?php
use function _ zipObject ;
zipObject ([ ' a ' , ' b ' ], [ 1 , 2 ])
/* => object(stdClass) #210 (2) {
[ " a " ] => int( 1 )
[ " b " ] => int( 2 )
}
*/ Este método é semelhante ao zipObject exceto pelo fato de oferecer suporte a caminhos de propriedades.
Argumentos:
@param array $props Os identificadores de propriedade.
@param array $values Os valores das propriedades.
Retornar:
@return stdClass o novo objeto.
Exemplo:
<?php
use function _ zipObjectDeep ;
zipObjectDeep ([ ' a.b[0].c ' , ' a.b[1].d ' ], [ 1 , 2 ])
/* => class stdClass #20 (1) {
public $ a => class stdClass #19 (1) {
public $ b =>
array ( 2 ) {
[ 0 ] => class stdClass #17 (1) {
public $ c => int( 1 )
}
[ 1 ] => class stdClass #18 (1) {
public $ d => int( 2 )
}
}
}
}
*/ Este método é como zip , exceto que aceita iteratee para especificar como os valores agrupados devem ser combinados. O iteratee é invocado com os elementos de cada grupo: (...group).
Argumentos:
@param array<int, (array | callable)> ...$arrays Os arrays a serem processados.
@param callable $iteratee A função para combinar valores agrupados.
Retornar:
@return array o novo array de elementos agrupados.
Exemplo:
<?php
use function _ zipWith ;
zipWith ([ 1 , 2 ], [ 10 , 20 ], [ 100 , 200 ], function ( $ a , $ b , $ c ) { return $ a + $ b + $ c ; })
// => [111, 222] Cria um array composto por chaves geradas a partir dos resultados da execução de cada elemento da collection por meio de iteratee . O valor correspondente de cada chave é o número de vezes que a chave foi retornada por iteratee . O iteratee é invocado com um argumento: (valor).
Argumentos:
@param iterable $collection A coleção a ser iterada.
@param callable $iteratee O iterativo para transformar chaves.
Retornar:
@return array Retorna o objeto agregado composto.
Exemplo:
<?php
use function _ countBy ;
countBy ([ 6.1 , 4.2 , 6.3 ], ' floor ' );
// => ['6' => 2, '4' => 1]
// The `property` iteratee shorthand.
countBy ([ ' one ' , ' two ' , ' three ' ], ' strlen ' );
// => ['3' => 2, '5' => 1] Itera sobre elementos da collection e invoca iteratee para cada elemento. O iteratee é invocado com três argumentos: (valor, índice|chave, coleção). As funções Iteratee podem sair da iteração mais cedo retornando explicitamente false .
Nota: Tal como acontece com outros métodos de "Coleções", os objetos com uma propriedade "comprimento" são iterados como matrizes. Para evitar esse comportamento, use forIn ou forOwn para iteração de objetos.
Argumentos:
@param (array | iterable | object) $collection A coleção sobre a qual iterar.
@param callable $iteratee A função invocada por iteração.
Retornar:
@return (array | object) Retorna collection .
Exemplo:
<?php
use function _ each ;
each ([ 1 , 2 ], function ( $ value ) { echo $ value ; })
// => Echoes `1` then `2`.
each (( object ) [ ' a ' => 1 , ' b ' => 2 ], function ( $ value , $ key ) { echo $ key ; });
// => Echoes 'a' then 'b' (iteration order is not guaranteed). Este método é semelhante each , exceto que itera sobre os elementos da collection da direita para a esquerda.
Argumentos:
@param (array | iterable | object) $collection A coleção sobre a qual iterar.
@param callable $iteratee A função invocada por iteração.
Retornar:
@return (array | object) Retorna collection .
Exemplo:
<?php
use function _ eachRight ;
eachRight ([ 1 , 2 ], function ( $ value ) { echo $ value ; })
// => Echoes `2` then `1`. Itera sobre elementos de array , retornando uma matriz de todos os elementos para os quais predicate retorna verdadeiro. O predicado é invocado com três argumentos: (valor, índice, array).
Nota: Ao contrário de remove , este método retorna um novo array.
Argumentos:
@param iterable $array O array para iterar.
@param callable $predicate A função invocada por iteração.
Retornar:
@return array o novo array filtrado.
Exemplo:
<?php
use function _ filter ;
$ users = [
[ ' user ' => ' barney ' , ' age ' => 36 , ' active ' => true ],
[ ' user ' => ' fred ' , ' age ' => 40 , ' active ' => false ]
];
filter ( $ users , function ( $ o ) { return ! $ o [ ' active ' ]; });
// => objects for ['fred']
// The `matches` iteratee shorthand.
filter ( $ users , [ ' age ' => 36 , ' active ' => true ]);
// => objects for ['barney']
// The `matchesProperty` iteratee shorthand.
filter ( $ users , [ ' active ' , false ]);
// => objects for ['fred']
// The `property` iteratee shorthand.
filter ( $ users , ' active ' );
// => objects for ['barney'] Itera sobre os elementos da collection , retornando o predicate do primeiro elemento para o qual o predicado retorna verdadeiro. O predicado é invocado com três argumentos: (valor, índice|chave, coleção).
Argumentos:
@param iterable $collection A coleção a ser inspecionada.
@param callable $predicate A função invocada por iteração.
@param int $fromIndex O índice a partir do qual pesquisar.
Retornar:
@return mixed Retorna o elemento correspondente, caso contrário null .
Exemplo:
<?php
use function _ find ;
$ users = [
[ ' user ' => ' barney ' , ' age ' => 36 , ' active ' => true ],
[ ' user ' => ' fred ' , ' age ' => 40 , ' active ' => false ],
[ ' user ' => ' pebbles ' , ' age ' => 1 , ' active ' => true ]
];
find ( $ users , function ( $ o ) { return $ o [ ' age ' ] < 40 ; });
// => object for 'barney'
// The `matches` iteratee shorthand.
find ( $ users , [ ' age ' => 1 , ' active ' => true ]);
// => object for 'pebbles'
// The `matchesProperty` iteratee shorthand.
find ( $ users , [ ' active ' , false ]);
// => object for 'fred'
// The `property` iteratee shorthand.
find ( $ users , ' active ' );
// => object for 'barney' Este método é semelhante ao find , exceto que ele itera sobre os elementos da collection da direita para a esquerda.
Argumentos:
@param iterable $collection A coleção a ser inspecionada.
@param callable $predicate A função invocada por iteração.
@param int $fromIndex O índice a partir do qual pesquisar.
Retornar:
@return misto Retorna o elemento correspondente, caso contrário, undefined .
Exemplo:
<?php
use function _ findLast ;
findLast ([ 1 , 2 , 3 , 4 ], function ( $ n ) { return $ n % 2 == 1 ; })
// => 3 Cria uma matriz nivelada de valores executando cada elemento na collection por meio de iteratee e nivelando os resultados mapeados. O iteratee é invocado com três argumentos: (valor, índice|chave, coleção).
Argumentos:
@param iterable $collection A coleção a ser iterada.
@param callable $iteratee A função invocada por iteração.
Retornar:
@return array o novo array achatado.
Exemplo:
<?php
use function _ flatMap ;
function duplicate ( $ n ) {
return [ $ n , $ n ]
}
flatMap ([ 1 , 2 ], ' duplicate ' )
// => [1, 1, 2, 2] Este método é como flatMap , exceto que nivela recursivamente os resultados mapeados.
Argumentos:
@param iterable $collection A coleção a ser iterada.
@param callable $iteratee A função invocada por iteração.
Retornar:
@return array Retorna o novo array nivelado.
Exemplo:
<?php
use function _ flatMapDeep ;
function duplicate ( $ n ) {
return [[[ $ n , $ n ]]];
}
flatMapDeep ([ 1 , 2 ], ' duplicate ' );
// => [1, 1, 2, 2] Este método é como flatMap , exceto que nivela recursivamente os resultados mapeados até os tempos depth .
Argumentos:
@param iterable $collection A coleção a ser iterada.
@param callable $iteratee A função invocada por iteração.
@param int $profundidade A profundidade máxima de recursão.
Retornar:
@return array o novo array achatado.
Exemplo:
<?php
use function _ flatMapDepth ;
function duplicate ( $ n ) {
return [[[ $ n , $ n ]]]
}
flatMapDepth ([ 1 , 2 ], ' duplicate ' , 2 )
// => [[1, 1], [2, 2]] Cria um array composto por chaves geradas a partir dos resultados da execução de cada elemento da collection por meio de iteratee . A ordem dos valores agrupados é determinada pela ordem em que ocorrem na collection . O valor correspondente de cada chave é um array de elementos responsáveis pela geração da chave. O iteratee é invocado com um argumento: (valor).
Argumentos:
@param iterable $collection A coleção a ser iterada.
@param callable $iteratee O iterativo para transformar chaves.
Retornar:
@return array Retorna o objeto agregado composto.
Exemplo:
<?php
use function _ groupBy ;
groupBy ([ 6.1 , 4.2 , 6.3 ], ' floor ' );
// => ['6' => [6.1, 6.3], '4' => [4.2]]
groupBy ([ ' one ' , ' two ' , ' three ' ], ' strlen ' );
// => ['3' => ['one', 'two'], '5' => ['three']] Invoca o método no path de cada elemento da collection , retornando uma matriz dos resultados de cada método invocado. Quaisquer argumentos adicionais são fornecidos para cada método invocado. Se path for uma função, this será invocada e vinculada a cada elemento em collection .
Argumentos:
@param iterable $collection A coleção a ser iterada.
@param (array | callable | string) $path O caminho do método a ser invocado ou da função invocada por iteração.
@param array $args Os argumentos para invocar cada método.
Retornar:
@return array o array de resultados.
Exemplo:
<?php
use function _ invokeMap ;
invokeMap ([[ 5 , 1 , 7 ], [ 3 , 2 , 1 ]], function ( $ result ) { sort ( $ result ); return $ result ;})
// => [[1, 5, 7], [1, 2, 3]]
invokeMap ([ 123 , 456 ], ' str_split ' )
// => [['1', '2', '3'], ['4', '5', '6']] Cria um objeto composto por chaves geradas a partir dos resultados da execução de cada elemento da collection por meio de iteratee . O valor correspondente de cada chave é o último elemento responsável por gerar a chave. O iteratee é invocado com um argumento: (valor).
Argumentos:
@param iterable $collection A coleção a ser iterada.
@param callable $iteratee O iterativo para transformar chaves.
Retornar:
@return array o objeto agregado composto.
Exemplo:
<?php
use function _ keyBy ;
$ array = [
[ ' direction ' => ' left ' , ' code ' => 97 ],
[ ' direction ' => ' right ' , ' code ' => 100 ],
];
keyBy ( $ array , function ( $ o ) { return chr ( $ o [ ' code ' ]); })
// => ['a' => ['direction' => 'left', 'code' => 97], 'd' => ['direction' => 'right', 'code' => 100]]
keyBy ( $ array , ' direction ' );
// => ['left' => ['direction' => 'left', 'code' => 97], 'right' => ['direction' => 'right', 'code' => 100]] Cria uma matriz de valores executando cada elemento da collection por meio de iteratee . O iteratee é invocado com três argumentos: (valor, índice|chave, coleção).
Muitos métodos lodash-php são protegidos para funcionar como iterativos para métodos como _::every , _::filter , _::map , _::mapValues , _::reject e _::some .
Os métodos protegidos são: ary , chunk , curry , curryRight , drop , dropRight , every , fill , invert , parseInt , random , range , rangeRight , repeat , sampleSize , slice , some , sortBy , split , take , takeRight , template , trim , trimEnd , trimStart e words
Argumentos:
@param (array | object) $collection A coleção a ser iterada.
@param (callable | string | array) $iteratee A função invocada por iteração.
Retornar:
@return array Retorna o novo array mapeado.
Exemplo:
<?php
use function _ map ;
function square ( int $ n ) {
return $ n * $ n ;
}
map ([ 4 , 8 ], $ square );
// => [16, 64]
map (( object ) [ ' a ' => 4 , ' b ' => 8 ], $ square );
// => [16, 64] (iteration order is not guaranteed)
$ users = [
[ ' user ' => ' barney ' ],
[ ' user ' => ' fred ' ]
];
// The `property` iteratee shorthand.
map ( $ users , ' user ' );
// => ['barney', 'fred'] Este método é como sortBy , exceto que permite especificar as ordens de classificação dos iterados pelos quais classificar. Se orders não forem especificados, todos os valores serão classificados em ordem crescente. Caso contrário, especifique uma ordem de "desc" para decrescente ou "asc" para ordem de classificação crescente dos valores correspondentes.
Argumentos:
@param (iterable | null) $collection A coleção a ser iterada.
@param (array[] | callable[] | string[]) $iteratee O(s) iteratee(s) pelos quais classificar.
@param string[] $orders As ordens de classificação dos iteratees .
Retornar:
@return array o novo array classificado.
Exemplo:
<?php
use function _ orderBy ;
$ users = [
[ ' user ' => ' fred ' , ' age ' => 48 ],
[ ' user ' => ' barney ' , ' age ' => 34 ],
[ ' user ' => ' fred ' , ' age ' => 40 ],
[ ' user ' => ' barney ' , ' age ' => 36 ]
]
// Sort by `user` in ascending order and by `age` in descending order.
orderBy ( $ users , [ ' user ' , ' age ' ], [ ' asc ' , ' desc ' ])
// => [['user' => 'barney', 'age' => 36], ['user' => 'barney', 'age' => 34], ['user' => 'fred', 'age' => 48], ['user' => 'fred', 'age' => 40]] Cria uma matriz de elementos divididos em dois grupos, o primeiro dos quais contém elementos para os quais predicate retorna verdadeiro, o segundo contém elementos para os quais predicate retorna falso. O predicado é invocado com um argumento: (valor).
Argumentos:
@param iterable $collection A coleção a ser iterada.
@param callable $predicate A função invocada por iteração.
Retornar:
@return array o array de elementos agrupados.
Exemplo:
<?php
use function _ partition ;
$ users = [
[ ' user ' => ' barney ' , ' age ' => 36 , ' active ' => false ],
[ ' user ' => ' fred ' , ' age ' => 40 , ' active ' => true ],
[ ' user ' => ' pebbles ' , ' age ' => 1 , ' active ' => false ]
];
partition ( $ users , function ( $ user ) { return $ user [ ' active ' ]; })
// => objects for [['fred'], ['barney', 'pebbles']] Reduz collection a um valor que é o resultado acumulado da execução de cada elemento na collection através de iteratee , onde cada invocação sucessiva recebe o valor de retorno da anterior. Se accumulator não for fornecido, o primeiro elemento da collection será usado como valor inicial. O iteratee é invocado com quatro argumentos: (acumulador, valor, índice|chave, coleção).
Muitos métodos lodash são protegidos para funcionar como iterativos para métodos como reduce , reduceRight e transform .
Os métodos protegidos são: assign , defaults , defaultsDeep , includes , merge , orderBy e sortBy
Argumentos:
@param iterable $collection A coleção a ser iterada.
@param mixed $iteratee A função invocada por iteração.
@param mixed $accumulator O valor inicial.
Retornar:
@return misto Retorna o valor acumulado.
Exemplo:
<?php
use function _ reduce ;
reduce ([ 1 , 2 ], function ( $ sum , $ n ) { return $ sum + $ n ; }, 0 )
// => 3
reduce ([ ' a ' => 1 , ' b ' => 2 , ' c ' => 1 ], function ( $ result , $ value , $ key ) {
if (! isset ( $ result [ $ value ])) {
$ result [ $ value ] = [];
}
$ result [ $ value ][] = $ key ;
return $ result ;
}, [])
// => ['1' => ['a', 'c'], '2' => ['b']] (iteration order is not guaranteed) Este método é como reduce , exceto que itera sobre os elementos da collection da direita para a esquerda.
Argumentos:
@param iterable $collection A coleção a ser iterada.
@param mixed $iteratee A função invocada por iteração.
@param mixed $accumulator O valor inicial.
Retornar:
@return misto Retorna o valor acumulado.
Exemplo:
<?php
use function _ reduceRight ;
$ array = [[ 0 , 1 ], [ 2 , 3 ], [ 4 , 5 ]];
reduceRight ( array , (flattened, other) => flattened. concat (other), [])
// => [4, 5, 2, 3, 0, 1] O oposto do filter este método retorna os elementos da collection para os quais predicate não retorna verdadeiro.
Argumentos:
@param iterable $collection A coleção a ser iterada.
@param callable $predicate A função invocada por iteração.
Retornar:
@return array o novo array filtrado.
Exemplo:
<?php
use function _ reject ;
$ users = [
[ ' user ' => ' barney ' , ' active ' => true ],
[ ' user ' => ' fred ' , ' active ' => false ]
]
reject ( $ users , ' active ' )
// => objects for ['fred'] Obtém o tamanho da collection retornando seu comprimento para valores de matriz ou o número de propriedades públicas para objetos.
Argumentos:
@param (array | object | string) $collection A coleção a ser inspecionada.
Retornar:
@return int Retorna o tamanho da coleção.
Exemplo:
<?php
use function _ size ;
size ([ 1 , 2 , 3 ]);
// => 3
size ( new class { public $ a = 1 ; public $ b = 2 ; private $ c = 3 ; });
// => 2
size ( ' pebbles ' );
// => 7 Verifica se predicate retorna verdadeiro para qualquer elemento da collection . A iteração é interrompida quando predicate retorna verdadeiro. O predicado é invocado com três argumentos: (valor, índice|chave, coleção).
Argumentos:
@param iterable $collection A coleção a ser iterada.
@param (callable | string | array) $predicate A função invocada por iteração.
Retornar:
@return boolean Retorna true se algum elemento passar na verificação de predicado, caso contrário, false .
Exemplo:
<?php
use function _ some ;
some ([ null , 0 , ' yes ' , false ], , function ( $ value ) { return is_bool ( $ value ); }));
// => true
$ users = [
[ ' user ' => ' barney ' , ' active ' => true ],
[ ' user ' => ' fred ' , ' active ' => false ]
];
// The `matches` iteratee shorthand.
some ( $ users , [ ' user ' => ' barney ' , ' active ' => false ]);
// => false
// The `matchesProperty` iteratee shorthand.
some ( $ users , [ ' active ' , false ]);
// => true
// The `property` iteratee shorthand.
some ( $ users , ' active ' );
// => trueCria uma matriz de elementos, classificados em ordem crescente pelos resultados da execução de cada elemento em uma coleção por meio de cada iterativo. Este método realiza uma classificação estável, ou seja, preserva a ordem de classificação original de elementos iguais. Os iterados são invocados com um argumento: (valor).
Argumentos:
@param (array | object | null) $collection A coleção sobre a qual iterar.
@param (callable | callable[]) $iteratees Os iterados pelos quais classificar.
Retornar:
@return array Retorna o novo array classificado.
Exemplo:
<?php
use function _ sortBy ;
$ users = [
[ ' user ' => ' fred ' , ' age ' => 48 ],
[ ' user ' => ' barney ' , ' age ' => 36 ],
[ ' user ' => ' fred ' , ' age ' => 40 ],
[ ' user ' => ' barney ' , ' age ' => 34 ],
];
sortBy ( $ users , [ function ( $ o ) { return $ o [ ' user ' ]; }]);
// => [['user' => 'barney', 'age' => 36], ['user' => 'barney', 'age' => 34], ['user' => 'fred', 'age' => 48], ['user' => 'fred', 'age' => 40]]
sortBy ( $ users , [ ' user ' , ' age ' ]);
// => [['user' => 'barney', 'age' => 34], ['user' => 'barney', 'age' => 36], ['user' => 'fred', 'age' => 40], ['user' => 'fred', 'age' => 48]] Obtém o carimbo de data/hora do número de milissegundos decorridos desde a época Unix (1º de janeiro de 1970 00:00:00 UTC).
Argumentos:
Retornar:
@return int Retorna o carimbo de data/hora.
Exemplo:
<?php
use function _ now ;
now ();
// => 1511180325735 O oposto de before ; este método cria uma função que invoca func quando é chamada n ou mais vezes.
Argumentos:
@param int $n O número de chamadas antes de func ser invocado.
@param Callable $func A função a ser restrita.
Retornar:
@return Callable Retorna a nova função restrita.
Exemplo:
<?php
use function _ after ;
$ saves = [ ' profile ' , ' settings ' ];
$ done = after ( count ( $ saves ), function () {
echo ' done saving! ' ;
});
forEach ( $ saves , function ( $ type ) use ( $ done ) {
asyncSave ([ ' type ' => $ type , ' complete ' => $ done ]);
});
// => Prints 'done saving!' after the two async saves have completed. Cria uma função que invoca func , com até n argumentos, ignorando quaisquer argumentos adicionais.
Argumentos:
@param callable $func A função para a qual limitar os argumentos.
@param int $n O limite de aridade.
Retornar:
@return Callable Retorna a nova função limitada.
Exemplo:
<?php
use function _ ary ;
map ([ ' 6 ' , ' 8 ' , ' 10 ' ], ary ( ' intval ' , 1 ));
// => [6, 8, 10] Cria uma função que invoca func , com os argumentos da função criada, embora seja chamada menos de n vezes. As chamadas subsequentes à função criada retornam o resultado da última invocação func .
Argumentos:
@param int $n O número de chamadas nas quais func não é mais invocado.
@param callable $func A função a ser restrita.
Retornar:
@return callable Retorna a nova função restrita.
Exemplo:
<?php
use function _ before ;
$ users = [ 1 , 2 , 3 , 4 , 5 , 6 , 7 , 8 , 9 , 10 ];
$ result = uniqBy ( map ( $ users , before ( 5 , [ $ repository , ' find ' ])), ' id ' )
// => Fetch up to 4 results. Cria uma função que invoca func com a ligação this do object e partials anexados aos argumentos que recebe.
Argumentos:
@param callable $function A função a ser vinculada.
@param (objeto | misto) $object A ligação de object de func .
@param array<int, mixed> $partials Os argumentos a serem aplicados parcialmente.
Retornar:
@return callable Retorna a nova função vinculada.
Exemplo:
<?php
use function _ bind ;
function greet ( $ greeting , $ punctuation ) {
return $ greeting . ' ' . $ this -> user . $ punctuation ;
}
$ object = $ object = new class {
public $ user = ' fred ' ;
};
$ bound = bind ( ' greet ' , $ object , ' hi ' );
$ bound ( ' ! ' );
// => 'hi fred!' Cria uma função que invoca o método $function de $object com $partials anexados aos argumentos que recebe.
Este método difere do bind por permitir que funções vinculadas façam referência a métodos que podem ser redefinidos ou que ainda não existem
Argumentos:
@param object $object O objeto no qual invocar o método.
@param string $function O nome do método.
@param array<int, mixed> $partials Os argumentos a serem aplicados parcialmente.
Retornar:
@return callable Retorna a nova função vinculada.
Exemplo:
<?php
use function _ bindKey ;
$ object = new class {
private $ user = ' fred ' ;
function greet ( $ greeting , $ punctuation ) {
return $ greeting . ' ' . $ this -> user . $ punctuation ;
}
};
$ bound = bindKey ( $ object , ' greet ' , ' hi ' );
$ bound ( ' ! ' );
// => 'hi fred!' Cria uma função que aceita argumentos de func e invoca func retornando seu resultado, se pelo menos um número de arity de argumentos tiver sido fornecido, ou retorna uma função que aceita os argumentos func restantes, e assim por diante. A aridade de func pode ser especificada se func.length não for suficiente.
O valor _.curry.placeholder , cujo padrão é _ em compilações monolíticas, pode ser usado como espaço reservado para argumentos fornecidos.
Nota: Este método não define a propriedade "comprimento" das funções curried.
Argumentos:
@param callable $func A função a ser curry.
@param (int | null) $arity A aridade de func .
Retornar:
@return callable Retorna a nova função curried.
Exemplo:
<?php
use function _ curry ;
$ abc = function ( $ a , $ b , $ c ) {
return [ $ a , $ b , $ c ];
};
$ curried = curry ( $ abc );
$ curried ( 1 )( 2 )( 3 );
// => [1, 2, 3]
$ curried ( 1 , 2 )( 3 );
// => [1, 2, 3]
$ curried ( 1 , 2 , 3 );
// => [1, 2, 3]
// Curried with placeholders.
$ curried ( 1 )(_, 3 )( 2 );
// => [1, 2, 3] Invoca func após wait milissegundos. Quaisquer argumentos adicionais são fornecidos para func quando ele é invocado.
Argumentos:
@param callable $func A função a ser atrasada.
@param int $wait O número de milissegundos para atrasar a invocação.
@param array<int, misto> $args
Retornar:
@return int o ID do temporizador.
Exemplo:
<?php
use function _ delay ;
delay ( function ( $ text ) {
echo $ text ;
}, 1000 , ' later ' );
// => Echo 'later' after one second. Cria uma função que invoca func com argumentos invertidos.
Argumentos:
@param callable $func A função para a qual inverter os argumentos.
Retornar:
@return callable Retorna a nova função invertida.
Exemplo:
<?php
use function _ flip ;
$ flipped = flip ( function () {
return func_get_args ();
});
flipped ( ' a ' , ' b ' , ' c ' , ' d ' );
// => ['d', 'c', 'b', 'a'] Cria uma função que memoriza o resultado de func . Se resolver for fornecido, ele determinará a chave de cache para armazenar o resultado com base nos argumentos fornecidos à função memorizada. Por padrão, o primeiro argumento fornecido para a função memorizada é usado como chave de cache do mapa
Nota: O cache é exposto como propriedade cache na função memorizada. Sua criação pode ser customizada substituindo o construtor _.memoize.Cache por um cujas instâncias implementem a interface do método Map de clear , delete , get , has e set .
Argumentos:
@param callable $func A função que terá sua saída memorizada.
@param (callable | null) $resolver A função para resolver a chave de cache.
Retornar:
@return callable Retorna a nova função memorizada.
Exemplo:
<?php
use function _ memoize ;
$ object = [ ' a ' => 1 , ' b ' => 2 ];
$ other = [ ' c ' => 3 , ' d ' => 4 ];
$ values = memoize ( ' _values ' );
$ values ( $ object );
// => [1, 2]
$ values ( $ other );
// => [3, 4]
$ object [ ' a ' ] = 2 ;
$ values ( $ object );
// => [1, 2]
// Modify the result cache.
$ values -> cache -> set ( $ object , [ ' a ' , ' b ' ]);
$ values ( $ object );
// => ['a', 'b'] Cria uma função que nega o resultado do predicado func
Argumentos:
@param callable $predicate O predicado a ser negado.
Retornar:
@return callable Retorna a nova função negada.
Exemplo:
<?php
use function _ negate ;
function isEven ( $ n ) {
return $ n % 2 == 0 ;
}
filter ([ 1 , 2 , 3 , 4 , 5 , 6 ], negate ( $ isEven ));
// => [1, 3, 5] Cria uma função restrita a invocar func uma vez. Chamadas repetidas para a função retornam o valor da primeira invocação. A func é invocada com os argumentos da função criada.
Argumentos:
@param callable $func A função a ser restrita.
Retornar:
@return callable a nova função restrita.
Exemplo:
<?php
use function _ once ;
$ initialize = once ( ' createApplication ' );
$ initialize ();
$ initialize ();
// => `createApplication` is invoked once Cria uma função que invoca func com seus argumentos transformados.
Argumentos:
@param callable $func A função a ser agrupada.
@param callable[] $transforms O argumento transforma.
Retornar:
@return pode ser chamado pela nova função.
Exemplo:
<?php
use function _ overArgs ;
function doubled ( $ n ) {
return $ n * 2 ;
}
function square ( $ n ) {
return $ n * $ n ;
}
$ func = overArgs ( function ( $ x , $ y ) {
return [ $ x , $ y ];
}, [ ' square ' , ' doubled ' ]);
$ func ( 9 , 3 );
// => [81, 6]
$ func ( 10 , 5 );
// => [100, 10] Cria uma função que invoca func com partials anexados aos argumentos que recebe.
Argumentos:
@param callable $func A função à qual aplicar argumentos parcialmente.
@param array<int, mixed> $partials Os argumentos a serem aplicados parcialmente.
Retornar:
@return callable Retorna a nova função parcialmente aplicada.
Exemplo:
<?php
use function _ partial ;
function greet ( $ greeting , $ name ) {
return $ greeting . ' ' . $ name ;
}
$ sayHelloTo = partial ( ' greet ' , ' hello ' );
$ sayHelloTo ( ' fred ' );
// => 'hello fred' Cria uma função que invoca func com a ligação this função criada e os argumentos do start e além, fornecidos como uma matriz.
Argumentos:
@param chamável $ func a função para aplicar um parâmetro de repouso.
@param (int | null) $ Iniciar a posição inicial do parâmetro restante.
Retornar:
@return callable retorna a nova função.
Exemplo:
<?php
use function _ rest ;
$ say = rest ( function ( $ what , $ names ) {
return $ what . ' ' . implode ( ' , ' , initial ( $ names )) .
( size ( $ names ) > 1 ? ' , & ' : '' ) . last ( $ names );
});
$ say ( ' hello ' , ' fred ' , ' barney ' , ' pebbles ' );
// => 'hello fred, barney, & pebbles' Cria uma função que invoca func com a ligação this função Criar e uma matriz de argumentos como Function#apply .
Nota: Este método é baseado no operador de spread.
Argumentos:
@param chamável $ func a função para espalhar argumentos.
@param int $ Iniciar a posição inicial do spread.
Retornar:
@return callable retorna a nova função.
Exemplo:
<?php
use function _ spread ;
$ say = spread ( function ( $ who , $ what ) {
return $ who . ' says ' . $ what ;
});
$ say ([ ' fred ' , ' hello ' ]);
// => 'fred says hello'Cria uma função que aceita até um argumento, ignorando quaisquer argumentos adicionais.
Argumentos:
@param chamável $ func a função para limitar os argumentos.
Retornar:
@return chamável a nova função limitada.
Exemplo:
<?php
use function _ unary ;
map ([ ' 6 ' , ' 8 ' , ' 10 ' ], unary ( ' intval ' ));
// => [6, 8, 10] Cria uma função que fornece value ao wrapper como seu primeiro argumento. Quaisquer argumentos adicionais fornecidos à função são anexados aos fornecidos ao wrapper .
Argumentos:
@param misto $ valor o valor para envolver.
@param chamável $ wrapper a função wrapper.
Retornar:
@return chamável a nova função.
Exemplo:
<?php
use function _ wrap ;
$ p = wrap ( ' _escape ' , function ( $ func , $ text ) {
return ' <p> ' . $ func ( $ text ) . ' </p> ' ;
});
$ p ( ' fred, barney, & pebbles ' );
// => '<p>fred, barney, & pebbles</p>' Realiza uma comparação entre dois valores para determinar se eles são equivalentes.
Argumentos:
@param misto $ valor o valor a ser comparado.
@param mixou $ outro o outro valor a ser comparado.
Retornar:
@return boolean retorna true se os valores forem equivalentes, caso contrário, false .
Exemplo:
<?php
use function _ eq ;
$ object = ( object ) [ ' a ' => 1 ];
$ other = ( object ) [ ' a ' => 1 ];
eq ( $ object , $ object );
// => true
eq ( $ object , $ other );
// => false
eq ( ' a ' , ' a ' );
// => true
eq ([ ' a ' ], ( object ) [ ' a ' ]);
// => false
eq ( INF , INF );
// => trueRealiza uma comparação profunda entre dois valores para determinar se eles são equivalentes.
NOTA: Este método suporta comparar matrizes, booleanos, objetos DateTime, objetos de exceção, SplObjectStorage, números, strings, matrizes digitadas, recursos, nós DOM. Os objetos são comparados por suas próprias propriedades, não herdadas e enumeráveis.
Argumentos:
@param misto $ valor o valor a ser comparado.
@param mixou $ outro o outro valor a ser comparado.
Retornar:
@return bool retorna true se os valores forem equivalentes, caso contrário, false .
Exemplo:
<?php
use function _ isEqual ;
$ object = [ ' a ' => 1 ]
$ other = [ ' a ' => ' 1 ' ]
isEqual ( $ object , $ other )
// => true
$ object === $ other
// => false Verifica se value é uma Exception , ParseError , error , Throwable , Soapfault , DOMException , pDoException`, objeto.
Argumentos:
@param misto $ valor o valor para verificar.
Retornar:
@return boolean retorna true se value for um objeto de erro, caso contrário, false .
Exemplo:
<?php
use function _ isError ;
isError ( new Exception ())
// => true
isError (Exception::Class)
// => false Adiciona dois números.
Argumentos:
@param (int | float | string) $ aunhend o primeiro número em uma adição.
@param (int | float | string) $ adicione o segundo número em uma adição.
Retornar:
@return (int | float) retorna o total.
Exemplo:
<?php
use function _ add ;
add ( 6 , 4 );
// => 10 Calcula o valor máximo da array . Se array estiver vazia ou falsa, o NULL será devolvido.
Argumentos:
@param (array | null) $ matriz a matriz para iterar.
Retornar:
@return (int | null) retorna o valor máximo.
Exemplo:
<?php
use function _ max ;
max ([ 4 , 2 , 8 , 6 ]);
// => 8
max ([]);
// => null Este método é como max , exceto que aceita iteratee , que é chamado para cada elemento em array para gerar o critério pelo qual o valor é classificado. O iteree é invocado com um argumento: (valor).
Argumentos:
@param matriz $ matriz a matriz para iterar.
@Param (Callable | String) $ ITEREREE O ITEREE INVOLADO por elemento.
Retornar:
@return mixed retorna o valor máximo.
Exemplo:
<?php
use function _ maxBy ;
$ objects = [[ ' n ' => 1 ], [ ' n ' => 2 ]];
maxBy ( $ objects , function ( $ o ) { return $ o [ ' n ' ]; });
// => ['n' => 2]
// The `property` iteratee shorthand.
maxBy ( $ objects , ' n ' );
// => ['n' => 2] Os grampos number dentro dos limites lower e upper inclusivos.
Argumentos:
@param int $ número o número para prender.
@param int $ abaixe o limite inferior.
@param int $ superior o limite superior.
Retornar:
@return int retorna o número preso.
Exemplo:
<?php
use function _ clamp ;
clamp (- 10 , - 5 , 5 )
// => -5
clamp ( 10 , - 5 , 5 )
// => 5 Verifica se number está entre start e o alcov para, mas não incluindo, end . Se end não for especificado, ele será definido para start com start e definido como 0 . Se start for maior que end os parâmetros são trocados para suportar intervalos negativos.
Argumentos:
@param flutuante $ número o número a ser verificado.
@param float $ inicie o início do intervalo.
@param flutuar $ final no final do intervalo.
Retornar:
@return boolean retorna true se number estiver no intervalo, caso contrário, false .
Exemplo:
<?php
use function _ inRange ;
inRange ( 3 , 2 , 4 )
// => true
inRange ( 4 , 8 )
// => true
inRange ( 4 , 2 )
// => false
inRange ( 2 , 2 )
// => false
inRange ( 1.2 , 2 )
// => true
inRange ( 5.2 , 4 )
// => false
inRange (- 3 , - 2 , - 6 )
// => true Produz um número aleatório entre os limites lower e upper inclusivos. Se apenas um argumento for fornecido um número entre 0 e o número fornecido for retornado. Se floating for true , ou lower ou upper , são flutuantes, um número de ponto flutuante é retornado em vez de um número inteiro.
Argumentos:
@param (int | float | bool) $ Abaixe o limite inferior.
@param (int | float | bool) $ superior O limite superior.
@param (bool | null) $ flutuante Especifique retornar um número de ponto flutuante.
Retornar:
@return (int | float) retorna o número aleatório.
Exemplo:
<?php
use function _ random ;
random ( 0 , 5 )
// => an integer between 0 and 5
random ( 5 )
// => also an integer between 0 and 5
random ( 5 , true )
// => a floating-point number between 0 and 5
random ( 1.2 , 5.2 )
// => a floating-point number between 1.2 and 5.2 Obtém o valor no caminho do objeto. Se o valor resolvido for nulo, o DefaultValue será retornado em seu lugar.
Argumentos:
@param mixed $ objeto o conjunto associativo ou objeto para buscar valor
@Param (Array | String) $ Path Dot Separado ou Matriz de String
@param mixed $ defaultValue (opcional) O valor retornado para valores não resolvidos ou nulos.
Retornar:
@return mixed retorna o valor resolvido.
Exemplo:
<?php
use function _ get ;
$ sampleArray = [ " key1 " => [ " key2 " => [ " key3 " => " val1 " , " key4 " => "" ]]];
get ( $ sampleArray , ' key1.key2.key3 ' );
// => "val1"
get ( $ sampleArray , ' key1.key2.key5 ' , " default " );
// => "default"
get ( $ sampleArray , ' key1.key2.key4 ' , " default " );
// => "" Cria um objeto composto pelas propriedades object escolhido.
Argumentos:
@param objeto $ objeto O objeto de origem.
@param (string | string []) $ caminhos Os caminhos da propriedade para escolher.
Retornar:
@return stdclass retorna o novo objeto.
Exemplo:
<?php
use function _ pick ;
$ object = ( object ) [ ' a ' => 1 , ' b ' => ' 2 ' , ' c ' => 3 ];
pick ( $ object , [ ' a ' , ' c ' ]);
// => (object) ['a' => 1, 'c' => 3] Cria um objeto composto pelo object Propriedades predicate retorna a verdade. O predicado é invocado com dois argumentos: (valor, chave).
Argumentos:
@param (objeto | null) $ objeto O objeto de origem.
@Param Callable $ Predicar a função invocada por propriedade.
Retornar:
@return stdclass retorna o novo objeto.
Exemplo:
<?php
use function _ pickBy ;
$ object = ( object ) [ ' a ' => 1 , ' b ' => ' abc ' , ' c ' => 3 ];
pickBy (object, ' is_numeric ' );
// => (object) ['a' => 1, 'c' => 3] Cria uma instância lodash Wrapper que envolve value com sequências de cadeia de métodos explícitas ativadas. O resultado de tais seqüências deve ser desembrulhado com ->value() .
Argumentos:
@param misto $ valor o valor para envolver.
Retornar:
@return _ retorna a nova instância lodash Wrapper.
Exemplo:
<?php
use function _ chain ;
$ users = [
[ ' user ' => ' barney ' , ' age ' => 36 ],
[ ' user ' => ' fred ' , ' age ' => 40 ],
[ ' user ' => ' pebbles ' , ' age ' => 1 ],
];
$ youngest = chain ( $ users )
-> sortBy ( ' age ' )
-> map ( function ( $ o ) {
return $ o [ ' user ' ] . ' is ' . $ o [ ' age ' ];
})
-> head ()
-> value ();
// => 'pebbles is 1' Converte string em estojo de camelo.
Argumentos:
@param string $ string a string para converter.
Retornar:
@return string retorna a sequência de camelo.
Exemplo:
<?php
use function _ camelCase ;
camelCase ( ' Foo Bar ' )
// => 'fooBar'
camelCase ( ' --foo-bar-- ' )
// => 'fooBar'
camelCase ( ' __FOO_BAR__ ' )
// => 'fooBar' Converte o primeiro caractere da string em maiúsculas e o restante em minúsculas.
Argumentos:
@param string $ string a string para capitalizar.
Retornar:
@return string retorna a string capitalizada.
Exemplo:
<?php
use function _ capitalize ;
capitalize ( ' FRED ' )
// => 'Fred' string de debradores convertendo [Suplemento Latin-1] (https => // en.wikipedia.org/wiki/latin-1_supplement_(unicode_block)#character_table) e [latim estendido-a] (https => // en.wikipedia. org/wiki/latin_extended-a) cartas para letras latinas básicas e remoção [combinando marcas diacríticas] (https => // en.wikipedia.org/wiki/Combining_DiAcritical_Marks).
Argumentos:
@Param String $ String A String para Debur.
Retornar:
@return string Retorna a string deburida.
Exemplo:
<?php
use function _ deburr ;
deburr ( ' déjà vu ' )
// => 'deja vu' Verifica se string termina com a sequência de destino fornecida.
Argumentos:
@param string $ string a string para inspecionar.
@param string $ Target A string a ser pesquisada.
@param int $ posicionar a posição para pesquisar.
Retornar:
@return boolean retorna true se string termina com target , caso contrário, false .
Exemplo:
<?php
use function _ endsWith ;
endsWith ( ' abc ' , ' c ' )
// => true
endsWith ( ' abc ' , ' b ' )
// => false
endsWith ( ' abc ' , ' b ' , 2 )
// => true Converte os personagens "&", "<", ">", '"" e "" "na string às entidades HTML correspondentes.
Embora o caractere ">" esteja escapado para simetria, caracteres como ">" e "/" não precisam escapar no HTML e não têm significado especial, a menos que façam parte de uma tag ou valor de atributo não citado. Veja o artigo de Mathias Bynens (em "Curiosidade semi-relacionada") para obter mais detalhes.
Ao trabalhar com o HTML, você deve sempre citar valores de atributo para reduzir os vetores XSS.
Argumentos:
@param string $ string a string para escapar.
Retornar:
@return string retorna a string escapada.
Exemplo:
<?php
use function _ escape ;
escape ( ' fred, barney, & pebbles ' )
// => 'fred, barney, & pebbles' Escapa dos caracteres especiais RegExp "^", "$", "", ".", "*", "+", "?", "(", ")", "[", "]," {"{" {" ","} "e" | " em string .
Argumentos:
@param string $ string a string para escapar.
Retornar:
@return string retorna a string escapada.
Exemplo:
<?php
use function _ escapeRegExp ;
escapeRegExp ( ' [lodash](https://lodash.com/) ' )
// => '[lodash](https://lodash.com/)' Converte string em caso de kebab.
Argumentos:
@param string $ string a string para converter.
Retornar:
@return string Retorna a sequência de Kebab Cased.
Exemplo:
<?php
use function _ kebabCase ;
kebabCase ( ' Foo Bar ' )
// => 'foo-bar'
kebabCase ( ' fooBar ' )
// => 'foo-bar'
kebabCase ( ' __FOO_BAR__ ' )
// => 'foo-bar' Converte string , como palavras separadas pelo espaço, em minúsculas.
Argumentos:
@param string $ string a string para converter.
Retornar:
@return string Retorna a string caseed inferior.
Exemplo:
<?php
use function _ lowerCase ;
lowerCase ( ' --Foo-Bar-- ' )
// => 'foo bar'
lowerCase ( ' fooBar ' )
// => 'foo bar'
lowerCase ( ' __FOO_BAR__ ' )
// => 'foo bar' Converte o primeiro caractere da string em minúsculas.
Argumentos:
@param string $ string a string para converter.
Retornar:
@return string retorna a string convertida.
Exemplo:
<?php
use function _ lowerFirst ;
lowerFirst ( ' Fred ' )
// => 'fred'
lowerFirst ( ' FRED ' )
// => 'fRED' As almofadas string nos lados esquerdo e direito, se for mais curto que length . Os caracteres de preenchimento são truncados se não puderem ser divididos igualmente por length .
Argumentos:
@param string $ string a string para pad.
@param int $ comprimento o comprimento do preenchimento.
@param string $ chars a string usada como preenchimento.
Retornar:
@return string retorna a string acolchoada.
Exemplo:
<?php
use function _ pad ;
pad ( ' abc ' , 8 )
// => ' abc '
pad ( ' abc ' , 8 , ' _- ' )
// => '_-abc_-_'
pad ( ' abc ' , 2 )
// => 'abc' As almofadas de string no lado direito, se for mais curto que length . Os caracteres de preenchimento são truncados se excederem length .
Argumentos:
@param string $ string a string para pad.
@param int $ comprimento o comprimento do preenchimento.
@param string $ chars a string usada como preenchimento.
Retornar:
@return string retorna a string acolchoada.
Exemplo:
<?php
use function _ padEnd ;
padEnd ( ' abc ' , 6 )
// => 'abc '
padEnd ( ' abc ' , 6 , ' _- ' )
// => 'abc_-_'
padEnd ( ' abc ' , 2 )
// => 'abc' As almofadas de string no lado esquerdo, se for mais curto que length . Os caracteres de preenchimento são truncados se excederem length .
s argumentos:
@param string $ string = '' A sequência para PAD.
@param int $ comprimento o comprimento do preenchimento.
@param string $ chars a string usada como preenchimento.
Retornar:
@return string retorna a string acolchoada.
Exemplo:
<?php
use function _ padStart ;
padStart ( ' abc ' , 6 )
// => ' abc'
padStart ( ' abc ' , 6 , ' _- ' )
// => '_-_abc'
padStart ( ' abc ' , 2 )
// => 'abc' Converte string em um número inteiro do radix especificado. Se radix for undefined ou 0 , um radix de 10 é usado, a menos que string seja hexadecimal; nesse caso, é usado um radix de 16 .
Nota: Este método usa a fundição inteira interna do PHP, que não se alinha necessariamente com a implementação do ES5 do parseInt .
Argumentos:
@param (int | float | string) $ string a string para converter.
@param int $ radix o radix para interpretar string por.
Retornar:
@return int retorna o número inteiro convertido.
Exemplo:
<?php
use function _ parseInt ;
parseInt ( ' 08 ' )
// => 8 Repete a string dada n vezes.
Argumentos:
@param string $ string a string para repetir.
@param int $ n o número de vezes para repetir a string.
Retornar:
@return string retorna a string repetida.
Exemplo:
<?php
use function _ repeat ;
repeat ( ' * ' , 3 )
// => '***'
repeat ( ' abc ' , 2 )
// => 'abcabc'
repeat ( ' abc ' , 0 )
// => '' Substitui correspondências por pattern em string pela replacement .
NOTA: Este método é baseado na String#replace .
Argumentos:
@param string $ string a string para modificar.
@param string $ padrão o padrão a ser substituído.
@Param (Callable | String) $ Substituição A substituição da correspondência.
Retornar:
@return string retorna a sequência modificada.
Exemplo:
<?php
use function _ replace ;
replace ( ' Hi Fred ' , ' Fred ' , ' Barney ' )
// => 'Hi Barney' Converte o caso string em cobra.
Argumentos:
@param string $ string a string para converter.
Retornar:
@return string retorna a corda de cobra.
Exemplo:
<?php
use function _ snakeCase ;
snakeCase ( ' Foo Bar ' )
// => 'foo_bar'
snakeCase ( ' fooBar ' )
// => 'foo_bar'
snakeCase ( ' --FOO-BAR-- ' )
// => 'foo_bar' Splits string pelo separator .
Nota: Este método é baseado na String#split .
Argumentos:
@param string $ string a string para dividir.
@param string $ separador O padrão do separador para dividir por.
@param int $ limite o comprimento para truncar os resultados para.
Retornar:
@return matriz retorna os segmentos da string.
Exemplo:
<?php
use function _ split ;
split ( ' a-b-c ' , ' - ' , 2 )
// => ['a', 'b'] Converte string para iniciar o caso.
Argumentos:
@param string $ string a string para converter.
Retornar:
@return string Retorna a string de partida.
Exemplo:
<?php
use function _ startCase ;
startCase ( ' --foo-bar-- ' )
// => 'Foo Bar'
startCase ( ' fooBar ' )
// => 'Foo Bar'
startCase ( ' __FOO_BAR__ ' )
// => 'FOO BAR' Verifica se string começa com a sequência de destino fornecida.
Argumentos:
@param string $ string a string para inspecionar.
@param string $ Target A string a ser pesquisada.
@param int $ posicionar a posição para pesquisar.
Retornar:
@return boolean retorna true se string iniciar com target , caso contrário, false .
Exemplo:
<?php
use function _ startsWith ;
startsWith ( ' abc ' , ' a ' )
// => true
startsWith ( ' abc ' , ' b ' )
// => false
startsWith ( ' abc ' , ' b ' , 1 )
// => true Cria uma função de modelo compilado que pode interpolar as propriedades de dados em delimitadores "interpolados", propriedades de dados interpoladas de escapados html em delimitadores "Escape" e executar PHP em delimitadores "avaliar". As propriedades de dados podem ser acessadas como variáveis gratuitas no modelo. Se um objeto de configuração for fornecido, terá precedência sobre os valores de $templateSettings .
Regexp $ options ['escape'] = _ :: $ modeplateSettings ['escape'] o delimitador HTML "Escape". Regexp $ options ['avaliar'] = _ :: $ modeplatesettings ['avaliar'] o delimitador "avaliar". Array $ options ['importações'] = _ :: $ modeplatesettings ['importações'] Um objeto a ser importado para o modelo como variáveis gratuitas. Regexp $ options ['interpolate'] = _ :: $ modeLatesettings ['interpolate'] o delimitador "interpolado".
Argumentos:
@param string $ string A sequência de modelos.
@Param Array $ Opções a matriz de opções.
Retornar:
@return callable retorna a função de modelo compilado.
Exemplo:
<?php
use function _ template ;
// Use the "interpolate" delimiter to create a compiled template.
$ compiled = template ( ' hello <%= user %>! ' )
$ compiled ([ ' user ' => ' fred ' ])
// => 'hello fred!'
// Use the HTML "escape" delimiter to escape data property values.
$ compiled = template ( ' <b><%- value %></b> ' )
$ compiled ([ ' value ' => ' <script> ' ])
// => '<b><script></b>'
// Use the "evaluate" delimiter to execute JavaScript and generate HTML.
$ compiled = template ( ' <% foreach($users as $user) { %><li><%- user %></li><% }%> ' )
$ compiled ([ ' users ' => [ ' fred ' , ' barney ' ] ])
// => '<li>fred</li><li>barney</li>'
// Use the internal `print` function in "evaluate" delimiters.
$ compiled = template ( ' <% print("hello " + $user)%>! ' )
$ compiled ([ ' user ' => ' barney ' ])
// => 'hello barney!'
// Use backslashes to treat delimiters as plain text.
$ compiled = template ( ' <%= " \ <%- value % \ >" %> ' )
$ compiled ([ ' value ' => ' ignored ' ])
// => '<%- value %>'
// Use the `imports` option to import functions or classes with aliases.
$ text = ' <% all($users, function($user) { %><li><%- user %></li><% })%> '
$ compiled = template( $ text , { ' imports ' : { ' _each ' : ' all ' } })
$ compiled ([ ' users ' => [ ' fred ' , ' barney ' ] ])
// => '<li>fred</li><li>barney</li>'
// Use custom template delimiters.
_:: $ templateSettings [ ' interpolate ' ] = ' {{([sS]+?)}} '
$ compiled = template ( ' hello {{ user }}! ' )
$ compiled ([ ' user ' => ' mustache ' ])
// => 'hello mustache!'
// Use the `source` property to access the compiled source of the template
template ( $ mainText )-> source ; Converte string , como um todo, em minúsculas
Argumentos:
@param string $ string a string para converter.
Retornar:
@return string Retorna a string caseed inferior.
Exemplo:
<?php
use function _ toLower ;
toLower ( ' --Foo-Bar-- ' )
// => '--foo-bar--'
toLower ( ' fooBar ' )
// => 'foobar'
toLower ( ' __FOO_BAR__ ' )
// => '__foo_bar__' Converte string , como um todo, em maiúsculas
Argumentos:
@param string $ string a string para converter.
Retornar:
@return string Retorna a sequência de casos superior.
Exemplo:
<?php
use function _ toUpper ;
toUpper ( ' --foo-bar-- ' )
// => '--FOO-BAR--'
toUpper ( ' fooBar ' )
// => 'FOOBAR'
toUpper ( ' __foo_bar__ ' )
// => '__FOO_BAR__' Remove o espaço em branco e a direita ou os caracteres especificados da string .
Argumentos:
@param string $ string a string para aparar.
@param string $ chars os caracteres para aparar.
Retornar:
@return string retorna a sequência aparada.
Exemplo:
<?php
use function _ trim ;
trim ( ' abc ' )
// => 'abc'
trim ( ' -_-abc-_- ' , ' _- ' )
// => 'abc' Remove o espaço em branco à direita ou caracteres especificados da string .
Argumentos:
@param string $ string a string para aparar.
@param string $ chars os caracteres para aparar.
Retornar:
@return string retorna a sequência aparada.
Exemplo:
<?php
use function _ trimEnd ;
trimEnd ( ' abc ' )
// => ' abc'
trimEnd ( ' -_-abc-_- ' , ' _- ' )
// => '-_-abc' Remove o espaço em branco ou caracteres especificados da string .
Argumentos:
@param string $ string a string para aparar.
@param string $ chars os caracteres para aparar.
Retornar:
@return string retorna a sequência aparada.
Exemplo:
<?php
use function _ trimStart ;
trimStart ( ' abc ' )
// => 'abc '
trimStart ( ' -_-abc-_- ' , ' _- ' )
// => 'abc-_-' Truncam string se for mais longa que o comprimento máximo de string dado. Os últimos caracteres da string truncada são substituídos pela sequência de omissão que indica "...".
comprimento = 30 o comprimento máximo da corda. omissão = '...' A sequência para indicar o texto é omitida. separador o padrão separador para truncar.
Argumentos:
@param string $ string a string para truncar.
@param Array $ Opções O objeto Opções.
Retornar:
@return string retorna a sequência truncada.
Exemplo:
<?php
use function _ truncate ;
truncate ( ' hi-diddly-ho there, neighborino ' )
// => 'hi-diddly-ho there, neighbo...'
truncate ( ' hi-diddly-ho there, neighborino ' , [
' length ' => 24 ,
' separator ' => ' '
])
// => 'hi-diddly-ho there,...'
truncate ( ' hi-diddly-ho there, neighborino ' , [
' length ' => 24 ,
' separator ' => ' /,? +/ '
])
// => 'hi-diddly-ho there...'
truncate ( ' hi-diddly-ho there, neighborino ' , [
' omission ' => ' [...] '
])
// => 'hi-diddly-ho there, neig [...]' O inverso de escape Este método converte as entidades HTML & , < , > , " e ' na string para seus caracteres correspondentes.
Argumentos:
@param string $ string a string para unescape.
Retornar:
@return string retorna a string não especificada.
Exemplo:
<?php
use function _ unescape ;
unescape ( ' fred, barney, & pebbles ' )
// => 'fred, barney, & pebbles' Converte string , como palavras separadas pelo espaço, em maiúsculas.
Argumentos:
@param string $ string a string para converter.
Retornar:
@return string Retorna a string superior superior.
Exemplo:
<?php
use function _ upperCase ;
upperCase ( ' --foo-bar ' )
// => 'FOO BAR'
upperCase ( ' fooBar ' )
// => 'FOO BAR'
upperCase ( ' __foo_bar__ ' )
// => 'FOO BAR' Converte o primeiro caractere da string em maiúsculas.
Argumentos:
@param string $ string a string para converter.
Retornar:
@return string retorna a string convertida.
Exemplo:
<?php
use function _ upperFirst ;
upperFirst ( ' fred ' )
// => 'Fred'
upperFirst ( ' FRED ' )
// => 'FRED' Divide string em uma matriz de suas palavras.
Argumentos:
@param string $ string a string para inspecionar.
@param string $ padrão O padrão para combinar palavras.
Retornar:
@return Array retorna as palavras da string .
Exemplo:
<?php
use function _ words ;
words ( ' fred, barney, & pebbles ' )
// => ['fred', 'barney', 'pebbles']
words ( ' fred, barney, & pebbles ' , ' /[^, ]+/g ' )
// => ['fred', 'barney', '&', 'pebbles'] Tentativas de invocar func , retornando o resultado do resultado ou do erro capturado. Quaisquer argumentos adicionais são fornecidos ao func quando for invocado.
s argumentos:
@param chamável $ func a função a tentar.
@param Array <int, mixed> $ args Os argumentos para invocar func .
Retornar:
@return (mixed | throwable) Retorna o resultado func ou o objeto de erro.
Exemplo:
<?php
use function _ attempt ;
// Avoid throwing errors for invalid PDO data source.
$ elements = attempt ( function () {
new PDO ( null );
});
if ( isError ( $ elements )) {
$ elements = [];
}Verifica o valor para determinar se um valor padrão deve ser retornado em seu lugar. O DefaultValue é retornado se o valor for nan ou nulo.
Argumentos:
@param misto $ valor qualquer valor.
@param mixed $ defaultValue valor para retornar quando $ valor é nulo ou nan
Retornar:
@return value de retorno misto.
Exemplo:
<?php
use function _ defaultTo ;
$ a = null ;
defaultTo ( $ a , " default " );
// => "default"
$ a = " x " ;
defaultTo ( $ a , " default " );
// => "x"Este método retorna o primeiro argumento que recebe.
Argumentos:
@param misto $ valor qualquer valor.
Retornar:
@return value de retorno misto.
Exemplo:
<?php
use function _ identity ;
$ object = [ ' a ' => 1 ];
identity ( $ object ) === $ object ;
// => true Cria uma função que retorna o valor no path de um determinado objeto.
Argumentos:
@param (array | string) $ caminho O caminho da propriedade para obter.
Retornar:
@return Callable retorna a nova função de acessor.
Exemplo:
<?php
use function _ property ;
$ objects = [
[ ' a ' => [ ' b ' => 2 ] ],
[ ' a ' => [ ' b ' => 1 ] ]
];
map ( $ objects , property ( ' a.b ' ));
// => [2, 1]
map ( sortBy ( $ objects , property ([ ' a ' , ' b ' ])), ' a.b ' );
// => [1, 2]
