Blog Mintdesign » php

Wyrażenia regularne cz. 1

Virus — Thu, 11 Feb 2010 22:53:48 +0000

Wyrażenia regularne są łańcuchami znaków, które pomagają w odnajdywaniu w tekście różnych wzorców. Są nieocenioną pomocą w przypadku, gdy trzeba np. sprawdzić poprawność składniową adresu e-mail czy też wyodrębnić z tekstu ciąg wielkich liter o zadanej długości. Praktyczne zastosowania wyrażeń regularnych można mnożyć w nieskończoność – wszystko sprowadza się do porównania łańcucha znaków z zadanym wzorcem i ewentualnym zamienianiu niektórych fragmentów tego wzorca na inne znaki.

Ten tutorial podzielę na dwie części. W pierwszej omówię same wyrażenia regularne, zaś część drugą poświęcę na ich zastosowanie w php. Ograniczę się wyłącznie do PERL-owych wyrażeń, które są alternatywą dla mniej wydajnych i odchodzących z użycia wyrażeń POSIX-owych (część elementów jest wspólna dla jednych i drugich).

Aby jednak nie zaciemniać za bardzo przykładów w moim tutorialu, przedstawię w tym momencie najprostszą funkcję do obsługi wyrażeń regularnych w php – preg_match(). Jej najprostsza składnia przedstawia się następująco:

1	$czy_pasuje = preg_match($wyrazenie, $ciag);

Funkcja ta posiada dodatkowe parametry, o których wspomnę w dalszej części tutoriala. Należy również zaznaczyć, że wyrażenia używane w tej funkcji muszą zaczynać się i kończyć jednym dowolnym (oprócz backslasha) znakiem niealfanumerycznym, który musi być następnie unikany backslashem wewnątrz wyrażenia. Przyjęło się, że jest to slash, jednak w przypadku wyrażenia z dużą ilością slashów wewnątrz (np. adresy http) można zastosować inny, np. #.

Podstawy

Tak naprawdę każdy tekst nie zawierający znaków specjalnych jest wyrażeniem regularnym. Zwyczajne

1	Ala ma kota

jest wyrażeniem regularnym, do którego pasuje tekst Słyszałem, że Ala ma kota.. Warto zaznaczyć, że wyrażenia regularne są wrażliwe na wielkość liter. Oczywiście stosowanie samych takich ciągów jako wyrażeń mija się z celem. Skomplikujmy nieco nasze wyrażenie.

1	Ala ma (kota\|psa)

Tutaj nawias służy nam do zgrupowania wyrazów, które mogą pojawić się w tym miejscu. Wyrazy oddzielone są pionową kreską. W związku z tym powyższe wyrażenie pasuje zarówno do Ala ma kota jak i Ala ma psa. Gdybyśmy potrzebowali w którymś z wyrazów użyć nawiasu lub pionowej kreski, powinniśmy uniknąć ich przetworzenia za pomocą backslasha. Oto lista wszystkich znaków specjalnych, które muszą zostać poprzedzone backslashem, gdy mają być traktowane jako zwykły tekst.

