„Yii Helpers” változatai közötti eltérés

A lap 2021. augusztus 26., 09:49-kori változata

I. ArrayHelper osztály

getValue() metódus
Vizsgálja, hogy egy tömb vagy objektum bizonyos kulcsa létezik-e, ha igen akkor a meghatározott kulcs értékét adja vissza, ha nem létezik akkor pedig egy előre meghatározott értéket ad vissza.

setValue() metódus
Vizsgálja, hogy egy tömb, illetve a megadott kulcs létezik-e, ha létezik akkor annak az értékét felülírja, ha nem létezik akkor pedig létrehozza akár még a tömböt is és a megfelelő kulcsokat és az értéket.

remove() metódus
Eltávolítja a tömb megadott kulcsát és annak értékét. Visszatérési értékébe az eltávolított elem értéke kerül, ha nem létezik akkor pedig a harmadik paraméterben opcionálisan meghatározott érték fog visszatérni, alapértelmezetten ez a null.

index() metódus
Több dimenziós tömb elemeit képes kulcs alapján indexelni, és megadott attribútum szerint csoportba rendezni. Visszatérési értéke az indexelt tömb lesz.

map() metódus
A metódus segítségével $kulcs => $érték párokat hozhatunk létre. Lehetőség van továbbá a csoportosításra is. A visszatérési érték az említett párokat tartalmazó asszociatív tömb.

multisort() metódus
A többdimenziós tömbök sorba rendezésére szolgál. Történhet egy vagy több kulcs alapján is. A rendezés iránya (csökkenő / növekvő sorrend) is megadható. Void metódus nincs visszatérési értéke, a megadott tömbön végzi el a sorba rendezést.

merge() metódus
Két tömb összefésülését képes elvégezni. Az összefésülés logikája nyomán hatékonyan tudjuk alkalmazni különböző helyzetekben. A visszatérési érték az összefésült tömb lesz.

toArray() metódus
Az objektumok tömbbé való átalakítását valósítja meg. Így például az activerecord modellek az átalakítást követően, egyszerűen használhatóak REST API végpontok kiépítéséhez. A visszatérési érték a tömbbé alakított objektum lesz.

Boolean típusú ArrayHelper metódusok

keyExists() metódus
Vizsgálja, hogy a meghatározott kulcs létezik-e a megadott tömbben. Visszatérési értéke pedig egy boolean lesz (true – létezik, false – nem létezik).

isIndexed() metódus
Vizsgálja, hogy a megadott tömb számokkal van-e indexelve, azt is lehetőségünk van vizsgálni, hogy a számok egymást követőek-e, folytatólagosak. Boolean értéket ad vissza.

isAssociative() metódus
Vizsgálja, hogy a megadott tömb asszociatív-e. Azt is lehetőségünk van vizsgálni, hogy a megadott asszociációs kulcsok mind string formátumúak-e. Boolean értéket ad vissza.

isIn() metódus
Vizsgálja, hogy egy adott érték benne van-e a tömbben. Visszatérési értéke egy boolean.

isSubset() metódus
Vizsgálja, hogy a megadott elemek megtalálhatóak-e a vizsgálandó tömbben. Visszatérési értéke egy boolean.

@@ 1. sor: / 1. sor: @@
 == I. ArrayHelper osztály ==
-=== getValue() metódus ===
+'''getValue() metódus'''<br>
 Vizsgálja, hogy egy tömb vagy objektum bizonyos kulcsa létezik-e, ha igen akkor a meghatározott kulcs értékét adja vissza, ha nem létezik akkor pedig egy előre meghatározott értéket ad vissza.<br>
-<code> '''ArrayHelper::getValue($tomb, ’kulcs’, ’Nem található a kulcs’);''' </code><br>
+'''setValue() metódus'''<br>
-A első paraméter a tömb. A második paraméter a kulcs:<br>
-*  A tömb kulcsa vagy az objektum attribútuma<br>
-*  Ha több dimenziós a tömbünk akkor pontokkal szeparált kulcsok vagy attribútumok megadásával is megkaphatjuk a kívánt értéket pl., ha [’tömb1’][’tömb2’][’értékKulcsa’] akkor ’tömb1.tömb2.értékKulcsa’<br>
-*  Callback függvény visszatérése által tudjuk manipulálni a kívánt adatokat<br>
-A metódus harmadik paramétere opcionális, ha nem található meg a megadott kulcs a tömbben, akkor ez a harmadik paraméter lesz a metódus visszatérési értéke, alapértelmezetten ez null.<br>
-=== setValue() metódus ===
-[[Fájl:Kulcs elérés példa.png|bélyegkép]]
 Vizsgálja, hogy egy tömb, illetve a megadott kulcs létezik-e, ha létezik akkor annak az értékét felülírja, ha nem létezik akkor pedig létrehozza akár még a tömböt is és a megfelelő kulcsokat és az értéket.<br>
