array query

Kueri array

Array Query memungkinkan Anda untuk melakukan kueri pada array multidimensi.

Menggunakan kasus

Perpustakaan ini cocok untuk Anda jika Anda perlu melakukan beberapa pertanyaan di:

• Array PHP statis
• Array yang disimpan dalam memori
• File JSON (atau YAML) parsed

Penggunaan dasar

Untuk instantiate querybuilder lakukan hal berikut:

 use ArrayQuery  QueryBuilder ;

$ array = [
    [
        ' id ' => 1 ,
        ' title ' => ' Leanne Graham ' ,
        ' email ' => ' [email protected] ' ,
        ' rate ' => 5 ,
        ' company ' => [
            ' name ' => ' Romaguera-Jacobson ' ,
            ' catchPhrase ' => ' Face to face bifurcated interface ' ,
            ' bs ' => ' e-enable strategic applications '
        ]
    ],
    [
        ' id ' => 2 ,
        ' title ' => ' Ervin Howell ' ,
        ' email ' => ' [email protected] ' ,
        ' rate ' => 3 ,
        ' company ' => [
            ' name ' => ' Robel-Corkery ' ,
            ' catchPhrase ' => ' Multi-tiered zero tolerance productivity ' ,
            ' bs ' => ' transition cutting-edge web services '
        ]
    ],
    [
        ' id ' => 3 ,
        ' title ' => ' Clementine Bauch ' ,
        ' email ' => ' [email protected] ' ,
        ' rate ' => 4 ,
        ' company ' => [
            ' name ' => ' Keebler LLC ' ,
            ' catchPhrase ' => ' User-centric fault-tolerant solution ' ,
            ' bs ' => ' revolutionize end-to-end systems '
        ]
    ],
    // ..
]

QueryBuilder:: create ( $ array );

// to add an element to your array. Do this BEFORE make a query on the array
$ element = [
   ' id ' => 4 ,
   ' title ' => ' Patricia Lebsack ' ,
   ' email ' => ' [email protected] ' ,
   ' rate ' => 2 ,
   ' company ' => [
       ' name ' => ' Robel-Corkery ' ,
       ' catchPhrase ' => ' Multi-tiered zero tolerance productivity ' ,
       ' bs ' => ' transition cutting-edge web services '
   ]
];
$ qb -> addElement ( $ element , 4 );

// to remove an element from array by his key. Do this BEFORE make a query on the array
$ qb -> removeElement ( 3 );

Konsistensi data

Periksa QueryBuilder untuk konsistensi data Anda. Jika ketidakkonsistenan terdeteksi, NotConsistentDataException akan dinaikkan:

 use ArrayQuery  QueryBuilder ;

$ array = [
    [
        ' id ' => 1 ,
        ' title ' => ' Leanne Graham ' ,
        ' email ' => ' [email protected] ' ,
        ' rate ' => 5 ,
        ' company ' => [
            ' name ' => ' Romaguera-Jacobson ' ,
            ' catchPhrase ' => ' Face to face bifurcated interface ' ,
            ' bs ' => ' e-enable strategic applications '
        ]
    ],
    [
        ' id ' => 2 ,
        ' title ' => ' Ervin Howell ' ,
        ' email ' => ' [email protected] ' ,
        ' rate ' => 3 ,
        ' company ' => [
            ' name ' => ' Robel-Corkery ' ,
            ' catchPhrase ' => ' Multi-tiered zero tolerance productivity ' ,
            ' bs ' => ' transition cutting-edge web services '
        ]
    ],
    [
        ' id ' => 3 ,
        ' title ' => ' Clementine Bauch ' ,
        ' email ' => ' [email protected] ' ,
        ' rate ' => 4 ,
        ' company ' => [
            ' name ' => ' Keebler LLC ' ,
            ' catchPhrase ' => ' User-centric fault-tolerant solution ' ,
            ' bs ' => ' revolutionize end-to-end systems '
        ],
        ' extra-field ' => ' this is an extra field '
    ],
]

// NotConsistentDataException will be raised
QueryBuilder:: create ( $ array );

Quering, menyortir dan mendapatkan hasil

Anda dapat melakukan kueri pada array Anda. Anda dapat menggabungkan kriteria:

 use ArrayQuery  QueryBuilder ;

// ..

$ qb = QueryBuilder:: create ( $ array );
$ qb
    -> addCriterion ( ' title ' , ' Leanne ' , ' CONTAINS ' )
    -> addCriterion ( ' rate ' , ' 3 ' , ' > ' )
    -> sortedBy ( ' title ' , ' DESC ' );

// you can search by nested keys    
$ qb -> addCriterion ( ' company.name ' , ' Romaguera-Jacobson ' );

