Главная страница>Исходный код PHP>Другие категории
Скачать

О

Библиотека clausnz/php-helpers представляет собой набор из 45 полезных вспомогательных функций PHP (PHP 5.6, 7.*) .
После установки с помощью composer глобальные функции доступны из любого места вашего кода:

Установка 

composer require clausnz/php-helpers

Пример 

 <?php

dump ( ' any content ' );

Если функция с таким именем уже существует в списке определенных функций вашего проекта (встроенных и пользовательских), она просто не будет зарегистрирована в вашей среде. Поэтому никаких конфликтов с существующими функциями не возникнет.

Тем не менее, каждая функция по-прежнему доступна статически с помощью правильного оператора использования:

Пример 

 <?php

use CNZ  Helpers  Util as util ;

util:: dump ( ' any content ' );

КРЕДИТЫ

Эта библиотека использует следующие блестящие и хорошо известные библиотеки:

  • https://github.com/serbanghita/Mobile-Detect
  • https://github.com/JayBizzle/Crawler-Detect
  • https://github.com/mustangostang/spyc

Тесты

Все функции тестируются с помощью ряда модульных тестов и версий PHP.

Установить

Установите последнюю версию библиотеки clausnz/php-helper с помощью композитора: 

composer require clausnz/php-helpers

Также убедитесь, что вам требуется файл автозагрузки композитора: 

 require __DIR__ . ' /vendor/autoload.php ' ;

После установки новые глобальные функции PHP станут доступны повсюду в вашем коде. Чтобы получить доступ к (почти идентичным) статическим функциям во вспомогательных классах, добавьте в файл соответствующий оператор использования:

Пример 

 <?php

use CNZ  Helpers  Dev as dev ;

if ( dev:: isIphone () ) {
   // Do something here
}

Доступные функции PHP

Оглавление

  • Устройство
    • is_mobile
    • is_smartphone
    • is_tablet
    • is_desktop
    • is_robot
    • is_ios
    • is_android
    • is_iphone
    • is_samsung
  • Множество
    • array_get
    • array_set
    • array_first
    • array_last
    • to_array
    • to_object
    • is_assoc
  • Нить
    • str_before
    • str_after
    • str_after_last
    • str_between
    • str_insert
    • str_limit
    • str_limit_words
    • str_contains
    • str_icontains
    • str_starts_with
    • str_istarts_with
    • str_ends_with
    • str_iends_with
  • Утилиты
    • IP
    • is_email
    • свалка
    • дд
    • crypt_password
    • is_password
  • Юмл
    • to_yml
    • to_yml_file
    • yml_parse
    • yml_parse_file
    • is_yml
    • is_yml_file
    • yml_get
    • yml_get_file
    • yml_set
    • yml_set_file

API-документация

Оглавление

  • Прибытие
    • isAssoc
    • toObject
    • свалка
    • первый
    • последний
    • получать
    • набор
  • Дев
    • isСмартфон
    • isMobile
    • mobileDetect
    • isTablet
    • isDesktop
    • isRobot
    • сканеробнаружить
    • isAndroid
    • isIphone
    • isSamsung
    • isIOS
  • ул.
    • вставлять
    • между
    • после
    • до
    • лимит слов
    • предел
    • содержит
    • содержитИгнорКейс
    • начинается с
    • начинается сIgnoreCase
    • заканчивается с
    • заканчивается сигнорекейс
    • после последнего
  • Утилита
    • isEmail
    • IP
    • cryptPassword
    • isPassword
    • дд
    • свалка
  • Юмл
    • isValidFile
    • isValid
    • анализировать
    • получать
    • получить файл
    • РазобратьФайл
    • setFile
    • файл дампа
    • свалка
    • набор

Прибытие

Вспомогательный класс, обеспечивающий легкий доступ к полезным функциям массива PHP.

Класс Приб.

  • Полное имя: CNZHelpersArr

isAssoc

Определяет, является ли данное значение ассоциативным массивом. 

Arr:: isAssoc ( array $ array ): boolean

is_assoc

Соответствующая глобальная функция (описание см. выше).

(прыгнуть назад) 

 is_assoc ( array $ array ): boolean

Пример 

 $ array = [
    ' foo ' => ' bar '
];

