duplabe

PHP iterátorok

duplabe — Tue, 07 Feb 2012 00:00:00 +0100

PHP Iterátorok

Gondoltam készítek egy részletes, de korántsem teljes leírást a PHP iterátorairól.

SPL

Az iterátorokkal kapcsolatos interfészek és osztályok az SPL (Standard PHP Library) csomagban találhatóak.

Iterator

A PHP-s iterátorok az Iterator interfészen alapulnak, azt implementálják. Sok érdekesség nincs benne, a szokásos iterátorokkal kapcsolatos metódusokat szedi össze: current, key, next, rewind, valid.

EmptyIterator

Üres iterátor.

ArrayIterator

Tömbökön és objektumokon iterálhatunk végig.

Példa:

<?php
class Example
{
    public $a;
    protected $b;
    private $_c;

    public function __construct($a, $b, $c)
    {
        $this->a = $a;
        $this->b = $b;
        $this->_c = $c;
    }
}

echo 'Iterate over an object', PHP_EOL;

$iterator = new ArrayIterator(new Example(1, 2, 3));

foreach ($iterator as $item)
{
    echo $item, PHP_EOL;
}

echo 'Iterate over an array', PHP_EOL;

$iterator = new ArrayIterator(array(1,2,3));

foreach ($iterator as $item)
{
    echo $item, PHP_EOL;
}

Kimenet:

Iterate over an object
1
Iterate over an array
1
2
3

IteratorIterator

A Traversable interfészt implementáló objektumokból iterátort csinál.

NoRewindIterator

Iterator, amit nem lehet rewindolni, azaz, ha egyszer végigmentünk az összes elemen, nem lehet újra kezdeni az iterálást.

InfiniteIterator

Olyan iterátor, amellyel a végtelenségig iterálhatunk az elemeken, nem kell a rewindot meghívnunk.

LimitIterator

Egy iterátor elemeinek részhalmazán mehetünk végig. A konstruktorában egy iterátoron kivül megadhatunk egy offset és egy count paramétert is.

Példa:

<?php
$limitIterator = new LimitIterator(
    new ArrayIterator(range(0, 10)),
    5,
    3
);

foreach ($limitIterator as $item) {
    echo $item, PHP_EOL;
}

Kimenet:

5
6
7

FilterIterator

A FilterIterator egy belső iterátor elemiből tud szűrni. A FilterIterator egy abstract osztály, amelyben egy darab abstract metódus van, az accept(). Az accept() visszatérési értéke boolean:

true esetén az iterator elfogadja az elemet
false esetén eldobja

Példa:

<?php
class OddFilterIterator extends FilterIterator
{

    public function accept()
    {
        $current = $this->current();

        return is_integer($current) &amp;&amp; $current % 2;
    }

}

$iterator = new AppendIterator();
$iterator->append(new ArrayIterator(range(0, 10)));
$iterator->append(new ArrayIterator(array('a', 'b')));

$filterIterator = new OddFilterIterator($iterator);

foreach ($filterIterator as $item) {
    echo $item, PHP_EOL;
}

Kimenet:

AppendIterator

Több belső iteratort tárol, és azokon megy végig, egymás után.

A getArrayIterator() egy ArrayIterator-ban visszaadja az összes belső iteratort.

Példa:

<?php
$iterator1 = new ArrayIterator(range(0, 3));
$iterator2 = new ArrayIterator(range(4, 6));

$appendIterator = new AppendIterator();
$appendIterator->append($iterator1);
$appendIterator->append($iterator2);

foreach ($appendIterator as $key => $value) {
    echo $key, ' => ', print_r($value, true), PHP_EOL;
}

echo PHP_EOL, 'getArrayIterator()', PHP_EOL, PHP_EOL;

foreach ($appendIterator->getArrayIterator() as $key => $value) {
    echo $key, ' => ', print_r($value, true), PHP_EOL;
}

Kimenet:

0 => 0
1 => 1
2 => 2
3 => 3
0 => 4
1 => 5
2 => 6

getArrayIterator()

0 => ArrayIterator Object
(
    [storage:ArrayIterator:private] => Array
        (
            [0] => 0
            [1] => 1
            [2] => 2
            [3] => 3
        )

)