// get results    
foreach ( $ qb -> getResults () as $ element ){
    // ...
}

// get first result
$ first = $ qb -> getFirstResult ();

// get last result
$ last = $ qb -> getLastResult ();

// get a result by index
$ thirdResult = $ qb -> getResult ( 3 );

Operator kriteria yang tersedia

• = (operator default, dapat dihilangkan)
• >
• <
• <=
• >=
• !=
• ARRAY_MATCH
• CONTAINS (case tidak sensitif)
• ENDS_WITH
• EQUALS_DATE
• GT_DATE
• GTE_DATE
• IN_ARRAY
• IN_ARRAY_INVERSED
• LT_DATE
• LTE_DATE
• STARTS_WITH

Operator penyortiran yang tersedia

• ASC (operator default, dapat dihilangkan)
• DESC
• DATE_ASC
• DATE_DESC

Bergabung

Anda dapat bergabung dengan array. Harap pertimbangkan contoh lengkap ini:

 use ArrayQuery  QueryBuilder ;

$ users = [
    [
        ' id ' => 1 ,
        ' name ' => ' Mauro Cassani ' ,
        ' id_category ' => 3 ,
        ' email ' => ' [email protected] '
    ],[
        ' id ' => 2 ,
        ' name ' => ' Mario Rossi ' ,
        ' id_category ' => 3 ,
        ' email ' => ' [email protected] '
    ],[
        ' id ' => 3 ,
        ' name ' => ' Maria Bianchi ' ,
        ' id_category ' => 1 ,
        ' email ' => ' [email protected] '
    ]
];
$ category = [
    ' id ' => 3 ,
    ' name ' => ' Web Developer '
];

$ qb = QueryBuilder:: create ( $ users )
    -> join ( $ category , ' category ' , ' id_category ' , ' id ' )
    -> addCriterion ( ' category.id ' , 3 );

foreach ( $ qb -> getResults () as $ element ){
    // ...
}

Batas dan offset

Anda dapat menambahkan kriteria dan menentukan batas dan offset untuk hasil kueri Anda:

 use ArrayQuery  QueryBuilder ;

$ qb = QueryBuilder:: create ( $ array );
$ qb
    -> addCriterion ( ' title ' , [ ' Leanne ' ], ' IN_ARRAY ' )
    -> addCriterion ( ' rate ' , ' 3 ' , ' > ' )
    -> sortedBy ( ' title ' )
    -> limit ( 0 , 10 );

foreach ( $ qb -> getResults () as $ element ){
    // ...
}

Bekerja dengan Tanggal

Anda dapat melakukan kueri berdasarkan bidang datetime. Anda dapat menggunakan operator DATE_ASC atau DATE_DESC untuk mengurutkan hasil berdasarkan tanggal. Anda harus menentukan format tanggal jika format Anda bukan YYYY-mm-dd :

 use ArrayQuery  QueryBuilder ;

$ qb = QueryBuilder:: create ( $ array );
$ qb
    -> addCriterion ( ' registration_date ' , ' 01/05/2017 ' , ' GT_DATE ' , ' d/m/Y ' )
    -> addCriterion ( ' rate ' , ' 3 ' , ' > ' )
    -> sortedBy ( ' registration_date ' , ' DATE_DESC ' , ' d/m/Y ' )
    -> limit ( 0 , 10 );

foreach ( $ qb -> getResults () as $ element ){
    // ...
}

Alias

Anda dapat menggunakan alias dengan menggunakan kata kunci as sebagai pembatas. Lakukan hal berikut:

 use ArrayQuery  QueryBuilder ;

$ qb = QueryBuilder:: create ( $ array );
$ qb
    -> addCriterion ( ' name as n ' , ' Ervin Howell ' )
    -> addCriterion ( ' username as user ' , ' Antonette ' )
    -> addCriterion ( ' address.street as street ' , ' Victor Plains ' );

foreach ( $ qb -> getResults () as $ element ){
    // ...
    // now you have
    // $element['n']
    // $element['user']
    // $element['street']
}

Hasil yang dikocok

Anda dapat mengacak hasil kueri dengan menggunakan metode getShuffledResults :

 use ArrayQuery  QueryBuilder ;

$ qb = QueryBuilder:: create ( $ array );

foreach ( $ qb -> getShuffledResults () as $ element ){
    // ...
}

Lebih banyak contoh

Silakan merujuk ke QueryBuilderTest untuk contoh lebih lanjut.

Mendukung

Jika Anda menemukan masalah atau punya ide, silakan merujuk ke bagian ini.

Penulis

• Mauro Cassani - GitHub

Lisensi

Proyek ini dilisensikan di bawah lisensi MIT - lihat file lisensi.md untuk detailnya