Perpustakaan clausnz/php-helpers
adalah kumpulan 45 fungsi pembantu php yang berguna (PHP 5.6, 7.*)
.
Setelah instalasi dengan composer
, fungsi global dapat diakses dari mana saja di kode Anda:
composer require clausnz/php-helpers
<?php
dump ( ' any content ' );
Jika fungsi dengan nama yang sama sudah ada dalam daftar fungsi yang ditentukan proyek Anda ( bawaan dan ditentukan pengguna ), fungsi tersebut tidak akan terdaftar di lingkungan Anda. Oleh karena itu, tidak akan muncul konflik dengan fungsi yang ada.
Namun demikian, setiap fungsi masih dapat diakses secara statis dengan pernyataan penggunaan yang tepat:
<?php
use CNZ Helpers Util as util ;
util:: dump ( ' any content ' );
Perpustakaan ini memanfaatkan perpustakaan brilian dan terkenal berikut ini:
Semua fungsi diuji terhadap sejumlah pengujian unit dan Versi PHP.
Instal perpustakaan clausnz/php-helper
terbaru dengan komposer:
composer require clausnz/php-helpers
Pastikan juga untuk meminta file autoload komposer Anda:
require __DIR__ . ' /vendor/autoload.php ' ;
Setelah instalasi, fungsi PHP global baru tersedia di mana saja dalam kode Anda. Untuk mengakses fungsi statis (hampir identik) di kelas pembantu, tambahkan pernyataan use yang tepat ke file Anda:
<?php
use CNZ Helpers Dev as dev ;
if ( dev:: isIphone () ) {
// Do something here
}
Kelas pembantu yang menyediakan akses mudah ke fungsi array php yang berguna.
Arr Kelas
Mendeteksi apakah nilai yang diberikan adalah array asosiatif.
Arr:: isAssoc ( array $ array ): boolean
Fungsi global terkait (deskripsi lihat di atas).
(melompat mundur)
is_assoc ( array $ array ): boolean
$ array = [
' foo ' => ' bar '
];
is_assoc ( $ array );
// bool(true)
Parameter | Jenis | Keterangan |
---|---|---|
$array | susunan | Semua jenis array. |
Nilai Pengembalian:
Benar jika array bersifat asosiatif, salah jika sebaliknya.
Mengonversi array menjadi objek.
Arr:: toObject ( array $ array ): object| null
Fungsi global terkait (deskripsi lihat di atas).
(melompat mundur)
to_object ( array $ array ): object| null
$ array = [
' foo ' => [
' bar ' => ' baz '
]
];
$ obj = to_object ( $ array );
echo $ obj -> foo -> bar ;
// baz
Parameter | Jenis | Keterangan |
---|---|---|
$array | susunan | Array yang akan dikonversi. |
Nilai Pengembalian:
Representasi objek std dari array yang dikonversi.
Mengonversi string atau objek menjadi array.
Arr:: dump ( string|object $ var ): array| null
Fungsi global terkait (deskripsi lihat di atas).
(melompat mundur)
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
// )
Parameter | Jenis | Keterangan |
---|---|---|
$var | string|objek | String atau objek. |
Nilai Pengembalian:
Representasi array dari string atau objek yang dikonversi. Mengembalikan nol jika terjadi kesalahan.
Mengembalikan elemen pertama array.
Arr:: first ( array $ array ): mixed
Fungsi global terkait (deskripsi lihat di atas).
(melompat mundur)
array_first ( array $ array ): mixed
$ array = [
' foo ' => ' bar ' ,
' baz ' => ' qux '
];
array_first ( $ array )
// bar
Parameter | Jenis | Keterangan |
---|---|---|
$array | susunan | Array yang bersangkutan. |
Nilai Pengembalian:
Nilai elemen pertama, tanpa kunci. Tipe campuran.
Mengembalikan elemen terakhir dari array.
Arr:: last ( array $ array ): mixed
Fungsi global terkait (deskripsi lihat di atas).
(melompat mundur)
array_last ( array $ array ): mixed
$ array = [
' foo ' => ' bar ' ,
' baz ' => ' qux '
];
array_last ( $ array )
// qux
Parameter | Jenis | Keterangan |
---|---|---|
$array | susunan | Array yang bersangkutan. |
Nilai Pengembalian:
Nilai elemen terakhir, tanpa kunci. Tipe campuran.
Mendapat nilai dalam array dengan notasi titik untuk kuncinya.
Arr:: get ( string $ key , array $ array ): mixed
Fungsi global terkait (deskripsi lihat di atas).
(melompat mundur)
array_get ( string key, array $ array ): mixed
$ array = [
' foo ' => ' bar ' ,
' baz ' => [
' qux => ' foobar'
]
];
array_get ( ' baz.qux ' , $ array );
// foobar
Parameter | Jenis | Keterangan |
---|---|---|
$key | rangkaian | Kuncinya dengan notasi titik. |
$array | susunan | Array yang akan dicari. |
Nilai Pengembalian:
Nilai yang dicari, sebaliknya null.
Menetapkan nilai dalam array menggunakan notasi titik.
Arr:: set ( string $ key , mixed $ value , array & $ array ): boolean
Fungsi global terkait (deskripsi lihat di atas).
(melompat mundur)
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
// ]
// )
Parameter | Jenis | Keterangan |
---|---|---|
$key | rangkaian | Kunci untuk mengatur menggunakan notasi titik. |
$value | campur aduk | Nilai yang akan ditetapkan pada kunci yang ditentukan. |
$array | susunan | Array yang bersangkutan. |
Nilai Pengembalian:
Benar jika nilai baru berhasil ditetapkan, salah jika sebaliknya.
Kelas pembantu yang menyediakan akses mudah ke fungsi-fungsi php yang berguna bersama dengan agen pengguna.
Pengembang Kelas
Menentukan apakah perangkat saat ini adalah ponsel cerdas.
Dev:: isSmartphone ( ): boolean
Fungsi global terkait (deskripsi lihat di atas).
(melompat mundur)
is_smartphone ( ): boolean
if ( is_smartphone () ) {
// I am a smartphone
}
Nilai Pengembalian:
Benar jika pengunjung saat ini menggunakan ponsel cerdas, salah jika sebaliknya.
Mendeteksi jika pengunjung saat ini menggunakan perangkat seluler (Smartphone/Tablet/Handheld).
Dev:: isMobile ( ): boolean
Fungsi global terkait (deskripsi lihat di atas).
(melompat mundur)
is_mobile ( ): boolean
if ( is_mobile () ) {
// I am a mobile device (smartphone/tablet or handheld)
}
Nilai Pengembalian:
Benar jika pengunjung saat ini menggunakan perangkat seluler, salah jika sebaliknya.
Dapatkan objek MobileDetect tunggal untuk memanggil setiap metode yang disediakannya.
Dev::mobileDetect( ): Detection MobileDetect
Akses publik untuk penggunaan di luar kelas ini. Dokumen Mobile_Detect: https://github.com/serbanghita/Mobile-Detect
Metode ini tidak memiliki fungsi global terkait!
(melompat mundur)
Dev:: mobileDetect ()-> version ( ' Android ' );
// 8.1
Nilai Pengembalian:
Objek MobileDetect tunggal untuk memanggil setiap metode yang disediakannya.
Menentukan apakah pengunjung saat ini menggunakan perangkat tablet.
Dev:: isTablet ( ): boolean
Fungsi global terkait (deskripsi lihat di atas).
(melompat mundur)
is_tablet ( ): boolean
if ( is_tablet () ) {
// I am a tablet
}
Nilai Pengembalian:
Benar jika pengunjung saat ini menggunakan perangkat tablet, salah jika sebaliknya.
Menentukan apakah pengunjung saat ini menggunakan komputer desktop.
Dev:: isDesktop ( ): boolean
Fungsi global terkait (deskripsi lihat di atas).
(melompat mundur)
is_desktop ( ): boolean
if ( is_desktop () ) {
// I am a desktop computer (Mac, Linux, Windows)
}
Nilai Pengembalian:
Benar jika pengunjung saat ini menggunakan komputer desktop, salah jika sebaliknya.
Menentukan apakah pengunjung saat ini adalah mesin pencari/bot/crawler/spider.
Dev:: isRobot ( ): boolean
Fungsi global terkait (deskripsi lihat di atas).
(melompat mundur)
is_robot ( ): boolean
if ( is_robot () ) {
// I am a robot (search engine, bot, crawler, spider)
}
Nilai Pengembalian:
Benar jika pengunjung saat ini adalah mesin pencari/bot/crawler/spider, salah jika sebaliknya.
Dapatkan objek CrawlerDetect tunggal untuk memanggil setiap metode yang disediakannya.
Dev::crawlerDetect( ): Jaybizzle CrawlerDetect CrawlerDetect
Akses publik untuk penggunaan di luar kelas ini. Doku Deteksi Perayap: https://github.com/JayBizzle/Crawler-Detect
Metode ini tidak memiliki fungsi global terkait!
(melompat mundur)
Dev:: crawlerDetect ()-> getMatches ();
// Output the name of the bot that matched (if any)
Menentukan apakah perangkat saat ini menjalankan sistem operasi Android.
Dev:: isAndroid ( ): boolean
Fungsi global terkait (deskripsi lihat di atas).
(melompat mundur)
is_android ( ): boolean
if ( is_android () ) {
// I am an Android based device
}
Nilai Pengembalian:
Benar jika pengunjung saat ini menggunakan perangkat berbasis Android, salah jika sebaliknya.
Menentukan apakah perangkat saat ini adalah iPhone.
Dev:: isIphone ( ): boolean
Fungsi global terkait (deskripsi lihat di atas).
(melompat mundur)
is_iphone ( ): boolean
if ( is_iphone () ) {
// I am an iPhone
}
Nilai Pengembalian:
Benar jika pengunjung saat ini menggunakan iPhone, salah jika sebaliknya.
Menentukan apakah perangkat saat ini berasal dari Samsung.
Dev:: isSamsung ( ): boolean
Fungsi global terkait (deskripsi lihat di atas).
(melompat mundur)
is_samsung ( ): boolean
if ( is_samsung () ) {
// I am a device from Samsung
}
Nilai Pengembalian:
Benar jika pengunjung saat ini menggunakan perangkat Samsung, salah jika sebaliknya.
Menentukan apakah perangkat saat ini menjalankan sistem operasi iOS.
Dev:: isIOS ( ): boolean
Fungsi global terkait (deskripsi lihat di atas).
(melompat mundur)
is_ios ( ): boolean
if ( is_ios () ) {
// I am an iOS based device
}
Nilai Pengembalian:
Benar jika pengunjung saat ini menggunakan perangkat iOS, salah jika sebaliknya.
Kelas pembantu yang menyediakan akses mudah ke fungsi string php yang berguna.
Kelas Str
Menyisipkan satu atau lebih string ke dalam string lain pada posisi yang ditentukan.
Str:: insert ( array $ keyValue , string $ string ): string
Fungsi global terkait (deskripsi lihat di atas).
(melompat mundur)
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.
Parameter | Jenis | Keterangan |
---|---|---|
$keyValue | susunan | Array asosiatif dengan pasangan kunci => nilai. |
$string | rangkaian | Teks dengan string yang akan diganti. |
Nilai Pengembalian:
String yang diganti.
Mengembalikan konten dalam string antara elemen kiri dan kanan.
Str:: between ( string $ left , string $ right , string $ string ): array
Fungsi global terkait (deskripsi lihat di atas).
(melompat mundur)
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
// )
Parameter | Jenis | Keterangan |
---|---|---|
$left | rangkaian | Elemen kiri string yang akan dicari. |
$right | rangkaian | Elemen string yang tepat untuk dicari. |
$string | rangkaian | String yang akan dicari. |
Nilai Pengembalian:
Array hasil dengan semua kecocokan pencarian.
Mengembalikan bagian string setelah nilai tertentu.
Str:: after ( string $ search , string $ string ): string
Fungsi global terkait (deskripsi lihat di atas).
(melompat mundur)
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
Parameter | Jenis | Keterangan |
---|---|---|
$search | rangkaian | String yang akan dicari. |
$string | rangkaian | String yang akan dicari. |
Nilai Pengembalian:
String yang ditemukan setelah string pencarian. Spasi di awal akan dihapus.
Dapatkan bagian string sebelum nilai tertentu.
Str:: before ( string $ search , string $ string ): string
Fungsi global terkait (deskripsi lihat di atas).
(melompat mundur)
str_before ( string $ search , string $ string ): string
$ string = ' The quick brown fox jumps over the lazy dog ' ;
str_before ( ' fox ' $ string );
// The quick brown
Parameter | Jenis | Keterangan |
---|---|---|
$search | rangkaian | String yang akan dicari. |
$string | rangkaian | String yang akan dicari. |
Nilai Pengembalian:
String yang ditemukan sebelum string pencarian. Spasi putih di akhir akan dihapus.
Batasi jumlah kata dalam sebuah string. Masukkan nilai $end ke akhir string.
Str:: limitWords ( string $ string , integer $ limit = 10 , string $ end = ' ... ' ): string
Fungsi global terkait (deskripsi lihat di atas).
(melompat mundur)
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...
Parameter | Jenis | Keterangan |
---|---|---|
$string | rangkaian | String untuk membatasi kata-kata. |
$limit | bilangan bulat | Jumlah kata yang dibatasi. Defaultnya adalah 10. |
$end | rangkaian | Tali untuk mengakhiri tali yang dipotong. Defaultnya adalah '...' |
Nilai Pengembalian:
String terbatas dengan $end di akhir.
Batasi jumlah karakter dalam sebuah string. Masukkan nilai $end ke akhir string.
Str:: limit ( string $ string , integer $ limit = 100 , string $ end = ' ... ' ): string
Fungsi global terkait (deskripsi lihat di atas).
(melompat mundur)
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...
Parameter | Jenis | Keterangan |
---|---|---|
$string | rangkaian | String untuk membatasi karakter. |
$limit | bilangan bulat | Jumlah karakter yang dibatasi. Defaultnya adalah 100. |
$end | rangkaian | Tali untuk mengakhiri tali yang dipotong. Defaultnya adalah '...' |
Nilai Pengembalian:
String terbatas dengan $end di akhir.
Menguji apakah string berisi elemen tertentu
Str:: contains ( string|array $ needle , string $ haystack ): boolean
Fungsi global terkait (deskripsi lihat di atas).
(melompat mundur)
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)
Parameter | Jenis | Keterangan |
---|---|---|
$needle | string|array | Sebuah string atau array string. |
$haystack | rangkaian | String yang akan dicari. |
Nilai Pengembalian:
Benar jika $needle ditemukan, salah jika sebaliknya.
Menguji apakah string berisi elemen tertentu. Abaikan sensitivitas huruf besar-kecil.
Str:: containsIgnoreCase ( string|array $ needle , string $ haystack ): boolean
Fungsi global terkait (deskripsi lihat di atas).
(melompat mundur)
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)
Parameter | Jenis | Keterangan |
---|---|---|
$needle | string|array | Sebuah string atau array string. |
$haystack | rangkaian | String yang akan dicari. |
Nilai Pengembalian:
Benar jika $needle ditemukan, salah jika sebaliknya.
Tentukan apakah string tertentu dimulai dengan substring tertentu.
Str:: startsWith ( string|array $ needle , string $ haystack ): boolean
Fungsi global terkait (deskripsi lihat di atas).
(melompat mundur)
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)
Parameter | Jenis | Keterangan |
---|---|---|
$needle | string|array | String atau larik string yang akan dicari. |
$haystack | rangkaian | String yang akan dicari. |
Nilai Pengembalian:
Benar jika $needle ditemukan, salah jika sebaliknya.
Tentukan apakah string tertentu dimulai dengan substring tertentu. Abaikan sensitivitas huruf besar-kecil.
Str:: startsWithIgnoreCase ( string|array $ needle , string $ haystack ): boolean
Fungsi global terkait (deskripsi lihat di atas).
(melompat mundur)
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)
Parameter | Jenis | Keterangan |
---|---|---|
$needle | string|array | String atau larik string yang akan dicari. |
$haystack | rangkaian | String yang akan dicari. |
Nilai Pengembalian:
Benar jika $needle ditemukan, salah jika sebaliknya.
Tentukan apakah string tertentu diakhiri dengan substring tertentu.
Str:: endsWith ( string|array $ needle , string $ haystack ): boolean
Fungsi global terkait (deskripsi lihat di atas).
(melompat mundur)
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)
Parameter | Jenis | Keterangan |
---|---|---|
$needle | string|array | String atau larik string yang akan dicari. |
$haystack | rangkaian | String yang akan dicari. |
Nilai Pengembalian:
Benar jika $needle ditemukan, salah jika sebaliknya.
Tentukan apakah string tertentu diakhiri dengan substring tertentu.
Str:: endsWithIgnoreCase ( string|array $ needle , string $ haystack ): boolean
Fungsi global terkait (deskripsi lihat di atas).
(melompat mundur)
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)
Parameter | Jenis | Keterangan |
---|---|---|
$needle | string|array | String atau larik string yang akan dicari. |
$haystack | rangkaian | String yang akan dicari. |
Nilai Pengembalian:
Benar jika $needle ditemukan, salah jika sebaliknya.
Mengembalikan bagian string setelah kemunculan terakhir dari nilai pencarian tertentu.
Str:: afterLast ( string $ search , string $ string ): string
Fungsi global terkait (deskripsi lihat di atas).
(melompat mundur)
str_after_last ( string $ search , string $ string ): string
$ path = " /var/www/html/public/img/image.jpg " ;
str_after_last ( ' / ' $ path );
// image.jpg
Parameter | Jenis | Keterangan |
---|---|---|
$search | rangkaian | String yang akan dicari. |
$string | rangkaian | String yang akan dicari. |
Nilai Pengembalian:
String yang ditemukan setelah kemunculan terakhir dari string pencarian. Spasi di awal akan dihapus.
Kelas pembantu yang menyediakan akses mudah ke fungsi-fungsi umum php yang berguna.
Utilitas Kelas
Validasi alamat email yang diberikan.
Util:: isEmail ( string $ email ): boolean
Fungsi global terkait (deskripsi lihat di atas).
(melompat mundur)
is_email ( string $ email ): boolean
$ email = ' [email protected] ' ;
is_email ( $ email );
// bool(true)
Parameter | Jenis | Keterangan |
---|---|---|
$email | rangkaian | Alamat email yang akan diuji. |
Nilai Pengembalian:
Benar jika string yang diberikan adalah alamat email yang valid, salah jika sebaliknya.
Dapatkan alamat ip pengguna saat ini.
Util:: ip ( ): string| null
Fungsi global terkait (deskripsi lihat di atas).
(melompat mundur)
ip ( ): null|string
echo ip ();
// 127.0.0.1
Nilai Pengembalian:
Alamat ip yang terdeteksi, null jika ip tidak terdeteksi.
Membuat hash aman dari kata sandi yang diberikan. Menggunakan algoritma CRYPT_BLOWFISH.
Util:: cryptPassword ( string $ password ): string
Catatan: direkomendasikan 255 karakter untuk kolom database!
Fungsi global terkait (deskripsi lihat di atas).
(melompat mundur)
crypt_password ( string $ password ): string
$ password = ' foobar ' ;
crypt_password ( $ password );
// $2y$10$6qKwbwTgwQNcmcaw04eSf.QpP3.4T0..bEnY62dd1ozM8L61nb8AC
Parameter | Jenis | Keterangan |
---|---|---|
$password | rangkaian | Kata sandi untuk crypt. |
Nilai Pengembalian:
Kata sandi yang dienkripsi.
Memverifikasi bahwa kata sandi cocok dengan kata sandi terenkripsi (algoritma CRYPT_BLOWFISH).
Util:: isPassword ( string $ password , string $ cryptedPassword ): boolean
Fungsi global terkait (deskripsi lihat di atas).
(melompat mundur)
is_password ( string $ password , string $ cryptedPassword ): boolean
$ password = ' foobar ' ;
$ cryptedPassword = ' $2y$10$6qKwbwTgwQNcmcaw04eSf.QpP3.4T0..bEnY62dd1ozM8L61nb8AC ' ;
is_password ( $ password , $ cryptedPassword );
// bool(true)
Parameter | Jenis | Keterangan |
---|---|---|
$password | rangkaian | Kata sandi untuk diuji. |
$cryptedPassword | rangkaian | Kata sandi yang dienkripsi (misalnya disimpan dalam database). |
Membuang konten variabel tertentu dan keluar dari skrip.
Util:: dd ( mixed $ var )
Fungsi global terkait (deskripsi lihat di atas).
(melompat mundur)
dd ( mixed $ var )
$ array = [
' foo ' => ' bar ' ,
' baz ' => ' qux '
];
dd ( $ array );
// (
// [foo] => bar
// [baz] => qux
// )
Parameter | Jenis | Keterangan |
---|---|---|
$var | campur aduk | Var yang akan dibuang. |
Membuang konten variabel tertentu. Script TIDAK berhenti setelah panggilan.
Util:: dump ( mixed $ var )
Fungsi global terkait (deskripsi lihat di atas).
(melompat mundur)
dump ( mixed $ var )
$ array = [
' foo ' => ' bar ' ,
' baz ' => ' qux '
];
dump ( $ array );
// (
// [foo] => bar
// [baz] => qux
// )
Parameter | Jenis | Keterangan |
---|---|---|
$var | campur aduk | Var yang akan dibuang. |
Kelas pembantu yang menyediakan akses mudah ke fungsi php yml yang berguna.
Kelas Yml
Memvalidasi jika file tertentu berisi sintaks yaml.
Yml:: isValidFile ( string $ file ): boolean
Fungsi global terkait (deskripsi lihat di atas).
(melompat mundur)
is_yml_file ( string $ file ): boolean
$ file = /path/to/file.yml
is_yml_file ( $ file );
// bool(true)
Parameter | Jenis | Keterangan |
---|---|---|
$file | rangkaian | File yang akan diuji sintaksis yaml. |
Nilai Pengembalian:
Benar jika file berisi sintaks yaml, salah jika sebaliknya.
Menguji apakah sintaks string tertentu adalah yaml.
Yml:: isValid ( string $ string ): boolean
Fungsi global terkait (deskripsi lihat di atas).
(melompat mundur)
is_yml ( string $ string ): boolean
$ string = "
foo: bar
baz: qux
foobar:
foo: bar
" ;
is_yml ( $ string );
// bool(true)
Parameter | Jenis | Keterangan |
---|---|---|
$string | rangkaian | String yang akan diuji sintaksis yaml. |
Nilai Pengembalian:
Benar jika stringnya yaml, salah jika sebaliknya.
Mengubah string yaml tertentu menjadi array.
Yml:: parse ( string $ yml ): array| null
Fungsi global terkait (deskripsi lihat di atas).
(melompat mundur)
yml_parse ( string $ yml ): array| null
$ yml = "
foo: bar
baz: qux
foobar:
foo: bar
" ;
yml_parse ( $ yml );
// (
// [foo] => bar
// [baz] => qux
// [foobar] => (
// [foo] => bar
// )
// )
Parameter | Jenis | Keterangan |
---|---|---|
$yml | rangkaian | String yaml yang akan diurai. |
Nilai Pengembalian:
Array yang diubah, nol jika ada kesalahan.
Mendapatkan nilai dalam string yaml menggunakan notasi titik.
Yml:: get ( string $ key , string $ yml ): mixed
Fungsi global terkait (deskripsi lihat di atas).
(melompat mundur)
yml_get ( string $ key , string $ yml ): mixed
$ yml = "
foo: bar
baz: qux
foobar:
foo: bar
" ;
yml_get ( ' foobar.foo ' , $ yml );
// bar
Parameter | Jenis | Keterangan |
---|---|---|
$key | rangkaian | Kunci untuk mencari menggunakan notasi titik (misalnya 'foo.bar.baz'). |
$yml | rangkaian | String yml yang akan dicari. |
Nilai Pengembalian:
Nilai yang ditemukan, sebaliknya null.
Mendapat nilai dalam file yaml menggunakan notasi titik.
Yml:: getFile ( string $ key , string $ ymlfile ): mixed
Fungsi global terkait (deskripsi lihat di atas).
(melompat mundur)
yml_get_file ( string $ key , string $ ymlfile ): mixed
$ ymlfile = ' /path/to/file.yml ' ;
yml_get_file ( ' foobar.foo ' , $ ymlfile );
// bar
Parameter | Jenis | Keterangan |
---|---|---|
$key | rangkaian | Kunci untuk mencari menggunakan notasi titik (misalnya 'foo.bar.baz'). |
$ymlfile | rangkaian | File yml untuk mencari. |
Nilai Pengembalian:
Nilai yang ditemukan, sebaliknya null.
Memuat konten file yaml ke dalam array.
Yml:: parseFile ( string $ ymlfile ): array
Fungsi global terkait (deskripsi lihat di atas).
(melompat mundur)
yml_parse_file ( string $ ymlfile ): array| null
$ ymlfile = ' /path/to/file.yml ' ;
yml_parse_file ( $ ymlfile );
// (
// [foo] => bar
// [baz] => qux
// [foobar] => (
// [foo] => bar
// )
// )
Parameter | Jenis | Keterangan |
---|---|---|
$ymlfile | rangkaian | Jalur file yang akan dibaca. |
Nilai Pengembalian:
Array yang diurai.
Menetapkan nilai dalam file yaml menggunakan notasi titik. Catatan: semua komentar di file akan dihapus!
Yml:: setFile ( string $ key , mixed $ value , string $ ymlfile ): boolean
Fungsi global terkait (deskripsi lihat di atas).
(melompat mundur)
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
Parameter | Jenis | Keterangan |
---|---|---|
$key | rangkaian | String yang akan dicari dengan notasi titik |
$value | campur aduk | Nilai yang akan ditetapkan pada kunci yang ditentukan. |
$ymlfile | rangkaian | File yml untuk mengatur nilainya. |
Nilai Pengembalian:
Benar jika nilai berhasil ditetapkan di yamlfile, salah jika sebaliknya.
Mengubah array tertentu menjadi sintaks yaml dan memasukkan kontennya ke dalam file tertentu. Catatan: jika file tersebut ada, maka akan ditimpa!
Yml:: dumpFile ( array|object $ var , string $ filename , integer $ indent = 2 , integer $ wordwrap , boolean $ openingDashes = false ): boolean
Fungsi global terkait (deskripsi lihat di atas).
(melompat mundur)
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
Parameter | Jenis | Keterangan |
---|---|---|
$var | susunan|objek | Array atau objek yang akan diubah. |
$filename | rangkaian | Jalur ke file untuk menulis string yaml. Catatan: jika file sudah ada, maka akan ditimpa! |
$indent | bilangan bulat | Indentasi yaml yang dikonversi. Defaultnya adalah 2. |
$wordwrap | bilangan bulat | Setelah nomor yang diberikan, sebuah string akan dibungkus. Defaultnya adalah 0 (tidak ada bungkus kata). |
$openingDashes | boolean | Benar jika string yaml harus dimulai dengan tanda hubung pembuka. Defaultnya salah. |
Nilai Pengembalian:
Benar jika berhasil, salah jika sebaliknya.
Mengubah array atau objek tertentu menjadi string yaml.
Yml:: dump ( array|object $ var , integer $ indent = 2 , integer $ wordwrap , boolean $ openingDashes = false ): string| null
Fungsi global terkait (deskripsi lihat di atas).
(melompat mundur)
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
Parameter | Jenis | Keterangan |
---|---|---|
$var | susunan|objek | Array atau objek yang akan diubah. |
$indent | bilangan bulat | Indentasi yaml yang dikonversi. Defaultnya adalah 2. |
$wordwrap | bilangan bulat | Setelah nomor yang diberikan, sebuah string akan dibungkus. Defaultnya adalah 0 (tidak ada bungkus kata). |
$openingDashes | boolean | Benar jika string yaml harus dimulai dengan tanda hubung pembuka. Defaultnya salah. |
Nilai Pengembalian:
String yaml yang dikonversi. Jika terjadi kesalahan, null dikembalikan.
Menetapkan nilai dalam string yaml menggunakan notasi titik.
Yml:: set ( string $ key , mixed $ value , string & $ yml ): boolean
Fungsi global terkait (deskripsi lihat di atas).
(melompat mundur)
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
Parameter | Jenis | Keterangan |
---|---|---|
$key | rangkaian | String yang akan dicari dengan notasi titik |
$value | campur aduk | Nilai yang akan ditetapkan pada kunci yang ditentukan. |
$yml | rangkaian | String yml yang akan dicari. Catatan: semua komentar dalam string akan dihapus! |
Nilai Pengembalian:
Benar jika nilai berhasil ditetapkan, salah jika sebaliknya.
Dokumen ini dibuat secara otomatis dari komentar kode sumber pada 22-01-2018 menggunakan phpDocumentor dan cvuorinen/phpdoc-markdown-public