is_assoc ( $ array );

// bool(true)
  • Этот метод является статическим . Параметры:
Параметр Тип Описание
$array множество Любой тип массива.

Возвращаемое значение:

True, если массив ассоциативен, в противном случае — false.

toObject

Преобразует массив в объект. 

Arr:: toObject ( array $ array ): object| null

to_object

Соответствующая глобальная функция (описание см. выше).

(прыгнуть назад) 

 to_object ( array $ array ): object| null

Пример 

 $ array = [
    ' foo ' => [
         ' bar ' => ' baz '
    ]
];

$ obj = to_object ( $ array );
echo $ obj -> foo -> bar ;

// baz
  • Этот метод является статическим . Параметры:
Параметр Тип Описание
$array множество Массив, который нужно преобразовать.

Возвращаемое значение:

Стандартное объектное представление преобразованного массива.

свалка

Преобразует строку или объект в массив. 

Arr:: dump ( string|object $ var ): array| null

to_array

Соответствующая глобальная функция (описание см. выше).

(прыгнуть назад) 

 to_array ( string|object $ var ): array| null

Пример 1 (строка) 

 $ var = ' php ' ;
to_array ( $ var );

// (
//     [0] => p
//     [1] => h
//     [2] => p
// )

Пример 2 (объект) 

 $ var = new stdClass ;
$ var -> foo = ' bar ' ;

to_array ( $ var );

// (
//     [foo] => bar
// )
  • Этот метод является статическим . Параметры:
Параметр Тип Описание
$var строка|объект Строка или объект.

Возвращаемое значение:

Представление массива преобразованной строки или объекта. Возвращает ноль в случае ошибки.

первый

Возвращает первый элемент массива. 

Arr:: first ( array $ array ): mixed

array_first

Соответствующая глобальная функция (описание см. выше).

(прыгнуть назад) 

 array_first ( array $ array ): mixed

Пример 

 $ array = [
     ' foo ' => ' bar ' ,
     ' baz ' => ' qux '
];

array_first ( $ array )

// bar
  • Этот метод является статическим . Параметры:
Параметр Тип Описание
$array множество Соответствующий массив.

Возвращаемое значение:

Значение первого элемента без ключа. Смешанный тип.

последний

Возвращает последний элемент массива. 

Arr:: last ( array $ array ): mixed

array_last

Соответствующая глобальная функция (описание см. выше).

(прыгнуть назад) 

 array_last ( array $ array ): mixed

Пример 

 $ array = [
     ' foo ' => ' bar ' ,
     ' baz ' => ' qux '
];

array_last ( $ array )

// qux
  • Этот метод является статическим . Параметры:
Параметр Тип Описание
$array множество Соответствующий массив.

Возвращаемое значение:

Значение последнего элемента без ключа. Смешанный тип.

получать

Получает значение в массиве с помощью точечной записи ключей. 

Arr:: get ( string $ key , array $ array ): mixed

array_get

Соответствующая глобальная функция (описание см. выше).

(прыгнуть назад) 

 array_get ( string key, array $ array ): mixed

Пример 

 $ array = [
     ' foo ' => ' bar ' ,
     ' baz ' => [
         ' qux => ' foobar'
     ]
];

array_get ( ' baz.qux ' , $ array );

// foobar
  • Этот метод является статическим . Параметры:
Параметр Тип Описание
$key нить Ключ в точечной записи.
$array множество Массив для поиска.

Возвращаемое значение:

Искомое значение, в противном случае — значение null.

набор

Устанавливает значение в массиве, используя точечную запись. 

Arr:: set ( string $ key , mixed $ value , array & $ array ): boolean

array_set

Соответствующая глобальная функция (описание см. выше).

(прыгнуть назад) 

 array_set ( string key, mixed value, array $ array ): boolean

Пример 1 

 $ array = [
     ' foo ' => ' bar ' ,
     ' baz ' => [
         ' qux => ' foobar'
     ]
];

array_set ( ' baz.qux ' , ' bazqux ' , $ array );

// (
//     [foo] => bar
//     [baz] => [
//         [qux] => bazqux
//     ]
// )

Пример 2 

 $ array = [
     ' foo ' => ' bar ' ,
     ' baz ' => [
         ' qux => ' foobar'
     ]
];