-<code> '''ArrayHelper::setValue($tomb, ’kulcs.ertek3’, ’Ertek’);''' </code> <br>
+'''remove() metódus'''<br>
-Az első paraméter a tömb, a második a kulcs, pontokkal szeparált kulcsok megadásával is megadhatjuk pl., ha [’tömb1’][’tömb2’][’értékKulcsa’] akkor ’tömb1.tömb2.értékKulcsa’. A harmadik paraméter lesz az értéke a megadott kulcsnak.<br>
-=== remove() metódus ===
 Eltávolítja a tömb megadott kulcsát és annak értékét. Visszatérési értékébe az eltávolított elem értéke kerül, ha nem létezik akkor pedig a harmadik paraméterben opcionálisan meghatározott érték fog visszatérni, alapértelmezetten ez a null.<br>
-<code>'''ArrayHelper::remove($tomb, ’kulcs’, ’Nem található a kulcs’);'''</code><br>
+'''index() metódus'''<br>
-Fontos megemlíteni, hogy itt nem használható a pont szeparátorral megadott kulcsok meghatározása. Csak az egyszerű string formátumú kulcs engedélyezett. Ez sajnos behatárolja a metódus hatékonyságát / felhasználhatóságát.<br>
-=== index() metódus ===
 Több dimenziós tömb elemeit képes kulcs alapján indexelni, és megadott attribútum szerint csoportba rendezni. Visszatérési értéke az indexelt tömb lesz. <br>
-<code>'''ArrayHelper::index($tomb, ’id’, ’name’);'''</code><br>
+'''map() metódus'''<br>
-Első paraméter a tömb, második az egyedi kulcs, mely alapján az egyedi indexelés fog megvalósulni, például id alapján. Harmadik paraméternek azt az attribútumot / attribútumokat várja mely alapján csoportokat fog tudni létrehozni (használhatunk callback függvényt is). Ha a fenti kód alapján id indexelés és name csoportosítás történik egy tömbön akkor:
-<pre>
-’Fred’ => [
-=> [’id’ => 1, ’name’ => ’Fred’, ’type’ => 220]
-],
-’Fredddy’ => [
-=> [’id’ => 3, ’name’ => ’Fredddy’ , ’type’ => 30],
-=> [’id’ => 4, ’name’ => ’Fredddy’ , ’type’ => 220],
-=> [’id’ => 5, ’name’ => ’Fredddy’ , ’type’ => 30]
-]
-</pre>
-Továbbá lehetőségünk van a harmadik paraméterben tömbként átadott értékkel többszörös csoportosításra is, a sorrend a tömbösítés sorrendjét is meghatározza. Ha a harmadik paraméter [’type’, ’name’] akkor:<br>
-<code>'''ArrayHelper::index($tomb, ’id’, [’type’, ’name’]);'''</code><br>
-<pre>
-=> [
-    ’Fred’ => [
-=> [’id’ => 1, ’name’ => ’Fred’, ’type’ => 220]
-    ],
-    ’Fredddy’ => [
-=> [’id’ => 4, ’name’ => ’Fredddy’ , ’type’ => 220]
-    ]
-],
-=> [
-    ’Fredddy’ => [
-=> [’id’ => 3, ’name’ => ’Fredddy’ , ’type’ => 30],
-=> [’id’ => 5, ’name’ => ’Fredddy’ , ’type’ => 30]
-    ],
-]
-</pre>
-A második paraméterben null-t átadva, csoportosításra van lehetőségünk, az indexelés ebben az esetben automatikus.<br>
-<code>'''ArrayHelper::index($tomb, null, ’name’);'''</code><br>
-<pre>
-’Fred’ => [
-=> [’id’ => 1, ’name’ => ’Fred’, ’type’ => 220]
-],
-’Fredddy’ => [
-=> [’id’ => 3, ’name’ => ’Fredddy’ , ’type’ => 30],
-=> [’id’ => 4, ’name’ => ’Fredddy’ , ’type’ => 220],
-=> [’id’ => 5, ’name’ => ’Fredddy’ , ’type’ => 30]
-]
-</pre>
-=== map() metódus ===
 A metódus segítségével $kulcs => $érték párokat hozhatunk létre. Lehetőség van továbbá a csoportosításra is. A visszatérési érték az említett párokat tartalmazó asszociatív tömb.<br>