1 => ArrayIterator Object
(
    [storage:ArrayIterator:private] => Array
        (
            [0] => 4
            [1] => 5
            [2] => 6
        )

)

MultipleIterator

Az AppendIterator-hoz hasonlóan itt is több iterátoron mehetünk végig, de kicsit másképpen. Minden belső iterátorból kivesz egy elemet, majd egy tömbben összegyűjtve adja vissza iterációnként.

Flagek:

MultipleIterator::MIT_KEYS_NUMERIC: a tömb numerikusan indexelt
MultipleIterator::MIT_KEYS_ASSOC: a tömb asszociatív. A kulcsok az iterátorok hozzáadásánál adhatóak meg (attachIterator).

A belső iterátorok elemszáma különböző lehet, ezért két flaggel állíthatjuk be, hogy mi történjen akkor, ha valamelyikből elfogynak az elemek:

MultipleIterator::MIT_NEED_ANY: annyi elemet ad vissza, amennyit tud, a hiányzó elemeket null-okkal tölti fel.
MultipleIterator::MIT_NEED_ALL: ha valamelyik iterátorból elfogynak az elemek, a MultipleIterator leáll.

Példa:

<?php
$arrayIterator1 = new ArrayIterator(array('1','2','3','4',));
$arrayIterator2 = new ArrayIterator(array('5','6','7',));
$arrayIterator3 = new ArrayIterator(array('8','9','10','11',));

$miterator = new MultipleIterator(
    MultipleIterator::MIT_KEYS_ASSOC | MultipleIterator::MIT_NEED_ALL
);
$miterator->attachIterator($arrayIterator1, 'foo');
$miterator->attachIterator($arrayIterator2, 'bar');
$miterator->attachIterator($arrayIterator3, 'baz');

foreach ($miterator as $item) {
    echo var_export($item, true), PHP_EOL;
}

Kimenet:

Array
(
    [foo] => 1
    [bar] => 5
    [baz] => 8
)
Array
(
    [foo] => 2
    [bar] => 6
    [baz] => 9
)
Array
(
    [foo] => 3
    [bar] => 7
    [baz] => 10
)

Példa:

<?php
$arrayIterator1 = new ArrayIterator(array('1','2','3','4',));
$arrayIterator2 = new ArrayIterator(array('5','6','7',));
$arrayIterator3 = new ArrayIterator(array('8','9','10','11',));

$miterator = new MultipleIterator(
    MultipleIterator::MIT_KEYS_NUMERIC | MultipleIterator::MIT_NEED_ANY
);
$miterator->attachIterator($arrayIterator1, 'foo');
$miterator->attachIterator($arrayIterator2, 'bar');
$miterator->attachIterator($arrayIterator3, 'baz');

foreach ($miterator as $item) {
    echo var_export($item, true), PHP_EOL;
}

Kimenet:

Array
(
    [0] => 1
    [1] => 5
    [2] => 8
)
Array
(
    [0] => 2
    [1] => 6
    [2] => 9
)
Array
(
    [0] => 3
    [1] => 7
    [2] => 10
)
Array
(
    [0] => 4
    [1] =>
    [2] => 11
)

DirectoryIterator

Egy könyvtár elemein mehetünk végig vele. Az elemek SplFileInfo objektumok.

Könyvtár szerkezet az iterátorok bemutatására:

|-example/b
| \-example/b/b.txt
|-example/c
\-example/a
  |-example/a/e
  | \-example/a/e/e.txt
  |-example/a/a.txt
  \-example/a/d

Példa:

<?php
$iterator = new DirectoryIterator('example');

foreach ($iterator as $value) {
    echo $value->getFilename(), PHP_EOL;
}

Kimenet:

b
..
c
.
a

FilesystemIterator

Hasonló a DirectoryIterator-hoz, abból öröklődik. A konstructor alap esetben az alábbi flageket kapja:

KEY_AS_PATHNAME
CURRENT_AS_FILEINFO
SKIP_DOTS

További flagek:

CURRENT_AS_PATHNAME: a current() az aktuális file elérésével tér vissza
CURRENT_AS_FILEINFO: a current() egy SplFileInfo objektummal tér vissza
CURRENT_AS_SELF: a current() az iterator-ral ($this) tér vissza
KEY_AS_PATHNAME: a key() az aktuális file elérésével tér vissza
KEY_AS_FILENAME: a key() az aktuális file nevével tér vissza
FOLLOW_SYMLINKS: a hasChildren() követi a linkeket
NEW_CURRENT_AND_KEY: ugyanaz mint a FilesystemIterator::KEY_AS_FILENAME | FilesystemIterator::CURRENT_AS_FILEINFO
SKIP_DOTS: átugorja a .-ot és a ..-ot
UNIX_PATHS: az elérési utakban /-t használ, a PHP-t futtató OS-től függetlenül (pl Windows-on is)

GlobIterator

A glob() függvényhez hasonló funkcionalitással rendelkező iterátor.

RecursiveIteratorIterator

A rekurzív iterátorokat “linearizálja”, azaz nem kell a gyermekekkel foglalkozni (ellenőrizni, hogy van e, és ha igen, akkor azokon is végigmenni).

Három módon használható:

RecursiveIteratorIterator::LEAVES_ONLY: Csak a leveleken megy végig. Ez a default.
RecursiveIteratorIterator::SELF_FIRST - Minden elemen végig megy, a szülőkkel kezd.
RecursiveIteratorIterator::CHILD_FIRST: Minden elemen végig megy, a levelekkel kezd.

ParentIterator

Segítségével RecursiveIterator-okból lehet kiszűrni azon elemeket, amelyeknek nincs gyermekük. A RecursiveDirectoryIterator példához visszanyúlva, listázzuk ki csak a könyvtárakat:

<?php
$directoryIterator = new RecursiveDirectoryIterator(
    'example',
    RecursiveDirectoryIterator::SKIP_DOTS
);
$treeIterator = new RecursiveTreeIterator(
	new ParentIterator($directoryIterator)
);
foreach ($treeIterator as $node) {
    echo $node . PHP_EOL;
};

Kimenet:

Az üres könyvtárakat azért mutatja, mert ugye minden könyvtárban van egy hivatkozás önmagára (.) és a szülő könyvtárra (..), tehát van gyerekük.

|-example/b
|-example/c
\-example/a
  |-example/a/e
  \-example/a/d

RecursiveDirectoryIterator

A DirectoryIterator-hoz hasonlóan itt is egy könyvtár elemein mehetünk végig, de rekurzívan.

Péda:

<?php
$directoryIterator = new RecursiveDirectoryIterator(
    'example',
    RecursiveDirectoryIterator::SKIP_DOTS
);
$treeIterator = new RecursiveTreeIterator(
    $directoryIterator
);
foreach ($treeIterator as $key => $node) {
    echo $node, PHP_EOL;
}

Kimenet:

|-example/b
| \-example/b/b.txt
|-example/c
\-example/a
  |-example/a/e
  | \-example/a/e/e.txt
  |-example/a/a.txt
  \-example/a/d

Rekurzív iterátorok

Szinte az összes (itt nem is említett) iterátornak van rekurzív párja:

RecursiveArrayIterator
RecursiveCachingIterator
RecursiveCallbackFilterIterator
RecursiveFilterIterator
RecursiveRegexIterator
RecursiveTreeIterator

A cikknek példákkal együtt van saját repoja: php-iterators

Lehet jönni forkolni, javítani, bővíteni :)

Jekyll

duplabe — Sat, 14 Jan 2012 00:00:00 +0100

Jekyll

Ahogy ígértem írok pár szót arról, hogy mi is az a Jekyll és mire jó.

Röviden a Jekyll egy ruby gem amellyel statikus oldalakat generálhatunk. Egy oldal összeállításához a jekyll-len kívűl pár könyvtár és file kell csak, amelyekből legenerálja az egész oldalt. Akinek esetleg van GitHub oldala azok már találkozhattak vele, hiszen ott is lehetőség van a használatára.

A jekyll a Liquid nevű ruby template enginet használja. Nem kell túl bonyolult dologra gondolni, aki már látott template enginet, el fog vele boldogúlni.