array_set ( ' baz.foo ' , ' bar ' , $ array );

// (
//     [foo] => bar
//     [baz] => [
//         [qux] => bazqux
//         [foo] => bar
//     ]
// )
  • Этот метод является статическим . Параметры:
Параметр Тип Описание
$key нить Ключ для установки с использованием точечной записи.
$value смешанный Значение, которое необходимо установить для указанного ключа.
$array множество Соответствующий массив.

Возвращаемое значение:

True, если новое значение было успешно установлено, в противном случае — false.

Дев

Вспомогательный класс, который обеспечивает легкий доступ к полезным функциям PHP в сочетании с пользовательским агентом.

Класс разработчиков

  • Полное имя: CNZHelpersDev

isСмартфон

Определяет, является ли текущее устройство смартфоном. 

Dev:: isSmartphone (  ): boolean

is_smartphone

Соответствующая глобальная функция (описание см. выше).

(прыгнуть назад) 

 is_smartphone (  ): boolean

Пример 

 if ( is_smartphone () ) {
     // I am a smartphone
}
  • Этот метод является статическим .

Возвращаемое значение:

True, если текущий посетитель использует смартфон, в противном случае — false.

isMobile

Определяет, использует ли текущий посетитель мобильное устройство (смартфон/планшет/карманное устройство). 

Dev:: isMobile (  ): boolean

is_mobile

Соответствующая глобальная функция (описание см. выше).

(прыгнуть назад) 

 is_mobile (  ): boolean

Пример 

 if ( is_mobile () ) {
     // I am a mobile device (smartphone/tablet or handheld)
}
  • Этот метод является статическим .

Возвращаемое значение:

True, если текущий посетитель использует мобильное устройство, в противном случае — false.

mobileDetect

Получите одноэлементный объект MobileDetect для вызова каждого предоставляемого им метода. 

Dev::mobileDetect(  ):  Detection  MobileDetect

Публичный доступ для использования за пределами этого класса. Документация Mobile_Detect: https://github.com/serbanghita/Mobile-Detect.

Этот метод не имеет связанной глобальной функции!

(прыгнуть назад)

Пример 

Dev:: mobileDetect ()-> version ( ' Android ' );

// 8.1
  • Этот метод является статическим .

Возвращаемое значение:

Одноэлементный объект MobileDetect для вызова каждого предоставляемого им метода.

isTablet

Определяет, использует ли текущий посетитель планшетное устройство. 

Dev:: isTablet (  ): boolean

is_tablet

Соответствующая глобальная функция (описание см. выше).

(прыгнуть назад) 

 is_tablet (  ): boolean

Пример 

 if ( is_tablet () ) {
     // I am a tablet
}
  • Этот метод является статическим .

Возвращаемое значение:

Значение true, если текущий посетитель использует планшетное устройство, в противном случае — значение false.

isDesktop

Определяет, использует ли текущий посетитель настольный компьютер. 

Dev:: isDesktop (  ): boolean

is_desktop

Соответствующая глобальная функция (описание см. выше).

(прыгнуть назад) 

 is_desktop (  ): boolean

Пример 

 if ( is_desktop () ) {
     // I am a desktop computer (Mac, Linux, Windows)
}
  • Этот метод является статическим .

Возвращаемое значение:

Значение true, если текущий посетитель использует настольный компьютер, в противном случае — значение false.

isRobot

Определяет, является ли текущий посетитель поисковой системой/ботом/сканером/пауком. 

Dev:: isRobot (  ): boolean

is_robot

Соответствующая глобальная функция (описание см. выше).

(прыгнуть назад) 

 is_robot (  ): boolean

Пример 

 if ( is_robot () ) {
     // I am a robot (search engine, bot, crawler, spider)
}
  • Этот метод является статическим .

Возвращаемое значение:

True, если текущий посетитель является поисковой системой/ботом/сканером/пауком, в противном случае — false.

сканеробнаружить

Получите одноэлементный объект CrawlerDetect для вызова каждого предоставляемого им метода. 

Dev::crawlerDetect(  ):  Jaybizzle  CrawlerDetect  CrawlerDetect

Публичный доступ для использования за пределами этого класса. Документация Crawler-Detect: https://github.com/JayBizzle/Crawler-Detect.