-<code>'''ArrayHelper::map($tomb, ’id’, ’name’, ’type’);'''</code><br>
+'''multisort() metódus'''<br>
-Első paraméter a tömb, másodiknak megkell adnunk azt az attribútumot melyből szeretnénk, hogy a $kulcs legyen ($from), harmadiknak pedig azt az attribútumot melyből szeretnénk, hogy $érték legyen ($to). A negyedik paraméter opcionális, itt adhatjuk meg, hogy végezzen-e csoportosítást és ha igen akkor pedig melyik attribútum alapján. Callback függvények használhatóak. A fent leírt kód alapján a metódus visszatérési értéke így nézne ki:
-<pre>
-=> [
-=> ’Fred’,
-=> ’Fredddy’
-],
-=> [
-=> ’Fredddy’,
-=> ’Fredddy’
-]
-</pre>
-=== multisort() metódus ===
 A többdimenziós tömbök sorba rendezésére szolgál. Történhet egy vagy több kulcs alapján is. A rendezés iránya (csökkenő / növekvő sorrend) is megadható. Void metódus nincs visszatérési értéke, a megadott tömbön végzi el a sorba rendezést.<br>
-<code>'''ArrayHelper::multisort($tomb, [’type’, ’id’], [SORT_ASC, SORT_DESC]);'''</code><br>
+'''merge() metódus'''<br>
-Első paraméter a tömb, ha asszociatív akkor a sorrendezett tömb megtartja a kulcsokat. Második paraméterben kell megadnunk mely attribútumok alapján rendezzen sorba, callback függvény használata lehetséges. Több szempontot is megadhatunk tömb formájában, a sorrend meghatározó. Harmadik paraméterként opcionálisan megadhatjuk a sorba rendezés irányát, alapértelmezetten ez ’SORT_ASC’. Ha az attribútumokat különböző módon szeretnénk sorba rendezni akkor tömböt átadva tehetjük ezt meg. Tehát a fenti példa alapján a ’type’ növekvő sorrendben, az ’id’ csökkenő sorrendben kerül rendezésre. Lehetséges továbbá egy negyedik paraméter is, ez a ’sortFlag’, beállíthatjuk, hogyan kezelje a sorba rendezés értékeit, szövegként vagy számként stb. alapértelmezetten ’SORT_REGULAR’. A sorba rendezett tömb, ’type’ alapján növekvő, majd ’id’ alapján csökkenő sorrendben:
-<pre>
-=>
-	’id’ => 2,
-	’name’ => ’Fredddy’,
-	’type’ => 30
-]
-=> [
-	’id’ => 4,
-	’name’ => ’Fredddy’,
-	’type’ => 220
-]
-=> [
-	’id’ => 3,
-	’name’ => ’Fredddy’,
-	’type’ => 220
-]
-=> [
-	’id’ => 1,
-	’name’ => ’fred’,
-	’type’ => 220
-]
-</pre>
-=== merge() metódus ===
 Két tömb összefésülését képes elvégezni. Az összefésülés logikája nyomán hatékonyan tudjuk alkalmazni különböző helyzetekben. A visszatérési érték az összefésült tömb lesz.<br>
-<code>'''ArrayHelper::merge($tomb1, $tomb2);'''</code><br>
+'''toArray() metódus'''<br>
-A következő logika alapján épül fel az összefésülés:
-*  A paraméterben megadott tömbök sorrendje meghatározó, azonosság esetén a második paraméter értéke fog érvényesülni.
-Nem asszociációs tömb elemek esetén összefésülés történik (mind a 2 érték megmarad).
-*  A következőképpen ’kulcs’ => new \yii\helpers\ReplaceArrayValue([1, 2]) felülírhatjuk a másik tömb kulcsa által meghatározott tömb értékét (csak a második paraméter tömbjében megadva érvényesülhet)
-*  'dev' => new \yii\helpers\UnsetArrayValue() segítségével pedig megadhatjuk melyik kulcs értéke kerüljön felszámolásra (szintén csak a második paraméter tömbjében megadva érvényesülhet)
-[[Fájl:Merge példa.png|bélyegkép|középre]]
-=== toArray() metódus ===
 Az objektumok tömbbé való átalakítását valósítja meg. Így például az activerecord modellek az átalakítást követően, egyszerűen használhatóak REST API végpontok kiépítéséhez. A visszatérési érték a tömbbé alakított objektum lesz.<br>
