enum php

Tercerahkan

PERINGATAN Jika Anda menggunakan PHP 8.1 atau lebih tinggi, kami sarankan Anda menggunakan enum php asli sebagai pengganti paket ini.

Kami dapat melepaskan beberapa tambalan pemeliharaan tetapi dukungan untuk paket ini jika tidak dihentikan.

Jangan ragu untuk membayar kode kami dan menyesuaikannya dengan kebutuhan Anda.

ENUM PERPUSTAKAAN PHP

Ringkasan

Perpustakaan ini menyediakan implementasi enum / enumerasi untuk PHP.

Mengapa Menggunakan Perpustakaan Ini

• Sangat mudah diimplementasikan dan digunakan.
• Kompleks secara opsional dapat dipetakan dengan menyediakan metode map() .
• Mengizinkan tipe-hinting saat melewati nilai-nilai yang disebutkan antara metode dan kelas.

Penggunaan

Pertama -tama buat kelas baru yang meluas RexlabsEnumEnum dan lakukan hal berikut;

1. Menyatakan konstanta Anda
2. Opsional : Berikan metode map() :

Contoh

 <?php

namespace Rexlabs  Enum  Readme ;

use Rexlabs  Enum  Enum ;

/**
 * Class City
 *
 * @package RexlabsEnumReadme
 *
 * @method static static BRISBANE()
 * @method static static MELBOURNE()
 * @method static static SYDNEY()
 */
class City extends Enum
{
    const BRISBANE = ' Brisbane ' ;
    const MELBOURNE = ' Melbourne ' ;
    const SYDNEY = ' Sydney ' ;
    
    // OPTIONAL - Provide a map() method if you would like to
    // map additional data, which will be available from the ->value() method
    public static function map (): array 
    {
        return [
            self :: BRISBANE => [ " state " => " QLD " , " population " => "" ],
            self :: MELBOURNE => [ " state " => " VIC " , " population " => " 5m " ],
            self :: SYDNEY => [ " state " => " NSW " , " population " => " 5m " ],
        ];
    }
    
}

// Static access
echo City:: BRISBANE ;                 // "Brisbane"
echo City:: MELBOURNE ;                // "Melbourne"
City:: names ();                       // (array)["BRISBANE", "BRISBANE", "SYDNEY"]
City:: keys ();                        // (array)["Brisbane", "Melbourne", "Sydney"]
City:: keyForName ( ' BRISBANE ' );        // "Brisbane"
City:: nameForKey ( ' Melbourne ' );       // "MELBOURNE"
City:: isValidKey ( ' Sydney ' );          // (boolean)true
City:: isValidKey ( ' Paris ' );           // (boolean)false
               
// Getting an instance - all return a City instance.
$ city = City:: BRISBANE ();                   
$ city = City:: instanceFromName ( ' BRISBANE ' ); 
$ city = City:: instanceFromKey ( ' Brisbane ' );

// Working with an instance
$ city -> name ();                       // "BRISBANE"
$ city -> key ();                        // "Brisbane"
$ city -> value ()[ ' population ' ];        // null - no value mapped
$ city -> is (City:: BRISBANE );           // (boolean)true
$ city -> is (City:: BRISBANE ());         // (boolean)true
$ city -> is (City:: SYDNEY ());           // (boolean)false
$ city -> isNot (City:: SYDNEY ());        // (boolean)true
$ city -> isAnyOf ([City:: BRISBANE ()]);  // (boolean)true
$ city -> isNoneOf ([City:: BRISBANE ()]); // (boolean)false

// Or ...
City:: SYDNEY ()-> key ();               // "Sydney"
City:: SYDNEY ()-> value ();             // (array)["state"=>"NSW", "population"=>"5m"] 

Dependensi

• PHP 7.0 atau lebih.

Instalasi

Untuk menginstal di proyek Anda:

composer require rexlabs/enum

Tipe-menangani