Этот метод не имеет связанной глобальной функции!

(прыгнуть назад)

Пример 

Dev:: crawlerDetect ()-> getMatches ();

// Output the name of the bot that matched (if any)
  • Этот метод является статическим .

isAndroid

Определяет, работает ли на текущем устройстве операционная система Android. 

Dev:: isAndroid (  ): boolean

is_android

Соответствующая глобальная функция (описание см. выше).

(прыгнуть назад) 

 is_android (  ): boolean

Пример 

 if ( is_android () ) {
     // I am an Android based device
}
  • Этот метод является статическим .

Возвращаемое значение:

Значение true, если текущий посетитель использует устройство на базе Android, в противном случае — значение false.

isIphone

Определяет, является ли текущее устройство iPhone. 

Dev:: isIphone (  ): boolean

is_iphone

Соответствующая глобальная функция (описание см. выше).

(прыгнуть назад) 

 is_iphone (  ): boolean

Пример 

 if ( is_iphone () ) {
     // I am an iPhone
}
  • Этот метод является статическим .

Возвращаемое значение:

True, если текущий посетитель использует iPhone, в противном случае — false.

isSamsung

Определяет, принадлежит ли текущее устройство компании Samsung. 

Dev:: isSamsung (  ): boolean

is_samsung

Соответствующая глобальная функция (описание см. выше).

(прыгнуть назад) 

 is_samsung (  ): boolean

Пример 

 if ( is_samsung () ) {
     // I am a device from Samsung
}
  • Этот метод является статическим .

Возвращаемое значение:

True, если текущий посетитель использует устройство Samsung, в противном случае — false.

isIOS

Определяет, работает ли на текущем устройстве операционная система iOS. 

Dev:: isIOS (  ): boolean

is_ios

Соответствующая глобальная функция (описание см. выше).

(прыгнуть назад) 

 is_ios (  ): boolean

Пример 

 if ( is_ios () ) {
     // I am an iOS based device
}
  • Этот метод является статическим .

Возвращаемое значение:

True, если текущий посетитель использует устройство iOS, в противном случае — false.

ул.

Вспомогательный класс, который обеспечивает легкий доступ к полезным строковым функциям PHP.

Класс Стр.

  • Полное имя: CNZHelpersStr

вставлять

Вставляет одну или несколько строк в другую строку в определенной позиции. 

Str:: insert ( array $ keyValue , string $ string ): string

str_insert

Соответствующая глобальная функция (описание см. выше).

(прыгнуть назад) 

 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.
  • Этот метод является статическим . Параметры:
Параметр Тип Описание
$keyValue множество Ассоциативный массив с парами ключ => значение.
$string нить Текст со строками, которые необходимо заменить.

Возвращаемое значение:

Заменяемая строка.

между

Возвращает содержимое строки между левым и правым элементом. 

Str:: between ( string $ left , string $ right , string $ string ): array

str_between

Соответствующая глобальная функция (описание см. выше).

(прыгнуть назад) 

 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
// )
  • Этот метод является статическим . Параметры:
Параметр Тип Описание
$left нить Левый элемент строки для поиска.
$right нить Правый элемент строки для поиска.
$string нить Строка для поиска.

Возвращаемое значение:

Массив результатов со всеми совпадениями поиска.

после

Возвращает часть строки после заданного значения. 

Str:: after ( string $ search , string $ string ): string

str_after

Соответствующая глобальная функция (описание см. выше).

(прыгнуть назад) 

 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
  • Этот метод является статическим . Параметры:
Параметр Тип Описание
$search нить Строка для поиска.
$string нить Строка для поиска.

Возвращаемое значение:

Найденная строка после строки поиска. Пробелы в начале будут удалены.

до

Получить часть строки перед заданным значением. 

Str:: before ( string $ search , string $ string ): string

str_before

Соответствующая глобальная функция (описание см. выше).

(прыгнуть назад) 

 str_before ( string $ search , string $ string ): string

Пример 

 $ string = ' The quick brown fox jumps over the lazy dog ' ;

str_before ( ' fox ' $ string );

// The quick brown
  • Этот метод является статическим . Параметры:
Параметр Тип Описание
$search нить Строка для поиска.
$string нить Строка для поиска.