-<pre>
-ArrayHelper::toArray($model, [
-            'app\modules\bufeShop\models\Product' => [
-                'name',
-                'price' => function($element){
-		return $element->price . ’ Ft’;
-            ]
-]);
-</pre>
-Első paraméterként az objektumot vagy az objektumokat tartalmazó tömböt várja. Második paraméterben opcionálisan megadhatjuk mit és milyen formában szeretnénk tömbként visszakapni. Mint ahogy azt a fentebbi példa is mutatja, megkell adnunk a modell osztályának az elérési útját, majd ezekután lehetőségünk lesz meghivatkozni a modell attribútumait (akár az általunk írt „get”-es attribútumokat is). Callback függvény használatára is van lehetőség.
-<hr>
+=== ''Boolean típusú ArrayHelper metódusok'' ===
-=== Boolean típusú metódusok ===
+'''keyExists() metódus'''<br>
-==== keyExists() metódus ====
 Vizsgálja, hogy a meghatározott kulcs létezik-e a megadott tömbben. Visszatérési értéke pedig egy boolean lesz (true – létezik, false – nem létezik).<br>
-<code>'''ArrayHelper::keyExists(’kulcs’, $tomb, false);'''</code><br>
+'''isIndexed() metódus'''<br>
-Első paraméter a kulcs, második a tömb. A harmadik paraméter opcionális és ezzel a caseSensitive vizsgálatot lehet felfüggeszteni, alapértelmezetten caseSensitive = true, tehát a kis és nagybetűknek is egyeznie kell.<br>
-==== isIndexed() metódus ====
 Vizsgálja, hogy a megadott tömb számokkal van-e indexelve, azt is lehetőségünk van vizsgálni, hogy a számok egymást követőek-e, folytatólagosak. Boolean értéket ad vissza.<br>
-<code>'''ArrayHelper::isIndexed($tomb, true);'''</code><br>
+'''isAssociative() metódus'''<br>
-Az első paraméter a tömb, a második pedig opcionális és itt megadható, hogy vizsgálja-e a folytatólagosságot, ha true akkor az indexelésnek 0-tól kell kezdődnie és nem lehet kimaradás a számok között. A második paraméter alapértelmezett értéke a false.<br>
-==== isAssociative() metódus ====
 Vizsgálja, hogy a megadott tömb asszociatív-e. Azt is lehetőségünk van vizsgálni, hogy a megadott asszociációs kulcsok mind string formátumúak-e. Boolean értéket ad vissza.<br>
-<code>'''ArrayHelper::isAssociative($tomb, true);'''</code><br>
+'''isIn() metódus'''<br>
-Az első paraméter a tömböt, a második pedig opcionális és itt megadható, hogy kell-e vizsgálni az asszociációs kulcs formátumát, ha true akkor csak szöveg formátumok esetén ad igaz értéket (a ’122’ nem számít szöveg formátumnak a ’12w2’ már igen). A második paraméter alapértelmezett értéke a true.<br>
-==== isIn() metódus ====
 Vizsgálja, hogy egy adott érték benne van-e a tömbben. Visszatérési értéke egy boolean.<br>
-<code>'''ArrayHelper::isIn(’3’, $tomb);'''</code><br>
+'''isSubset() metódus'''<br>
-Első paraméter a vizsgálni kívánt értéket várja, a második pedig a tömböt. Van egy harmadik paraméter mely opcionális, ha „true” értéket adunk neki akkor a típus szerinti egyenlőséget is vizsgálja, alapértelmezetten „false” az érték.<br>
-==== isSubset() metódus====
-[[Fájl:IsSubset példa.png|bélyegkép]]
 Vizsgálja, hogy a megadott elemek megtalálhatóak-e a vizsgálandó tömbben. Visszatérési értéke egy boolean.<br>
-<code>'''ArrayHelper::isSubset([a,c],[a,b,c]);'''</code><br>
-Az első paraméterben azokat az elemeket kell tömb formájában megadni melyeket szeretnénk, hogy a metódus megkeressen a vizsgálandó tömbben. Fontos, hogy minden elemnek benne kell lennie a vizsgálandó tömbben, csak így ad vissza „true” értéket. A második paraméterben a  vizsgálandó tömböt kell megadnunk. A harmadik paraméter opcionális és a típus szerinti összehasonlítást teszi lehetővé, ugyanúgy, mint az előbbi metódus esetében.<br>

„Yii Helpers” változatai közötti eltérés

A lap 2021. augusztus 26., 09:49-kori változata

I. ArrayHelper osztály

Boolean típusú ArrayHelper metódusok

Navigációs menü

Személyes eszközök

Névterek

Változatok

Nézetek

Több

Keresés

Navigáció

Eszközök