Sekarang Anda dapat mengetikkan objek Enum Anda sebagai ketergantungan:

 <?php
function announceCity ( City $ city ) {
    echo "{ $ city -> key ()} is located in { $ city -> value ()[ " state " ]} , population: { $ city -> value ()[ " population " ]}n" ;
}

// Get a new instance
announceCity (City:: SYDNEY ());      // "Sydney is located in NSW, population: 5m" 

Metode instan

Setiap instance Enum memberikan metode berikut:

nama()

Mengembalikan nama konstan.

 $ enum -> name ();

kunci()

Mengembalikan nilai/kunci yang ditetapkan ke konstanta dalam deklarasi const MY_CONST = 'key' .

 $ enum -> key ();

nilai()

Mengembalikan nilai (if-any) yang dipetakan (dalam array dikembalikan oleh map() ). Jika tidak ada nilai yang dipetakan, maka metode ini mengembalikan null .

 $ enum -> value ();

IS (enum | string $ perbandingan)

Mengembalikan true jika contoh ini sama dengan instance kunci konstan atau enumerasi yang diberikan.

 $ enum -> is (City:: SYDNEY );       // Compare to constant key
$ enum -> is (City:: SYDNEY ());     // Compare to instance

__tostring ()

Metode __toString() didefinisikan untuk mengembalikan nama konstan.

( string )City:: SYDNEY ();      // "SYDNEY" 

Metode statis

peta()

Mengembalikan array yang memetakan kunci konstan ke nilai. Metode ini dapat diimplementasikan secara opsional di sub-kelas. Implementasi default mengembalikan array kunci yang dipetakan ke null .

instances ()

Mengembalikan serangkaian instance enum.

kunci ()

Mengembalikan serangkaian kunci konstan.

nilai ()

Mengembalikan serangkaian nilai yang ditentukan dalam map() . Jika map() tidak diimplementasikan maka array nilai nol akan dikembalikan.

names ()

Mengembalikan array dari semua nama konstan yang dinyatakan dengan kelas.

namesandkeys ()

Mengembalikan array asosiatif constant_name => key, untuk semua nama konstan yang dinyatakan dalam kelas.

keyforname (string $ name)

Mengembalikan kunci untuk nama konstan yang diberikan.

nameforkey (string $ key)

Mengembalikan nama konstan untuk kunci yang diberikan (kebalikan dari keyForName ).

valueforkey (string $ key)

Mengembalikan nilai (atau nol jika tidak dipetakan) untuk kunci yang diberikan (seperti yang dinyatakan dalam metode map() ).

KeyForValue (Nilai Mixed $)

Mengembalikan kunci untuk nilai yang diberikan (seperti yang dinyatakan dalam metode map() ).

Catatan: Jika nilai duplikat terkandung dalam metode map() maka hanya kunci pertama yang akan dikembalikan.

instanceFromName ($ name)

Buat contoh enum ini dari nama konstan yang diberikan.

instanceFromKey ($ key)

Buat contoh enum ini dari kunci yang diberikan.

isValidKey (string $ key)

Mengembalikan true jika ada kunci yang diberikan.

isValidName (string $ name)

Pengembalian true jika nama konstan yang diberikan (peka huruf besar-kecil) telah dinyatakan di kelas.

Persyaratan evalidkey (string $ key)

Melempar RexlabsEnumExceptionsInvalidKeyException Jika kunci yang diberikan tidak ada.

Tes

Untuk menjalankan tes:

composer tests

Untuk menjalankan laporan cakupan:

composer coverage

Laporan Cakupan adalah output ke ./tests/report/index.html

Berkontribusi

Kontribusi dipersilakan, silakan kirimkan permintaan tarik atau buat masalah. Kode yang Anda kirim harus diformat menggunakan standar PSR-1/PSR-2.

Tentang

• Penulis: Jodie Dunlop
• Lisensi: MIT
• Hak Cipta (C) 2018 Rex Software Pty Ltd