Возвращаемое значение:

Найденная строка перед строкой поиска. Пробелы в конце будут удалены.

лимит слов

Ограничьте количество слов в строке. Поместите значение $end в конец строки. 

Str:: limitWords ( string $ string , integer $ limit = 10 , string $ end = ' ... ' ): string

str_limit_words

Соответствующая глобальная функция (описание см. выше).

(прыгнуть назад) 

 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...
  • Этот метод является статическим . Параметры:
Параметр Тип Описание
$string нить Строка для ограничения слов.
$limit целое число Количество слов, которое нужно ограничить. По умолчанию 10.
$end нить Строка, которой заканчивается обрезанная строка. По умолчанию '...'

Возвращаемое значение:

Ограниченная строка с $end в конце.

предел

Ограничьте количество символов в строке. Поместите значение $end в конец строки. 

Str:: limit ( string $ string , integer $ limit = 100 , string $ end = ' ... ' ): string

str_limit

Соответствующая глобальная функция (описание см. выше).

(прыгнуть назад) 

 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...
  • Этот метод является статическим . Параметры:
Параметр Тип Описание
$string нить Строка для ограничения символов.
$limit целое число Количество символов, которое нужно ограничить. По умолчанию 100.
$end нить Строка, завершающая обрезанную строку. По умолчанию '...'

Возвращаемое значение:

Ограниченная строка с $end в конце.

содержит

Проверяет, содержит ли строка заданный элемент 

Str:: contains ( string|array $ needle , string $ haystack ): boolean

str_contains

Соответствующая глобальная функция (описание см. выше).

(прыгнуть назад) 

 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)
  • Этот метод является статическим . Параметры:
Параметр Тип Описание
$needle строка|массив Строка или массив строк.
$haystack нить Строка для поиска.

Возвращаемое значение:

True, если найден $needle, в противном случае — false.

содержитИгнорКейс

Проверяет, содержит ли строка заданный элемент. Игнорируйте чувствительность к регистру. 

Str:: containsIgnoreCase ( string|array $ needle , string $ haystack ): boolean

str_icontains

Соответствующая глобальная функция (описание см. выше).

(прыгнуть назад) 

 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)
  • Этот метод является статическим . Параметры:
Параметр Тип Описание
$needle строка|массив Строка или массив строк.
$haystack нить Строка для поиска.

Возвращаемое значение:

True, если найден $needle, в противном случае — false.

начинается с

Определите, начинается ли данная строка с данной подстроки. 

Str:: startsWith ( string|array $ needle , string $ haystack ): boolean

str_starts_with

Соответствующая глобальная функция (описание см. выше).

(прыгнуть назад) 

 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)
  • Этот метод является статическим . Параметры:
Параметр Тип Описание
$needle строка|массив Строка или массив строк для поиска.
$haystack нить Строка для поиска.

Возвращаемое значение:

True, если $needle найден, в противном случае — false.

начинается сIgnoreCase

Определите, начинается ли данная строка с данной подстроки. Игнорируйте чувствительность к регистру. 

Str:: startsWithIgnoreCase ( string|array $ needle , string $ haystack ): boolean

str_istarts_with

Соответствующая глобальная функция (описание см. выше).

(прыгнуть назад) 

 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)
  • Этот метод является статическим . Параметры:
Параметр Тип Описание
$needle строка|массив Строка или массив строк для поиска.
$haystack нить Строка для поиска.

Возвращаемое значение:

True, если был найден $needle, в противном случае — false.

заканчивается с

Определите, заканчивается ли данная строка данной подстрокой. 

Str:: endsWith ( string|array $ needle , string $ haystack ): boolean

str_ends_with

Соответствующая глобальная функция (описание см. выше).

(прыгнуть назад) 

 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)
  • Этот метод является статическим . Параметры:
Параметр Тип Описание
$needle строка|массив Строка или массив строк для поиска.
$haystack нить Строка для поиска.

Возвращаемое значение:

True, если был найден $needle, в противном случае — false.

заканчивается сигнорироватькейс

Определите, заканчивается ли данная строка данной подстрокой. 

Str:: endsWithIgnoreCase ( string|array $ needle , string $ haystack ): boolean

str_iends_with

