php helpers
33
A biblioteca clausnz/php-helpers é uma coleção de 45 funções auxiliares úteis do php (PHP 5.6, 7.*) .
Após a instalação com composer , as funções globais poderão ser acessadas de qualquer lugar do seu código:
composer require clausnz/php-helpers <?php
dump ( ' any content ' );Se já existir uma função com o mesmo nome na lista de funções definidas do seu projeto (integradas e definidas pelo usuário), ela simplesmente não será registrada em seu ambiente. Portanto, não surgirão conflitos com funções existentes.
No entanto, toda função ainda pode ser acessada de forma estática com a instrução de uso adequada:
<?php
use CNZ Helpers Util as util ;
util:: dump ( ' any content ' );Esta biblioteca faz uso das seguintes bibliotecas brilhantes e conhecidas:
Todas as funções são testadas em vários testes de unidade e versões de PHP.
Instale a biblioteca clausnz/php-helper mais recente com o compositor:
composer require clausnz/php-helpersCertifique-se também de exigir o arquivo de carregamento automático do compositor:
require __DIR__ . ' /vendor/autoload.php ' ;Após a instalação, as novas funções globais do PHP estarão disponíveis em todo o seu código. Para acessar as funções estáticas (quase idênticas) nas classes auxiliares, adicione a instrução de uso adequada ao seu arquivo:
<?php
use CNZ Helpers Dev as dev ;
if ( dev:: isIphone () ) {
// Do something here
}Classe auxiliar que fornece acesso fácil a funções úteis de array php.
Arr classe
Detecta se o valor fornecido é uma matriz associativa.
Arr:: isAssoc ( array $ array ): booleanFunção global relacionada (descrição veja acima).
(pular para trás)
is_assoc ( array $ array ): boolean $ array = [
' foo ' => ' bar '
];
is_assoc ( $ array );
// bool(true)| Parâmetro | Tipo | Descrição |
|---|---|---|
$array | variedade | Qualquer tipo de matriz. |
Valor de retorno:
Verdadeiro se a matriz for associativa; caso contrário, falso.
Converte um array em um objeto.
Arr:: toObject ( array $ array ): object| nullFunção global relacionada (descrição veja acima).
(pular para trás)
to_object ( array $ array ): object| null $ array = [
' foo ' => [
' bar ' => ' baz '
]
];
$ obj = to_object ( $ array );
echo $ obj -> foo -> bar ;
// baz| Parâmetro | Tipo | Descrição |
|---|---|---|
$array | variedade | A matriz a ser convertida. |
Valor de retorno:
Uma representação de objeto padrão da matriz convertida.
Converte uma string ou objeto em um array.
Arr:: dump ( string|object $ var ): array| nullFunção global relacionada (descrição veja acima).
(pular para trás)
to_array ( string|object $ var ): array| null $ var = ' php ' ;
to_array ( $ var );
// (
// [0] => p
// [1] => h
// [2] => p
// ) $ var = new stdClass ;
$ var -> foo = ' bar ' ;
to_array ( $ var );
// (
// [foo] => bar
// )| Parâmetro | Tipo | Descrição |
|---|---|---|
$var | string|objeto | String ou objeto. |
Valor de retorno:
Uma representação de matriz da string ou objeto convertido. Retorna nulo em caso de erro.
Retorna o primeiro elemento de um array.
Arr:: first ( array $ array ): mixedFunção global relacionada (descrição veja acima).
(pular para trás)
array_first ( array $ array ): mixed $ array = [
' foo ' => ' bar ' ,
' baz ' => ' qux '
];
array_first ( $ array )
// bar| Parâmetro | Tipo | Descrição |
|---|---|---|
$array | variedade | A matriz em questão. |
Valor de retorno:
O valor do primeiro elemento, sem chave. Tipo misto.
Retorna o último elemento de um array.
Arr:: last ( array $ array ): mixedFunção global relacionada (descrição veja acima).
(pular para trás)
array_last ( array $ array ): mixed $ array = [
' foo ' => ' bar ' ,
' baz ' => ' qux '
];
array_last ( $ array )
// qux| Parâmetro | Tipo | Descrição |
|---|---|---|
$array | variedade | A matriz em questão. |
Valor de retorno:
O valor do último elemento, sem chave. Tipo misto.
Obtém um valor em uma matriz por notação de ponto para as chaves.
Arr:: get ( string $ key , array $ array ): mixedFunção global relacionada (descrição veja acima).
(pular para trás)
array_get ( string key, array $ array ): mixed $ array = [
' foo ' => ' bar ' ,
' baz ' => [
' qux => ' foobar'
]
];
array_get ( ' baz.qux ' , $ array );
// foobar| Parâmetro | Tipo | Descrição |
|---|---|---|
$key | corda | A chave por notação de ponto. |
$array | variedade | A matriz na qual pesquisar. |
Valor de retorno:
O valor pesquisado; caso contrário, nulo.
Define um valor em uma matriz usando a notação de ponto.
Arr:: set ( string $ key , mixed $ value , array & $ array ): booleanFunção global relacionada (descrição veja acima).
(pular para trás)
array_set ( string key, mixed value, array $ array ): boolean $ array = [
' foo ' => ' bar ' ,
' baz ' => [
' qux => ' foobar'
]
];
array_set ( ' baz.qux ' , ' bazqux ' , $ array );
// (
// [foo] => bar
// [baz] => [
// [qux] => bazqux
// ]
// ) $ array = [
' foo ' => ' bar ' ,
' baz ' => [
' qux => ' foobar'
]
];
array_set ( ' baz.foo ' , ' bar ' , $ array );
// (
// [foo] => bar
// [baz] => [
// [qux] => bazqux
// [foo] => bar
// ]
// )| Parâmetro | Tipo | Descrição |
|---|---|---|
$key | corda | A chave a ser definida usando a notação de ponto. |
$value | misturado | O valor a ser definido na chave especificada. |
$array | variedade | A matriz em questão. |
Valor de retorno:
True se o novo valor foi definido com sucesso; caso contrário, false.
Classe auxiliar que fornece acesso fácil a funções úteis do PHP em conjunto com o agente do usuário.
Desenvolvimento de classe
Determina se o dispositivo atual é um smartphone.
Dev:: isSmartphone ( ): booleanFunção global relacionada (descrição veja acima).
(pular para trás)
is_smartphone ( ): boolean if ( is_smartphone () ) {
// I am a smartphone
}Valor de retorno:
Verdadeiro se o visitante atual usar um smartphone; caso contrário, falso.
Detecta se o visitante atual usa um dispositivo móvel (smartphone/tablet/portátil).
Dev:: isMobile ( ): booleanFunção global relacionada (descrição veja acima).
(pular para trás)
is_mobile ( ): boolean if ( is_mobile () ) {
// I am a mobile device (smartphone/tablet or handheld)
}Valor de retorno:
Verdadeiro se o visitante atual usar um dispositivo móvel; caso contrário, falso.
Obtenha um objeto MobileDetect singleton para chamar todos os métodos que ele fornece.
Dev::mobileDetect( ): Detection MobileDetectAcesso público para uso fora desta classe. Documento Mobile_Detect: https://github.com/serbanghita/Mobile-Detect
Este método não possui função global relacionada!
(pular para trás)
Dev:: mobileDetect ()-> version ( ' Android ' );
// 8.1Valor de retorno:
Um objeto MobileDetect singleton para chamar todos os métodos que ele fornece.
Determina se o visitante atual usa um tablet.
Dev:: isTablet ( ): booleanFunção global relacionada (descrição veja acima).
(pular para trás)
is_tablet ( ): boolean if ( is_tablet () ) {
// I am a tablet
}Valor de retorno:
Verdadeiro se o visitante atual usar um tablet; caso contrário, falso.
Determina se o visitante atual usa um computador desktop.
Dev:: isDesktop ( ): booleanFunção global relacionada (descrição veja acima).
(pular para trás)
is_desktop ( ): boolean if ( is_desktop () ) {
// I am a desktop computer (Mac, Linux, Windows)
}Valor de retorno:
Verdadeiro se o visitante atual usar um computador desktop; caso contrário, falso.
Determina se o visitante atual é um mecanismo de pesquisa/bot/crawler/spider.
Dev:: isRobot ( ): booleanFunção global relacionada (descrição veja acima).
(pular para trás)
is_robot ( ): boolean if ( is_robot () ) {
// I am a robot (search engine, bot, crawler, spider)
}Valor de retorno:
Verdadeiro se o visitante atual for um mecanismo de pesquisa/bot/rastreador/aranha; caso contrário, falso.
Obtenha um objeto CrawlerDetect singleton para chamar todos os métodos que ele fornece.
Dev::crawlerDetect( ): Jaybizzle CrawlerDetect CrawlerDetectAcesso público para uso fora desta classe. Documento de detecção de rastreador: https://github.com/JayBizzle/Crawler-Detect
Este método não possui função global relacionada!
(pular para trás)
Dev:: crawlerDetect ()-> getMatches ();
// Output the name of the bot that matched (if any)Determina se o dispositivo atual está executando um sistema operacional Android.
Dev:: isAndroid ( ): booleanFunção global relacionada (descrição veja acima).
(pular para trás)
is_android ( ): boolean if ( is_android () ) {
// I am an Android based device
}Valor de retorno:
Verdadeiro se o visitante atual usar um dispositivo Android; caso contrário, falso.
Determina se o dispositivo atual é um iPhone.
Dev:: isIphone ( ): booleanFunção global relacionada (descrição veja acima).
(pular para trás)
is_iphone ( ): boolean if ( is_iphone () ) {
// I am an iPhone
}Valor de retorno:
Verdadeiro se o visitante atual usar um iPhone; caso contrário, falso.
Determina se o dispositivo atual é da Samsung.
Dev:: isSamsung ( ): booleanFunção global relacionada (descrição veja acima).
(pular para trás)
is_samsung ( ): boolean if ( is_samsung () ) {
// I am a device from Samsung
}Valor de retorno:
Verdadeiro se o visitante atual usar um dispositivo Samsung; caso contrário, falso.
Determina se o dispositivo atual está executando um sistema operacional iOS.
Dev:: isIOS ( ): booleanFunção global relacionada (descrição veja acima).
(pular para trás)
is_ios ( ): boolean if ( is_ios () ) {
// I am an iOS based device
}Valor de retorno:
Verdadeiro se o visitante atual usar um dispositivo iOS; caso contrário, falso.
Classe auxiliar que fornece acesso fácil a funções úteis de string php.
Classe Str
Insere uma ou mais strings em outra string em uma posição definida.
Str:: insert ( array $ keyValue , string $ string ): stringFunção global relacionada (descrição veja acima).
(pular para trás)
str_insert ( array $ keyValue , string $ string ): string $ keyValue = [
' :color ' => ' brown ' ,
' :animal ' => ' dog '
]
$ string = ' The quick :color fox jumps over the lazy :animal. ' ;
str_insert ( $ keyValue , $ string );
// The quick brown fox jumps over the lazy dog.| Parâmetro | Tipo | Descrição |
|---|---|---|
$keyValue | variedade | Uma matriz associativa com pares chave => valor. |
$string | corda | O texto com as strings a serem substituídas. |
Valor de retorno:
A string substituída.
Retorna o conteúdo em uma string entre um elemento esquerdo e um elemento direito.
Str:: between ( string $ left , string $ right , string $ string ): arrayFunção global relacionada (descrição veja acima).
(pular para trás)
str_between ( string $ left , string $ right , string $ string ): array $ string = ' <tag>foo</tag>foobar<tag>bar</tag> '
str_between ( ' <tag> ' , ' </tag> ' $ string );
// (
// [0] => foo
// [1] => bar
// )| Parâmetro | Tipo | Descrição |
|---|---|---|
$left | corda | O elemento esquerdo da string a ser pesquisada. |
$right | corda | O elemento certo da string a ser pesquisada. |
$string | corda | A string na qual pesquisar. |
Valor de retorno:
Uma matriz de resultados com todas as correspondências da pesquisa.
Retorna a parte de uma string após um determinado valor.
Str:: after ( string $ search , string $ string ): stringFunção global relacionada (descrição veja acima).
(pular para trás)
str_after ( string $ search , string $ string ): string $ string = ' The quick brown fox jumps over the lazy dog ' ;
str_after ( ' fox ' $ string );
// jumps over the lazy dog| Parâmetro | Tipo | Descrição |
|---|---|---|
$search | corda | A string a ser pesquisada. |
$string | corda | A string na qual pesquisar. |
Valor de retorno:
A string encontrada após a string de pesquisa. Os espaços em branco no início serão removidos.
Obtenha a parte de uma string antes de um determinado valor.
Str:: before ( string $ search , string $ string ): stringFunção global relacionada (descrição veja acima).
(pular para trás)
str_before ( string $ search , string $ string ): string $ string = ' The quick brown fox jumps over the lazy dog ' ;
str_before ( ' fox ' $ string );
// The quick brown| Parâmetro | Tipo | Descrição |
|---|---|---|
$search | corda | A string a ser pesquisada. |
$string | corda | A string na qual pesquisar. |
Valor de retorno:
A string encontrada antes da string de pesquisa. Os espaços em branco no final serão removidos.
Limite o número de palavras em uma string. Coloque o valor de $end no final da string.
Str:: limitWords ( string $ string , integer $ limit = 10 , string $ end = ' ... ' ): stringFunção global relacionada (descrição veja acima).
(pular para trás)
str_limit_words ( string $ string , int $ limit = 10 , string $ end = ' ... ' ): string $ string = ' The quick brown fox jumps over the lazy dog ' ;
str_limit_words ( $ string , 3 );
// The quick brown...| Parâmetro | Tipo | Descrição |
|---|---|---|
$string | corda | A string para limitar as palavras. |
$limit | inteiro | O número de palavras a limitar. O padrão é 10. |
$end | corda | A corda para finalizar a corda cortada. O padrão é '...' |
Valor de retorno:
A string limitada com $end no final.
Limite o número de caracteres em uma string. Coloque o valor de $end no final da string.
Str:: limit ( string $ string , integer $ limit = 100 , string $ end = ' ... ' ): stringFunção global relacionada (descrição veja acima).
(pular para trás)
str_limit ( string $ string , int $ limit = 100 , string $ end = ' ... ' ): string $ string = ' The quick brown fox jumps over the lazy dog ' ;
str_limit ( $ string , 15 );
// The quick brown...| Parâmetro | Tipo | Descrição |
|---|---|---|
$string | corda | A string para limitar os caracteres. |
$limit | inteiro | O número de caracteres a limitar. O padrão é 100. |
$end | corda | A corda para finalizar a corda cortada. O padrão é '...' |
Valor de retorno:
A string limitada com $end no final.
Testa se uma string contém um determinado elemento
Str:: contains ( string|array $ needle , string $ haystack ): booleanFunção global relacionada (descrição veja acima).
(pular para trás)
str_contains ( string|array $ needle , string $ haystack ): boolean $ string = ' The quick brown fox jumps over the lazy dog ' ;
$ array = [
' cat ' ,
' fox '
];
str_contains ( $ array , $ string );
// bool(true)| Parâmetro | Tipo | Descrição |
|---|---|---|
$needle | string|matriz | Uma string ou uma matriz de strings. |
$haystack | corda | A string na qual pesquisar. |
Valor de retorno:
Verdadeiro se $needle for encontrado, falso caso contrário.
Testa se uma string contém um determinado elemento. Ignore a distinção entre maiúsculas e minúsculas.
Str:: containsIgnoreCase ( string|array $ needle , string $ haystack ): booleanFunção global relacionada (descrição veja acima).
(pular para trás)
str_icontains ( string|array $ needle , string $ haystack ): boolean $ string = ' The quick brown fox jumps over the lazy dog ' ;
$ array = [
' Cat ' ,
' Fox '
];
str_icontains ( $ array , $ string );
// bool(true)| Parâmetro | Tipo | Descrição |
|---|---|---|
$needle | string|matriz | Uma string ou uma matriz de strings. |
$haystack | corda | A string na qual pesquisar. |
Valor de retorno:
Verdadeiro se $needle for encontrado, falso caso contrário.
Determine se uma determinada string começa com uma determinada substring.
Str:: startsWith ( string|array $ needle , string $ haystack ): booleanFunção global relacionada (descrição veja acima).
(pular para trás)
str_starts_with ( string|array $ needle , string $ haystack ): boolean $ string = ' The quick brown fox jumps over the lazy dog ' ;
$ array = [
' Cat ' ,
' The '
];
str_starts_with ( $ array , $ string );
// bool(true)| Parâmetro | Tipo | Descrição |
|---|---|---|
$needle | string|matriz | A string ou matriz de strings a serem pesquisadas. |
$haystack | corda | A string na qual pesquisar. |
Valor de retorno:
Verdadeiro se $needle for encontrado, falso caso contrário.
Determine se uma determinada string começa com uma determinada substring. Ignore a distinção entre maiúsculas e minúsculas.
Str:: startsWithIgnoreCase ( string|array $ needle , string $ haystack ): booleanFunção global relacionada (descrição veja acima).
(pular para trás)
str_istarts_with ( string|array $ needle , string $ haystack ): boolean $ string = ' The quick brown fox jumps over the lazy dog ' ;
$ array = [
' cat ' ,
' the '
];
str_istarts_with ( $ array , $ string );
// bool(true)| Parâmetro | Tipo | Descrição |
|---|---|---|
$needle | string|matriz | A string ou matriz de strings a serem pesquisadas. |
$haystack | corda | A string na qual pesquisar. |
Valor de retorno:
Verdadeiro se $needle for encontrado, falso caso contrário.
Determine se uma determinada string termina com uma determinada substring.
Str:: endsWith ( string|array $ needle , string $ haystack ): booleanFunção global relacionada (descrição veja acima).
(pular para trás)
str_ends_with ( string|array $ needle , string $ haystack ): boolean $ string = ' The quick brown fox jumps over the lazy dog ' ;
$ array = [
' cat ' ,
' dog '
];
str_ends_with ( $ array , $ string );
// bool(true)| Parâmetro | Tipo | Descrição |
|---|---|---|
$needle | string|matriz | A string ou matriz de strings a serem pesquisadas. |
$haystack | corda | A string na qual pesquisar. |
Valor de retorno:
Verdadeiro se $needle for encontrado, falso caso contrário.
Determine se uma determinada string termina com uma determinada substring.
Str:: endsWithIgnoreCase ( string|array $ needle , string $ haystack ): booleanFunção global relacionada (descrição veja acima).
(pular para trás)
str_iends_with ( string|array $ needle , string $ haystack ): boolean $ string = ' The quick brown fox jumps over the lazy dog ' ;
$ array = [
' Cat ' ,
' Dog '
];
str_iends_with ( $ array , $ string );
// bool(true)| Parâmetro | Tipo | Descrição |
|---|---|---|
$needle | string|matriz | A string ou matriz de strings a serem pesquisadas. |
$haystack | corda | A string na qual pesquisar. |
Valor de retorno:
Verdadeiro se $needle for encontrado, falso caso contrário.
Retorna a parte de uma string após a última ocorrência de um determinado valor de pesquisa.
Str:: afterLast ( string $ search , string $ string ): stringFunção global relacionada (descrição veja acima).
(pular para trás)
str_after_last ( string $ search , string $ string ): string $ path = " /var/www/html/public/img/image.jpg " ;
str_after_last ( ' / ' $ path );
// image.jpg| Parâmetro | Tipo | Descrição |
|---|---|---|
$search | corda | A string a ser pesquisada. |
$string | corda | A string na qual pesquisar. |
Valor de retorno:
A string encontrada após a última ocorrência da string de pesquisa. Os espaços em branco no início serão removidos.
Classe auxiliar que fornece acesso fácil a funções php comuns e úteis.
Classe Util
Valide um determinado endereço de e-mail.
Util:: isEmail ( string $ email ): booleanFunção global relacionada (descrição veja acima).
(pular para trás)
is_email ( string $ email ): boolean $ email = ' [email protected] ' ;
is_email ( $ email );
// bool(true)| Parâmetro | Tipo | Descrição |
|---|---|---|
$email | corda | O endereço de e-mail a ser testado. |
Valor de retorno:
Verdadeiro se a string fornecida for um endereço de e-mail válido; caso contrário, falso.
Obtenha o endereço IP atual do usuário.
Util:: ip ( ): string| nullFunção global relacionada (descrição veja acima).
(pular para trás)
ip ( ): null|string echo ip ();
// 127.0.0.1Valor de retorno:
O endereço IP detectado, nulo se o IP não foi detectado.
Cria um hash seguro a partir de uma determinada senha. Usa o algoritmo CRYPT_BLOWFISH.
Util:: cryptPassword ( string $ password ): stringNota: Recomenda-se 255 caracteres para coluna do banco de dados!
Função global relacionada (descrição veja acima).
(pular para trás)
crypt_password ( string $ password ): string $ password = ' foobar ' ;
crypt_password ( $ password );
// $2y$10$6qKwbwTgwQNcmcaw04eSf.QpP3.4T0..bEnY62dd1ozM8L61nb8AC| Parâmetro | Tipo | Descrição |
|---|---|---|
$password | corda | A senha para criptografar. |
Valor de retorno:
A senha criptografada.
Verifica se uma senha corresponde a uma senha criptografada (algoritmo CRYPT_BLOWFISH).
Util:: isPassword ( string $ password , string $ cryptedPassword ): booleanFunção global relacionada (descrição veja acima).
(pular para trás)
is_password ( string $ password , string $ cryptedPassword ): boolean $ password = ' foobar ' ;
$ cryptedPassword = ' $2y$10$6qKwbwTgwQNcmcaw04eSf.QpP3.4T0..bEnY62dd1ozM8L61nb8AC ' ;
is_password ( $ password , $ cryptedPassword );
// bool(true)| Parâmetro | Tipo | Descrição |
|---|---|---|
$password | corda | A senha a ser testada. |
$cryptedPassword | corda | A senha criptografada (por exemplo, armazenada no banco de dados). |
Despeja o conteúdo da variável fornecida e sai do script.
Util:: dd ( mixed $ var )Função global relacionada (descrição veja acima).
(pular para trás)
dd ( mixed $ var ) $ array = [
' foo ' => ' bar ' ,
' baz ' => ' qux '
];
dd ( $ array );
// (
// [foo] => bar
// [baz] => qux
// )| Parâmetro | Tipo | Descrição |
|---|---|---|
$var | misturado | A var a ser despejada. |
Despeja o conteúdo da variável fornecida. O script NÃO para após a chamada.
Util:: dump ( mixed $ var )Função global relacionada (descrição veja acima).
(pular para trás)
dump ( mixed $ var ) $ array = [
' foo ' => ' bar ' ,
' baz ' => ' qux '
];
dump ( $ array );
// (
// [foo] => bar
// [baz] => qux
// )| Parâmetro | Tipo | Descrição |
|---|---|---|
$var | misturado | A var a ser despejada. |
Classe auxiliar que fornece acesso fácil a funções úteis do php yml.
Classe Yml
Valida se um determinado arquivo contém sintaxe yaml.
Yml:: isValidFile ( string $ file ): booleanFunção global relacionada (descrição veja acima).
(pular para trás)
is_yml_file ( string $ file ): boolean $ file = /path/to/file.yml
is_yml_file ( $ file );
// bool(true)| Parâmetro | Tipo | Descrição |
|---|---|---|
$file | corda | O arquivo para testar a sintaxe yaml. |
Valor de retorno:
Verdadeiro se o arquivo contiver sintaxe yaml; caso contrário, falso.
Testa se a sintaxe de uma determinada string é yaml.
Yml:: isValid ( string $ string ): booleanFunção global relacionada (descrição veja acima).
(pular para trás)
is_yml ( string $ string ): boolean $ string = "
foo: bar
baz: qux
foobar:
foo: bar
" ;
is_yml ( $ string );
// bool(true)| Parâmetro | Tipo | Descrição |
|---|---|---|
$string | corda | A string para testar a sintaxe yaml. |
Valor de retorno:
True se a string for yaml, false caso contrário.
Transforma uma determinada string yaml em um array.
Yml:: parse ( string $ yml ): array| nullFunção global relacionada (descrição veja acima).
(pular para trás)
yml_parse ( string $ yml ): array| null $ yml = "
foo: bar
baz: qux
foobar:
foo: bar
" ;
yml_parse ( $ yml );
// (
// [foo] => bar
// [baz] => qux
// [foobar] => (
// [foo] => bar
// )
// )| Parâmetro | Tipo | Descrição |
|---|---|---|
$yml | corda | A string yaml a ser analisada. |
Valor de retorno:
A matriz transformada, nula em caso de erro.
Obtém um valor em uma string yaml usando a notação de ponto.
Yml:: get ( string $ key , string $ yml ): mixedFunção global relacionada (descrição veja acima).
(pular para trás)
yml_get ( string $ key , string $ yml ): mixed $ yml = "
foo: bar
baz: qux
foobar:
foo: bar
" ;
yml_get ( ' foobar.foo ' , $ yml );
// bar| Parâmetro | Tipo | Descrição |
|---|---|---|
$key | corda | A chave para pesquisar usando notação de ponto (por exemplo, 'foo.bar.baz'). |
$yml | corda | A string yml na qual pesquisar. |
Valor de retorno:
O valor encontrado, caso contrário nulo.
Obtém um valor em um arquivo yaml usando a notação de ponto.
Yml:: getFile ( string $ key , string $ ymlfile ): mixedFunção global relacionada (descrição veja acima).
(pular para trás)
yml_get_file ( string $ key , string $ ymlfile ): mixed $ ymlfile = ' /path/to/file.yml ' ;
yml_get_file ( ' foobar.foo ' , $ ymlfile );
// bar| Parâmetro | Tipo | Descrição |
|---|---|---|
$key | corda | A chave para pesquisar usando notação de ponto (por exemplo, 'foo.bar.baz'). |
$ymlfile | corda | O arquivo yml no qual pesquisar. |
Valor de retorno:
O valor encontrado, caso contrário nulo.
Carrega o conteúdo de um yamlfile em um array.
Yml:: parseFile ( string $ ymlfile ): arrayFunção global relacionada (descrição veja acima).
(pular para trás)
yml_parse_file ( string $ ymlfile ): array| null $ ymlfile = ' /path/to/file.yml ' ;
yml_parse_file ( $ ymlfile );
// (
// [foo] => bar
// [baz] => qux
// [foobar] => (
// [foo] => bar
// )
// )| Parâmetro | Tipo | Descrição |
|---|---|---|
$ymlfile | corda | O caminho do arquivo a ser lido. |
Valor de retorno:
A matriz analisada.
Define um valor em um arquivo yaml usando a notação de ponto. Nota: todos os comentários no arquivo serão removidos!
Yml:: setFile ( string $ key , mixed $ value , string $ ymlfile ): booleanFunção global relacionada (descrição veja acima).
(pular para trás)
yml_set_file ( string $ key , mixed $ value , string $ ymlfile ): boolean $ ymlfile = ' /path/to/file.yml ' ;
yml_set_file ( ' foobar.foo ' , ' baz ' , $ ymlfile );
// foo: bar
// baz: qux
// foobar:
// foo: baz| Parâmetro | Tipo | Descrição |
|---|---|---|
$key | corda | A string a ser pesquisada com notação de ponto |
$value | misturado | O valor a ser definido na chave especificada. |
$ymlfile | corda | O arquivo yml no qual definir o valor. |
Valor de retorno:
Verdadeiro se o valor foi definido com sucesso no yamlfile, caso contrário, falso.
Transforma um determinado array em sintaxe yaml e coloca seu conteúdo em um determinado arquivo. Nota: se o arquivo existir, ele será sobrescrito!
Yml:: dumpFile ( array|object $ var , string $ filename , integer $ indent = 2 , integer $ wordwrap , boolean $ openingDashes = false ): booleanFunção global relacionada (descrição veja acima).
(pular para trás)
to_yml_file ( array|object $ var , string $ filename , int $ indent = 2 , int $ wordwrap = 0 , bool $ openingDashes = false ): boolean $ array = [
' foo ' => ' bar ' ,
' baz ' => ' qux '
];
to_yml_file ( $ array , ' /path/to/file.yml ' );
// foo: bar
// baz: qux| Parâmetro | Tipo | Descrição |
|---|---|---|
$var | matriz|objeto | A matriz ou objeto a ser transformado. |
$filename | corda | O caminho para o arquivo no qual gravar a string yaml. Nota: se o arquivo já existir, ele será sobrescrito! |
$indent | inteiro | O recuo do yaml convertido. O padrão é 2. |
$wordwrap | inteiro | Após o número fornecido, uma string será quebrada. O padrão é 0 (sem quebra de linha). |
$openingDashes | booleano | Verdadeiro se a string yaml deve começar com travessões de abertura. O padrão é falso. |
Valor de retorno:
Verdadeiro em caso de sucesso, falso caso contrário.
Transforma um determinado array ou objeto em uma string yaml.
Yml:: dump ( array|object $ var , integer $ indent = 2 , integer $ wordwrap , boolean $ openingDashes = false ): string| nullFunção global relacionada (descrição veja acima).
(pular para trás)
to_yml ( array|object $ array , string $ filename , int $ indent = 2 , int $ wordwrap = 0 , bool $ openingDashes = false ): string| null $ array = [
' foo ' => ' bar ' ,
' baz ' => ' qux ' ,
' foobar ' => [
' foo ' => ' bar '
]
];
to_yml ( $ array );
// foo: bar
// baz: qux
// foobar:
// foo: bar| Parâmetro | Tipo | Descrição |
|---|---|---|
$var | matriz|objeto | A matriz ou objeto a ser transformado. |
$indent | inteiro | O recuo do yaml convertido. O padrão é 2. |
$wordwrap | inteiro | Após o número fornecido, uma string será quebrada. O padrão é 0 (sem quebra de linha). |
$openingDashes | booleano | Verdadeiro se a string yaml deve começar com travessões de abertura. O padrão é falso. |
Valor de retorno:
A string yaml convertida. Em caso de erros, null é retornado.
Define um valor em uma string yaml usando a notação de ponto.
Yml:: set ( string $ key , mixed $ value , string & $ yml ): booleanFunção global relacionada (descrição veja acima).
(pular para trás)
yml_set ( string $ key , mixed $ value , string & $ yml ): boolean $ yml = "
foo: bar
baz: qux
foobar:
foo: bar
" ;
yml_set ( ' foobar.foo ' , ' baz ' , $ yml );
// foo: bar
// baz: qux
// foobar:
// foo: baz| Parâmetro | Tipo | Descrição |
|---|---|---|
$key | corda | A string a ser pesquisada com notação de ponto |
$value | misturado | O valor a ser definido na chave especificada. |
$yml | corda | A string yml para pesquisar. Observação: todos os comentários na string serão removidos! |
Valor de retorno:
Verdadeiro se o valor foi definido com sucesso; caso contrário, falso.
Este documento foi gerado automaticamente a partir de comentários do código-fonte em 22/01/2018 usando phpDocumentor e cvuorinen/phpdoc-markdown-public
