PHPDevs

Projekt obiektowy z Composerem i Twigiem? Czytaj!

Funkcje > Lekcja 6

Funkcje wbudowane, czyli korzystanie z dokumentacji

Jak już mówiłem na początku tego rozdziału, w PHP posiadamy wiele wbudowanych funkcji. Wiedzę z nich należy czerpać z dokumentacji. Chciałbym teraz pokrótce opowiedzieć co i jak można w niej odnaleźć, gdyż umiejętność pracy z dokumentacją jest bardzo ważna.

Weźmy na przykład funkcję is_string(), która służy do sprawdzania czy podana wartość... jest strigniem (cóż za zaskoczenie): http://php.net/manual/en/function.is-string.php

Zaraz pod nazwą funkcji wymienione są wersje języka, w których jest ona dostępna. Następnie widzimy krótki opis, mówiący jednym zdaniem co robi dana funkcja. W sekcji "Description" mamy pełny opis funkcji, wraz z pokazanym zapisem funkcji:

bool is_string ( mixed $var )

A co on oznacza? Typ podany przed nazwą funkcji (w tym przykładzie bool) to informacja o tym, jakiego typu dane zwraca funkcja. W nawiasach z kolei jest informacja o argumentach jakie należy przekazać do funkcji i ich typie - ten zapis powinien być już dla Ciebie znajomy z lekcji o argumentach. W niektórych funkcjach mamy również wartości domyślne. Wtedy podane są one standardowo, po nazwie argumentu i znaku =.

Ciekawostka

W miejscu argumentów możesz także spotkać się z sytuacją, gdy niektóre (a czasem nawet wszystkie) będą zapisane w nawiasach kwadratowych [ ] - oznacza to tyle, że dany argument jest opcjonalny.

Z kolei wielokropek (...) oznacza, że można przekazać dowolną ilość argumentów podanego typu.

Spójrz dla przykładu na var_dump():

void var_dump ( mixed $expression [, mixed $... ] )

Poniżej są sekcje "Parameters" oraz "Return Values". Jest to uszczegółowienie powyższego zapisu. Wypisane są argumenty i określone, który czym dokładnie jest. Podobnie z wartością domyślną, mamy dokładne informacje o tym co w zależności od czego zostanie zwrócone.

Jeszcze niżej, w sekcji "Examples" pokazane są różne przykłady obrazujące działanie i przykładowe wykorzystanie danej funkcji. Czasem zdarzy się też dział "Notes" zawierający różne uwagi na temat opisywanej rzeczy. Na koniec już mniej istotne: "See Also" czyli inne proponowane funkcje oraz "User Notes" - notatki o danej funkcji od użytkowników.

W zasadzie to na tyle. Czy to trudne i wymagało opisu? Myślę, że nie, więc jeśli było to dla Ciebie proste i oczywiste to wybacz. Wolę jednak mieć pewność, że będziesz wiedział gdzie szukać. Często widuję sytuacje, na przykład na forach, gdy ktoś informuje pytającego, aby użył danej funkcji, a ten odpowiada, że nie wie jak to zrobić. Teraz już więc wiesz, że wystarczy otworzyć dokumentację, trochę poczytać i wszystko staje się zrozumiałe. Dokumentacja Twoim przyjacielem! :)

Jako ćwiczenie po tej lekcji możesz odwiedzić dokumentację i przejrzeć jak wygląda zapis informacji o wybranych przez siebie funkcjach.

Poprzednia lekcja Dalej

Udostępnij

  • Facebook
  • Twitter
  • Google+

Komentarze