Соответствующая глобальная функция (описание см. выше).

(прыгнуть назад) 

 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)
  • Этот метод является статическим . Параметры:
Параметр Тип Описание
$needle строка|массив Строка или массив строк для поиска.
$haystack нить Строка для поиска.

Возвращаемое значение:

True, если был найден $needle, в противном случае — false.

после последнего

Возвращает часть строки после последнего появления данного искомого значения. 

Str:: afterLast ( string $ search , string $ string ): string

str_after_last

Соответствующая глобальная функция (описание см. выше).

(прыгнуть назад) 

 str_after_last ( string $ search , string $ string ): string

Пример 

 $ path = " /var/www/html/public/img/image.jpg " ;

str_after_last ( ' / ' $ path );

// image.jpg
  • Этот метод является статическим . Параметры:
Параметр Тип Описание
$search нить Строка для поиска.
$string нить Строка для поиска.

Возвращаемое значение:

Найденная строка после последнего вхождения искомой строки. Пробелы в начале будут удалены.

Утилита

Вспомогательный класс, обеспечивающий легкий доступ к полезным общим функциям PHP.

Класс Утилита

  • Полное имя: CNZHelpersUtil.

isEmail

Подтвердите указанный адрес электронной почты. 

Util:: isEmail ( string $ email ): boolean

is_email

Соответствующая глобальная функция (описание см. выше).

(прыгнуть назад) 

 is_email ( string $ email ): boolean

Пример 

 $ email = ' [email protected] ' ;

is_email ( $ email );

// bool(true)
  • Этот метод является статическим . Параметры:
Параметр Тип Описание
$email нить Адрес электронной почты для тестирования.

Возвращаемое значение:

True, если данная строка является действительным адресом электронной почты, в противном случае — false.

IP

Получите текущий IP-адрес пользователя. 

Util:: ip (  ): string| null

user_ip

Соответствующая глобальная функция (описание см. выше).

(прыгнуть назад) 

 ip (  ): null|string

Пример 

 echo ip ();

// 127.0.0.1
  • Этот метод является статическим .

Возвращаемое значение:

Обнаруженный IP-адрес, ноль, если IP-адрес не был обнаружен.

cryptPassword

Создает безопасный хэш на основе заданного пароля. Использует алгоритм CRYPT_BLOWFISH. 

Util:: cryptPassword ( string $ password ): string

Примечание. Рекомендуется длина столбца базы данных 255 символов!

crypt_password

Соответствующая глобальная функция (описание см. выше).

(прыгнуть назад) 

 crypt_password ( string $ password ): string

Пример 

 $ password = ' foobar ' ;

crypt_password ( $ password );

// $2y$10$6qKwbwTgwQNcmcaw04eSf.QpP3.4T0..bEnY62dd1ozM8L61nb8AC
  • Этот метод является статическим . Параметры:
Параметр Тип Описание
$password нить Пароль для шифрования.

Возвращаемое значение:

Зашифрованный пароль.

isPassword

Проверяет соответствие пароля зашифрованному паролю (алгоритм CRYPT_BLOWFISH). 

Util:: isPassword ( string $ password , string $ cryptedPassword ): boolean

is_password

Соответствующая глобальная функция (описание см. выше).

(прыгнуть назад) 

 is_password ( string $ password , string $ cryptedPassword ): boolean

Пример 

 $ password = ' foobar ' ;
$ cryptedPassword = ' $2y$10$6qKwbwTgwQNcmcaw04eSf.QpP3.4T0..bEnY62dd1ozM8L61nb8AC ' ;

is_password ( $ password , $ cryptedPassword );

// bool(true)
  • Этот метод является статическим . Параметры:
Параметр Тип Описание
$password нить Пароль для проверки.
$cryptedPassword нить Зашифрованный пароль (например, сохраненный в базе данных).

дд

Сбрасывает содержимое данной переменной и выходит из скрипта. 

Util:: dd ( mixed $ var )

дд

Соответствующая глобальная функция (описание см. выше).

(прыгнуть назад) 

 dd ( mixed $ var )

Пример 

 $ array = [
     ' foo ' => ' bar ' ,
     ' baz ' => ' qux '
];

dd ( $ array );