Lehetőségünk van különböző leíró nyelvek haszálatára: HTML, markdown, textile. Én a makdownt választottam. A jekyll a fileok kiterjesztéséből tudja, hogy milyen feldolgozón kell átengednie.

Telepítés

apt-get install ruby1.8-dev rubygems1.8
gem install jekyll

Nincs sok függősége: directory_watcher, liquid, open4, maruku, classifier.

Könyvtárszerkezet

_includes
_layouts
    default.html
    post.html
_plugins
_posts
    2012-01-14-pelda-post.markdown
_site
_config.yml
index.html

a \_congig.yml tartalmazza a beállításokat.
az index.html lesz a főoldalunk.
az \_inludes olyan templateeket tartalmaz, amiket más templateekben használhatunk az {% include file.ext %} taggel.
a \_layouts mappa tartalmazza azokat a templateket, amelyeket az oldal összeállításához használhatunk.
a jekyll bővíthető pluginekkel, ezeket a \_plugin mappába kell tenni
a \_posts tartalmazza a bejegyzéseinket. Látható, hogy a file nevében van a publikálás dátuma, és a slug amelyen keresztűl majd elérhető a bejegyzés.
a \_site könyvtárban lesz a legenerált oldal. Konfigban megadható más cél is.

YAML Front Matter

Minden file, amely elején ott van egy YAML formátumú konfigurációs rész, átfut a jekyllen.

Ez például így nézhet ki:

---
layout: post
title: Példa post
---

Ez annyit tesz, hogy ez a bejegyzés a post layout-ot fogja használni és a title Példa post lesz.

A jekyll minden egyéb filet érintetlenül átmásol a célként megadott könyvtárba.

Elérhető változók

A templateekben az alábbi változók érhetőek el: Template data

A site változóban elérhetőek a _config.yml-ben beállított értékek is.

A post-ban pedig azok, amiket a postok elején lévő YAML-ban megadunk. Én például minden posthoz megadok egy excerpt változót, amely egy pár szavas rövid leírást ad az adott bejegyzésről és ezt az index.html-ben a post címe után kiírom.

Használat

A gyökérben egy egyszerű

jekyll

parancsal inditható is a generálás. Ez kiüríti a cél könyvtárat, majd a legenerált tartalommal feltölti.

A jekyll futtatható szerverként is:

jekyll --server --auto

Ilyen esetben a 4000-es porton elérhető a legenerált oldal. Az auto flaggel a jekyll figyeli a filokon történt változásokat, és ilyen esetben újra generálja az oldalt. A dokumentációban konrétan nem láttam - legalábbis nem rémlik -, de nem hiszem, hogy ez a beépített server éles környezetben való használatra lenne, inkább teszt célokat szolgál.

Nálam (Ubuntu 11.10, VBox-ban) egyébként az auto nem is működik, mert a directory_watcher gemmel valami nem ok és emiatt be se tudja tölteni. Van rá megoldás (a gemmet localban újra kell fordítani) de annyira nem éreztem hiányát, hogy foglalkozzak vele.

Migrálás

Lehetőség van a már meglévő wp, drupal, de akár tumblr, vagy posterous oldalunkat is jekyllre migrálni.

Konklúzió

Amint látható nem egy bonyolult dologról van szó. Amikor kitaláltam, hogy újra élesztem kicsit az oldalam, pont ilyen megoldásra gondoltam. Nincs szükségem CMS-re, összetett admin felületekre. Az már csak hab a tortán, hogy az egész verziókezelhető is.

Forrás

Az egész oldal forrása megtalálható GitHubon.

Új oldal

duplabe — Wed, 11 Jan 2012 00:00:00 +0100

Új oldal

Jekyll alapokra helyezve újraírtam az oldalam. Amint látható nem variáltam túl a dolgot. Vannak elérhetőségek, pár velem kapcsolatos link, plusz a sidebar alján a delicious-ön megosztott linkjeim közül a legfrissebb 10.

Miket használtam:

Mindegyikről - és még sok egyébről is - tervezek bejegyzést írni, meglátjuk mi lesz belőle.