1	^ $ < > ( ) [ { . * ? + \| \

Oczywiście nie byłoby potrzeby unikania powyższych znaków, gdyby każdy z nich nie służył specjalnemu celowi. I tak na przykład, znak ^ służy do dopasowania wyrażenia do początku łańcucha, natomiast $ do jego końca.

1
2
3
4

$str = 'moje ulubione danie to placki';
preg_match('/placki/', $str); // zwróci true;
preg_match('/placki$/', $str); // zwróci true;
preg_match('/^placki/' $str); // zwróci false;

Oczywiście gdy nasze wyrażenie będzie brzmiało “^placki$”, jedynym spełniającym go tekstem będzie słowo placki. Takie zastosowanie wyrażeń nie ma jednak sensu – dużo wydajniejsze jest użycie zwykłego porównania.

Jeśli chcemy sprawdzić, czy w danym miejscu w tekście występuje jeden z kilku możliwych znaków, używamy do tego nawiasów kwadratowych. W nawiasach tych możemy zastosować zakres – np. a-e, 0-9, A-Z. Nie ma potrzeby unikania znaku -, ponieważ zakres jest sprawdzany wyłącznie tam, gdzie to ma sens, np. między dwiema małymi, dwiema wielkimi literami lub między dwiema cyframi. Istnieje również możliwość zaprzeczenia podanemu zakresowi, stawiając znak ^ zaraz po lewym nawiasie kwadratowym. Przykłady:

1
2
3

preg_match('/[aeiou]/', 'fasola'); // zwróci true - w łańcuchu znajdują się te samogłoski;
preg_match('/[A-Z]/', 'fasola'); // zwróci false - w łańcuchu nie ma żadnych wielkich liter;
preg_match('/[^0-9.-]/', '100 zł'); // zwróci true - w łańcuchu znajdują się znaki spoza podanego zakresu

Czasem lepszym rozwiązaniem od użycia kilku zakresów naraz jest zastosowanie znaków specjalnych, reprezentujących szczególne grupy znaków. Oto najczęściej używane znaki specjalne:

Znak	Odpowiednik	Opis
.	(brak)	Dowolny znak
\s	[\t\r\n ]	Białe spacje
\S	[^\t\r\n ]	Wszystko oprócz białych spacji
\d	[0-9]	Cyfry
\D	[^0-9]	Wszystko oprócz cyfr
\w	[a-zA-Z0-9_]	Znaki stanowiące słowa
\W	[^a-zA-Z0-9_]	Domyśl się

Kwantyfikatory

Aby móc sprawdzić, czy litera B znajduje się w wyrażeniu pięć (lub pięćset pięć) razy, nie ma sensu jej tam aż tyle pisać. Wystarczy użyć odpowiedniego kwantyfikatora. Używa się ich również do sprawdzenia, czy dany znak występuje raz albo w ogóle, co najmniej zero razy, co najmniej raz czy też od tylu do tylu razy. A oto one:

Wyrażenie	Pasujące łańcuchy	Wyjaśnienie
^a?$	”, ‘a’	Zero lub jeden raz
^a*$	”, ‘a’, ‘aa’, ‘aaa’…	Co najmniej zero razy
^a+$	‘a’, ‘aa’, ‘aaa’…	Co najmniej raz
^a{7}$	‘aaaaaaa’	Dokładnie 7 razy
^a{4,7}$	‘aaaa’, ‘aaaaa’, ‘aaaaaa’, ‘aaaaaaa’	Od 4 do 7 razy
^a{4,}$	‘aaaa’, ‘aaaaa’, ‘aaaaaa’…	Co najmniej cztery razy
^a{,4}$	”, ‘a’, ‘aa’, ‘aaa’, ‘aaaa’	Co najwyżej cztery razy

Oczywiście kwantyfikatory działają również dla całych grup znaków, zarówno tych pogrupowanych za pomocą nawiasów kwadratowych jak i tych z oznaczeniami z poprzedniej tabeli. Przykładowo, \w+ oznacza co najmniej jeden znak będący częścią słowa, natomiast [0-5]{2} oznacza dwie sąsiadujące ze sobą cyfry z zakresu od 0 do 5.

Przykłady

Przebrnąłeś już przez trochę suchej teorii – czas na sensowniejsze przykłady. Pamiętasz Alę z początku tutoriala? Gdyby między słowami znajdowała się więcej niż jedna spacja, to mimo iż treść jest wciąż taka sama, dla skryptu jest diametralnie różna. Nauczmy więc parsera uznawać więcej niż jedną spację między słowami, tworząc takie wyrażenie:

1
2
3
4
5
6
7
8
9

$expr = '/Ala\s+ma\s+kota/';
preg_match($expr, 'Ala ma kota'); // zwróci true
preg_match($expr, ' Ala ma kota'); // też zwróci true
$str = 'Ala

ma
kota'; // puste linie są częścią łańcucha znaków!
preg_match($expr, $str); // też zwróci true
preg_match($expr, 'Ala nie ma kota'); // zwróci false

A co, gdybyśmy chcieli, by wyrażenie było prawdziwe zarówno gdy ma kota, jak i go nie ma? Zmodyfikujmy nasze wyrażenie następująco:

1
2
3
4

$expr = '/Ala\s+(nie\s+)?ma\s+kota/';
preg_match($expr, 'Ala ma kota'); // true
preg_match($expr, 'Ala nie ma kota'); // true
preg_match($expr, 'ala NIE ma kota!!!11'); // false - wielkość liter ma znaczenie

Zostawmy Alę już na dobre i zajmijmy się czymś, co prędzej zastosujemy na naszych stronach. Załóżmy, że chcemy, aby użytkownicy przysyłali nam obrazy – obrazy te mają jednak mieć nazwy w formacie obraz_xxx (gdzie xxx to jakaś liczba) i mogą mieć rozszerzenie jpg, gif lub png. Wyrażenie, które nam pomoże w sprawdzeniu nazwy, wyglądać będzie następująco:

1	/^obraz_\d+\.(jpg\|gif\|png)$/

Krótka analiza:
Przede wszystkim nazwa pliku musi zaczynać się od słowa obraz – umieszczamy więc znak ^ i piszemy po nim obraz. Następnie po znaku podkreślenia znajduje się dowolna ilość cyfr, o czym mówi nam znak \d z kwantyfikatorem + (co najmniej jedna). Następnie w nazwie pliku musi znajdować się kropka – w wyrażeniu musimy uniknąć ją backslashem, w przeciwnym wypadku kropka zastąpiłaby nam dowolny znak. Następnie stosujemy alternatywę trzech rozszerzeń, po których nasze wyrażenie musi się kończyć, o czym informuje znak dolara.

Inny przykład – mamy profil użytkownika, w którym może on wpisać adres swojej strony www. Stajemy przed dwoma problemami: czy użytkownik wpisał http:// na początku swojego adresu? (jeśli nie, należy to dokleić przy generowaniu linka do jego strony) czy użytkownik wpisał poprawny adres www? (zakładamy, że dopuszczamy jedynie “typowe adresy”, jak np. www.onet.pl, a nie www.strona.pl/cos.php?a=b%3B…itd.)
Pierwsze wyrażenie jest bardzo proste i nie robi nic więcej oprócz odpowiedzi na pierwsze pytanie:

1	preg_match('#^http://#', $adres_strony);

Drugie wyrażenie będzie bardziej skomplikowane. Uwzględnijmy w nim, że wewnątrz adresu nie mogą znajdować się inne znaki niż alfanumeryczne, kropka, myślnik czy znak podkreślenia oraz przypilnujmy, by domena najwyższego poziomu nie była zbyt długa. Adres może, ale nie musi zaczynać się od http://.

1	#^(http://)?([a-zA-Z0-9][a-zA-Z0-9_-]*[a-zA-Z0-9]\.)+[a-z]{2,4}/?$#

Straszne? Wiem. Przeanalizujmy to wyrażenie. Na początku sprawdzamy, czy http:// występuje najwyżej raz za pomocą kwantyfikatora ?. Słowo http:// musimy wziąć w nawias, w przeciwnym wypadku znak zapytania stosowałby się wyłącznie do pojedynczego slasha. Następnie mamy kolejny nawias – grupę kolejnych subdomen, z których każda kończy się kropką. Kropkę w nawiasie koniecznie unikamy, jeśli nie chcemy, aby została przetworzona jako dowolny znak. Na początku i na końcu subdomeny mogą znajdować się wyłącznie litery i cyfry, a w środku dowolna ilość znaków ze środkowego nawiasu kwadratowego. Uwaga: zakładamy, że kolejne subdomeny mają przynajmniej dwa znaki długości. Po ostatniej kropce mogą wystąpić od dwóch do czterech małych liter jako domena najwyższego poziomu. Opcjonalnie na końcu adresu może znajdować się slash.

W tej części to już tyle. Następna pojawi się za tydzień i omówię w niej najistotniejsze funkcje PHP obsługujące wyrażenia regularne, a także bardziej zaawansowane konstrukcje w samych wyrażeniach. Żeby wam się specjalnie nie nudziło, mam dla was cztery ćwiczenia. Odpowiedzi możecie zostawiać tutaj w komentarzach lub w odpowiednim dziale na forum.

A oto ćwiczenia:

Numer telefonu w postaci xxx-xxx-xxx, z opcjonalnym numerem kierunkowym kraju na początku (np. 123-456-789, +48 666 666 666)
Adres filmiku na youtube – zwrócić uwagę na składnię linku do filmiku, dopuszczalne znaki w jego identyfikatorze i ich ilość. Zakładamy, że chodzi o najprostszy link, bez dodatkowych parametrów typu feature=related w adresie.
Adres e-mail. Chyba każdemu się przyda. Nie googlać, będę umiał rozpoznać wygooglane
Zmodyfikować przykład z adresem www tak, aby dopuszczał również jednoliterowe (lub jednocyfrowe) subdomeny.

Dlaczego warto używać stałych?

Virus — Tue, 05 Jan 2010 21:20:39 +0000

W PHP (i w każdym chyba języku programowania) oprócz zmiennych istnieją również stałe. Jak łatwo się domyślić z nazwy, przyjmują one jedną wartość podczas definicji i nie można jej później zmienić operatorem przypisania. Zastosowanie stałych nie dla wszystkich jest oczywiste, początkujący programiści często nie doceniają wygody i przydatności ich stosowania. W tym artykule przedstawiam kilka z życia wziętych przykładów zastosowania stałych.

Na początek jednak trochę teorii. Oto sposoby definiowania stałych w PHP:

1 2	define('STALA', 10) // definicja stałej STALA o wartości 10 const INNA_STALA = 20; // od PHP 5.3.0: definicja stałej INNA_STALA o wartości 20

Osobiście preferuję pierwszy sposób z powodu jego wszechstronności: w funkcji define() za nazwę stałej możemy podać zmienną o danej wartości.
Pomimo iż w nazwach stałych dopuszczalne jest nazewnictwo takie same, jak u zmiennych (małe i wielkie litery, cyfry i znak podkreślenia), przyjęło się, iż stałe powinny mieć nazwy pisane wielkimi literami.
Do stałych w kodzie odwołujemy się w następujący sposób:

1
2
3

echo STALA;
echo constant('STALA');
echo constant($zmienna_z_nazwa_stalej);

W przypadku definiowania stałych funkcją define() i zmienną w pierwszym parametrze, zmienna ta może zawierać dowolnego stringa. Gdy string ten zawiera znaki niedozwolone w przypadku normalnego nazywania stałych, możemy do tej stałej odwołać się jedynie poprzez funkcję constant(). W pozostałych przypadkach najlepiej jest po prostu wstawić nazwę stałej w danym miejscu kodu. Przy definiowaniu stałych wielkość liter jest rozróżniana. W przypadku odwołania się do nieistniejącej stałej generowany jest również notice, a nazwa nieistniejącej stałej, którą podaliśmy, zostaje przyjęta za jej wartość. Przykład:

1
2
3
4

define('JAKAS_STALA', 123);
echo Jakas_stala; // generowany jest notice o treści
// "Use of undefined constant Jakas_stala - assumed 'Jakas_stala'"
// i wyświetlony zostanie napis "Jakas_stala"

Aby sprawdzić, czy stała o danej wartości istnieje, używamy funkcji defined(). Przykład użycia:

1
2
3

define('STALA', 10);
defined('STALA'); // zwraca true;
defined('NIE_STALA'); // zwraca false;

To na tyle teorii, przejdźmy do praktycznych zastosowań.

Często stosowane wartości

Weźmy za przykład skrypt, który dzieli dużą ilość newsów na strony. Musimy znać liczbę elementów, które mają się jednorazowo pojawiać na stronie, numer aktualnej strony oraz wyliczyć ilość wszystkich stron, aby móc znać odniesienie do ostatniej strony. Zakładając, że ilość elementów na stronę to 10, przykładowy fragment kodu wyglądałby tak:

1
2
3
4

$aktualna_strona = isset($_GET['strona']) ? $_GET['strona'] : 1;
$numer_ostatniej_strony = ceil($ilosc_danych / 10);
// pobranie danych z bazy
$query = 'SELECT cos FROM gdzies WHERE cos = 'jakos' LIMIT ' . ($aktualna_strona * 10) . ', 10';

Liczba 10 pojawia się w powyższym kodzie trzy razy. Co w wypadku, gdy okaże się, że nie chcemy by elementów było 10, tylko 5? Musimy trzy razy zastąpić ręcznie dziesiątkę piątką. Sytuacja dodatkowo komplikuje się, gdy taki skrypt używany jest kilka razy.
Dodatkowo, liczba 10 jest tutaj zwykłą liczbą, nieprzypisaną do żadnej zmiennej. Co to za liczba? Co oznacza i do czego służy? Patrząc na ten kod nie jest to takie oczywiste, a im później do niego wrócimy, tym mniejsza szansa, że będziemy wiedzieli o co w nim chodzi.
Rozwiązanie z użyciem stałych jest dużo wygodniejsze jeśli chodzi o użyteczność i przejrzystość kodu. Na początku pliku definiujemy stałą o nazwie ITEMS_PER_PAGE i wartości 10:

1	define('ITEMS_PER_PAGE', 10);

Później w poprzednim skrypcie zamieniamy każdą dziesiątkę na naszą stałą:

1
2
3
4

$aktualna_strona = isset($_GET['strona']) ? $_GET['strona'] : 1;
$numer_ostatniej_strony = ceil($ilosc_danych / ITEMS_PER_PAGE);
// pobranie danych z bazy
$query = 'SELECT cos FROM gdzies WHERE cos = 'jakos' LIMIT ' . ($aktualna_strona * ITEMS_PER_PAGE) . ', ' . ITEMS_PER_PAGE;

W tym wypadku, gdy chcemy zmienić liczbę elementów na stronie, wystarczy tylko zmienić wartość w funkcji define().

Parametry funkcji

W PHP istnieje wiele predefiniowanych stałych, które znajdują zastosowanie w wielu miejscach. I tak na przykład funkcja preg_match_all() za czwarty parametr może przyjąć trzy stałe: PREG_PATTERN_ORDER, PREG_SET_ORDER i PREG_OFFSET_CAPTURE. Ich wartości to odpowiednio 1, 2 i 256. Teoretycznie liczby są krótsze i szybciej się je zapisze, jednak o ile czytelniej i łatwiej w zapamiętaniu używać stałych? Jeszcze bardziej użyteczny przykład ma się z typami plików w GD. Co jest czytelniejsze i łatwiejsze do zapamiętania:

1 2	getimagesize($image, list($width, $height, $type)); if ($type == 2) { echo "to jest JPG"; }

czy

1 2	getimagesize($image, list($width, $height, $type)); if ($type == IMAGETYPE_JPEG) { echo "to jest JPG"; }

?
Definiowanie stałych ułatwia życie przy pisaniu funkcji, w których parametry mogą mieć jedną z kilku dopuszczalnych wartości. Warto zaznaczyć, że w takich przypadkach jak podano najlepiej sprawdzają się stałe będące liczbami naturalnymi – porównywanie ich jest dużo szybsze niż porównywanie łańcuchów znaków.
Co ciekawe, stałe jeszcze bardziej ułatwiają życie, gdy potrzebujemy funkcji, w których jeden parametr może przyjąć kilka niezależnych wartości. Tutaj pojawiają się flagi.

Flagi

Flagi są stałymi przyjmującymi za wartości kolejne potęgi dwójki (1, 2, 4, 8, 16…). Używając ich, bardzo łatwo można ustalić, czego akurat wymagamy od funkcji.
Napiszmy przykładową funkcję walidującą dane w formularzu. Załóżmy, że dopuszczamy podanie przez użytkownika danych składających się tylko z małych liter, tylko z wielkich liter, tylko z cyfr oraz dowolnych kombinacji wymienionych. Na początku definiujemy stałe, które będą używane jako flagi.

1
2
3

define('LOWERCASE', 1);
define('UPPERCASE', 2);
define('DIGITS', 4);

W jaki sposób możemy ustawić więcej niż jedną flagę? Służy do tego operator binarny OR: | (pojedyncza pionowa kreska – nie mylić z operatorem logicznym, podwójną pionową kreską). Sprawdzenie, czy dana flaga jest ustawiona odbywa się z użyciem operatora binarnego AND: & – pojedynczy ampersand. Zdefiniujmy naszą funkcję:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15

function waliduj($dane, $flagi = 0) {
if ($flagi == 0) return 1; // żadna flaga nie jest ustawiona - wszystkie dane są poprawne - zwracamy wynik
$wyrazenie = '/[^'; // łańcuch, który posłuży nam do budowy wyrażenia regularnego
// dokładamy znaki do zbioru, z którego znaki nie powinny wystąpić w sprawdzanym łańcuchu
if ($flagi & LOWERCASE) $wyrazenie .= 'a-z';
if ($flagi & UPPERCASE) $wyrazenie .= 'A-Z';
if ($flagi & DIGITS) $wyrazenie .= '0-9';
$wyrazenie .= ']/';
// jeśli w wyrażeniu znajdują się znaki spoza zbioru, zwracamy fałsz
if (preg_match($wyrazenie, $dane)) {
return 0;
} else {
return 1;
}
}

Dla tych pierwszy raz widzących wyrażenia regularne: zaczynać i kończyć się muszą one dowolnym niealfanumerycznym znakiem (najczęściej używa się slasha). Nawiasy kwadratowe służą do wyodrębnienia zbioru znaków, który ma się pojawić w łańcuchu. Jeśli zaraz po lewym nawiasie występuje znak ^, wówczas wyrażenie dotyczy wszystkich znaków spoza tego zbioru.
Przykładowe wywołania funkcji z ustawionymi flagami:

1
2
3
4

waliduj('Tekst', LOWERCASE); // zwróci 0
waliduj('Tekst', LOWERCASE | UPPERCASE); // zwróci 1
waliduj('T3kst', LOWERCASE | UPPERCASE); // zwróci 0
waliduj('T3kst', LOWERCASE | UPPERCASE | DIGITS); // zwróci 1

Notka: w pierwszym przypadku sprawdzane wyrażenie regularne to /[^a-z]/, w drugim i trzecim: /[^a-zA-Z]/, a w czwartym /[^a-zA-Z0-9]/. Więcej o wyrażeniach regularnych w kolejnym tutorialu.

To by było na tyle. Mam nadzieję, że art się przyda, itd, itp Jest to moje pierwsze dzieło tego typu, więc nie szczędzić krytyki ani pomysłów na kolejne tutoriale w komentarzach.

Jak wyświetlić info o autorze wpisu?

Mateusz Lomber — Sun, 01 Nov 2009 21:41:45 +0000

Prowadząc blog na którym umieszcza wpisy więcej niż jedna osoba bardzo przydatnym elementem w każdej notce byłoby jakieś bardziej szczegółowe info o autorze. (Gdy samo imię i nazwisko / nick już nie wystarczą)

WordPress posiada gotowe funkcje pozwalające nam wyświetlić takie informacje o autorze notki w szablonach jak:

Techniczne:

Id (numer identyfikacyjny autora)
Login (nazwa użytkownika jaką się logujemy do PA)

Informacyjne:

Imię
Nick
Nazwisko
E-mail
Opis (opis biograficzny autora)
Stronę www
YIM (Yahoo Instant Messenger)
AIM (AOL Instant Messenger)

Funkcjonalne:

Wyświetlanie liczby wpisów autora
Link do wszystkich postów autora

Funkcje te należy zamieszczać w pliku szablonu (/wp-content/themes/nazwa-szablonu/single.php)

Należy też pamiętać o tym, że funkcja ta powinna się znajdować w obrębie pętli – czyli za:

1	if (have_posts()) : while (have_posts()) : the_post(); ?>

a przed:

1
2
3

endwhile; else: ?>
...
endif; ?>

Wyświetlenie Id Autora

1	the_author_ID(); ?>

Wyświetlenie Loginu Autora

1	the_author_login(); ?>

Wyświetlenie Imienia Autora

1	the_author_firstname(); ?>

Wyświetlenie Nicku (Pseudonimu) Autora

1	the_author_nickname(); ?>

Wyświetlenie Nazwiska Autora

1	the_author_lastname(); ?>

Wyświetlenie E-maila Autora

1	the_author_email(); ?>

Wyświetlenie Opisu biograficznego Autora

1	the_author_description(); ?>

Wyświetlenie Strony www Autora

1	the_author_url(); ?>

Wyświetlenie YIM Autora

1	the_author_yim(); ?>

Wyświetlenie AIM Autora

1	the_author_aim(); ?>

Wyświetlenie Liczby wpisów Autora

1	the_author_posts(); ?>

Wyświetlenie Linka do wszystkich postów Autora

1	the_author_posts_link(); ?>