// (
//     [foo] => bar
//     [baz] => qux
// )
  • Этот метод является статическим . Параметры:
Параметр Тип Описание
$var смешанный Вар для сброса.

свалка

Выводит содержимое заданной переменной. Скрипт НЕ останавливается после вызова. 

Util:: dump ( mixed $ var )

свалка

Соответствующая глобальная функция (описание см. выше).

(прыгнуть назад) 

 dump ( mixed $ var )

Пример 

 $ array = [
     ' foo ' => ' bar ' ,
     ' baz ' => ' qux '
];

dump ( $ array );

// (
//     [foo] => bar
//     [baz] => qux
// )
  • Этот метод является статическим . Параметры:
Параметр Тип Описание
$var смешанный Вар для сброса.

Юмл

Вспомогательный класс, обеспечивающий легкий доступ к полезным функциям php yml.

Класс Yml

  • Полное имя: CNZHelpersYml

isValidFile

Проверяет, содержит ли данный файл синтаксис yaml. 

Yml:: isValidFile ( string $ file ): boolean

is_yml_file

Соответствующая глобальная функция (описание см. выше).

(прыгнуть назад) 

 is_yml_file ( string $ file ): boolean

Пример 

 $ file = /path/to/file.yml

is_yml_file ( $ file );

// bool(true)
  • Этот метод является статическим . Параметры:
Параметр Тип Описание
$file нить Файл для проверки синтаксиса yaml.

Возвращаемое значение:

True, если файл содержит синтаксис yaml, в противном случае — false.

isValid

Проверяет, является ли синтаксис данной строки yaml. 

Yml:: isValid ( string $ string ): boolean

is_yml

Соответствующая глобальная функция (описание см. выше).

(прыгнуть назад) 

 is_yml ( string $ string ): boolean

Пример 

 $ string = "
     foo: bar
     baz: qux
     foobar:
         foo: bar
" ;

is_yml ( $ string );

// bool(true)
  • Этот метод является статическим . Параметры:
Параметр Тип Описание
$string нить Строка для проверки синтаксиса yaml.

Возвращаемое значение:

True, если строка имеет формат yaml, в противном случае — false.

анализировать

Преобразует заданную строку yaml в массив. 

Yml:: parse ( string $ yml ): array| null

yml_parse

Соответствующая глобальная функция (описание см. выше).

(прыгнуть назад) 

 yml_parse ( string $ yml ): array| null

Пример 

 $ yml = "
     foo: bar
     baz: qux
     foobar:
         foo: bar
" ;

yml_parse ( $ yml );

// (
//       [foo] => bar
//       [baz] => qux
//       [foobar] => (
//           [foo] => bar
//       )
// )
  • Этот метод является статическим . Параметры:
Параметр Тип Описание
$yml нить Строка Yaml для анализа.

Возвращаемое значение:

Преобразованный массив, имеющий значение null в случае ошибки.

получать

Получает значение в строке yaml, используя точечную запись. 

Yml:: get ( string $ key , string $ yml ): mixed

yml_get

Соответствующая глобальная функция (описание см. выше).

(прыгнуть назад) 

 yml_get ( string $ key , string $ yml ): mixed

Пример 

 $ yml = "
     foo: bar
     baz: qux
     foobar:
         foo: bar
" ;

yml_get ( ' foobar.foo ' , $ yml );

// bar
  • Этот метод является статическим . Параметры:
Параметр Тип Описание
$key нить Ключ для поиска с использованием точечной записи (например, «foo.bar.baz»).
$yml нить Строка yml для поиска.

Возвращаемое значение:

Найденное значение, в противном случае — ноль.

получить файл

Получает значение в файле yaml, используя точечную нотацию. 

Yml:: getFile ( string $ key , string $ ymlfile ): mixed

yml_get_file

Соответствующая глобальная функция (описание см. выше).

(прыгнуть назад) 

 yml_get_file ( string $ key , string $ ymlfile ): mixed

Пример 

 $ ymlfile = ' /path/to/file.yml ' ;

yml_get_file ( ' foobar.foo ' , $ ymlfile );

// bar
  • Этот метод является статическим . Параметры:
Параметр Тип Описание
$key нить Ключ для поиска с использованием точечной записи (например, «foo.bar.baz»).
$ymlfile нить Yml-файл для поиска.

Возвращаемое значение:

Найденное значение, в противном случае — ноль.

РазобратьФайл

Загружает содержимое yaml-файла в массив. 

Yml:: parseFile ( string $ ymlfile ): array

yml_parse_file

Соответствующая глобальная функция (описание см. выше).

(прыгнуть назад) 

 yml_parse_file ( string $ ymlfile ): array| null

Пример 

 $ ymlfile = ' /path/to/file.yml ' ;

yml_parse_file ( $ ymlfile );

// (
//       [foo] => bar
//       [baz] => qux
//       [foobar] => (
//           [foo] => bar
//       )
// )
  • Этот метод является статическим . Параметры:
Параметр Тип Описание
$ymlfile нить Путь к файлу для чтения.

Возвращаемое значение:

Разобранный массив.

setFile

Устанавливает значение в файле yaml, используя точечную нотацию. Внимание: все комментарии в файле будут удалены! 

Yml:: setFile ( string $ key , mixed $ value , string $ ymlfile ): boolean

yml_set_file

Соответствующая глобальная функция (описание см. выше).

(прыгнуть назад) 

 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
  • Этот метод является статическим . Параметры:
Параметр Тип Описание
$key нить Строка для поиска с точечной записью
$value смешанный Значение, которое необходимо установить для указанного ключа.
$ymlfile нить Yml-файл, в котором нужно установить значение.

Возвращаемое значение:

True, если значение было успешно установлено в файле yaml, в противном случае — false.

файл дампа

Преобразует заданный массив в синтаксис yaml и помещает его содержимое в заданный файл. Примечание: если файл существует, он будет перезаписан! 

Yml:: dumpFile ( array|object $ var , string $ filename , integer $ indent = 2 , integer $ wordwrap , boolean $ openingDashes = false ): boolean

to_yml_file

Соответствующая глобальная функция (описание см. выше).

(прыгнуть назад) 

 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
  • Этот метод является статическим . Параметры:
Параметр Тип Описание
$var массив|объект Массив или объект для преобразования.
$filename нить Путь к файлу, в который нужно записать строку yaml. Внимание: если файл уже существует, он будет перезаписан!
$indent целое число Отступ преобразованного yaml. По умолчанию 2.
$wordwrap целое число После данного числа будет перенесена строка. По умолчанию 0 (без переноса слов).
$openingDashes логическое значение True, если строка yaml должна начинаться с открывающего тире. По умолчанию ложь.

Возвращаемое значение:

Истина в случае успеха, ложь в противном случае.

свалка

Преобразует заданный массив или объект в строку yaml. 

Yml:: dump ( array|object $ var , integer $ indent = 2 , integer $ wordwrap , boolean $ openingDashes = false ): string| null

to_yml

Соответствующая глобальная функция (описание см. выше).

(прыгнуть назад) 

 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
  • Этот метод является статическим . Параметры:
Параметр Тип Описание
$var массив|объект Массив или объект для преобразования.
$indent целое число Отступ преобразованного yaml. По умолчанию 2.
$wordwrap целое число После данного числа будет перенесена строка. По умолчанию 0 (без переноса слов).
$openingDashes логическое значение True, если строка yaml должна начинаться с открывающего тире. По умолчанию ложь.

Возвращаемое значение:

Преобразованная строка yaml. При ошибках возвращается ноль.

набор

Устанавливает значение в строке yaml, используя точечную запись. 

Yml:: set ( string $ key , mixed $ value , string & $ yml ): boolean

yml_set

Соответствующая глобальная функция (описание см. выше).

(прыгнуть назад) 

 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
  • Этот метод является статическим . Параметры:
Параметр Тип Описание
$key нить Строка для поиска с точечной записью
$value смешанный Значение, которое необходимо установить для указанного ключа.
$yml нить Строка yml для поиска. Примечание. Все комментарии в строке будут удалены!

Возвращаемое значение:

True, если значение было успешно установлено, в противном случае — false.

Этот документ был автоматически создан на основе комментариев к исходному коду 22 января 2018 г. с использованием phpDocumentor и cvuorinen/phpdoc-markdown-public.

Расширять
Дополнительная информация
Связанные приложения
Рекомендуем вам
Связанные новости Все