Congratulations! You have successfully created your symfony project.

Project setup successful

This project uses the symfony libraries. If you see no image in this page, you may need to configure your web server so that it gains access to the symfony_data/web/sf/ directory.

Prawidłowa konfiguracja serwera www wydaje się najbardziej problematyczną częścią instalacji tego frameworka. Całe szczęście nie jest ona tak trudna jak może się wydawać. Ten krótki przewodnik opisuje dwie metody pozwalające szybko i sprawnie ustawić Apacha tak by polubił Symfony .

Zakładam że posiadacie poprawnie zainstalowaną Symfony (jeśli nie opis instalacji znajduje się tu). Ja osobiście pracuje na serwerze www zainstalowanego z paczki WAMP (Apache+MySQL+PHP) i taką instalację odzwierciedlają ścieżki, którymi posługuję się w przykładach.

Sposób 1 – ustawianie virtual hosta

Stworzenie dla każdego swojego projektu w Symfony wirtualnego hosta wydaje się najlepszym sposobem ich zarządzania w fazie tworzenia.

Zatem do dzieła – najpierw potrzebujemy znaleźć katalog zawierający pliki konfiguracyjne Apacha (u mnie będzie to C:\wamp\bin\apache\apache2.2.6\conf) i otworzyć httpd-vhosts.conf (który jest w podkatalogu extra – C:\wamp\bin\apache\apache2.2.6\conf\extra). W nim należy usunąć lub zakomentować (dodając ‘#’ na początku linijki) wszystkie linie co do których nie mamy pewności co robią – jeśli nie my je napisaliśmy to są to pewnie tylko przykłady konfiguracji vhostów).

W Symfony 1.2 (1.1 może też?) przykładowy plik z konfiguracją vhosta jest tworzony dla każdego projektu który wygenerujesz. Można go znaleźć pod config/vhost.sample – i oczywiście może być on wykorzystany zamiast kodu który znajduje się w przykładzie poniżej.

Zatem na końcu naszego pliku dodajemy następujące linijki (oczywiście to tylko jeden z wielu sposobów konfiguracji – można znaleźć masę innych przykładów ustawień vhostów – wszystke są dobre, jeśli tylko działają, prawda? ):

NameVirtualHost *:80

Listen 127.0.0.2:80

<VirtualHost 127.0.0.2:80>

ServerName your_application_name
DocumentRoot “c:\wamp\www\your_project\web”
DirectoryIndex index.php

<Directory “c:\wamp\www\your_project\web”>

AllowOverride All
Allow from All

</Directory>

Alias /sf “c:\wamp\bin\php\php5.2.5\PEAR\data\symfony\web\sf”

<Directory “c:\wamp\bin\php\php5.2.5\PEAR\data\symfony\web\sf”>

AllowOverride All
Allow from All

</Directory>

</VirtualHost>

Oczywiście w linijkach ” Alias /sf “c:\wamp\bin\php\php5.2.5\PEAR\data\symfony\web\sf” ” i ” <Directory “c:\wamp\bin\php\php5.2.5\PEAR\data\symfony\web\sf”> ” należy zastąpić ścieżki poprawną ścieżką do katalogu symfony data. Analogicznie w linijkach ” DocumentRoot “c:\wamp\www\your_project\web” ” oraz ” <Directory “c:\wamp\www\your_project\web”> ” należy umieścić ścieżkę do katalogu web swojego projektu.

Powinniśmy też określić własną nazwę wirtualnego hosta umieszczając ją zamiast your_server_name w linijce ‘ServerName your_server_name’.

Teraz musimy upewnić się, że w pliku httpd.conf (główny plik konfiguracyjny Apacha, który u mnie znajduje się w katalogu   C:\wamp\bin\apache\apache2.2.6\conf) linijka ‘Include conf/extra/httpd-vhosts.conf‘ nie jest zakomentowana (nie ma ‘#’ przed nią).

Pozostaje nam już tylko zadeklarować własną domenę lokalnie przez dodanie linijki ‘127.0.0.2 your_server_name’ (oczywiście zamiast your_server_name wpisz wcześniej zdefiniowaną nazwę wirtualnego hosta) ma końcu pliku host (C:\WINDOWS\system32\drivers\etc) . Linijka ‘127.0.0.1 localhost‘ powinna być pierwszą linijką pliku host. A BTW – jego edycja może wymagać uprawnień administratora.

Teraz – po zresetowaniu Apacha – jeśli wpiszemy w przeglądarce http://your_server_name/ nasza strona powitalna Symfony powinna zawierać wszystkie obrazki.

Sposób 2 – zamrażanie projektu

Możemy otrzymać gotową do wdrożenia paczkę z naszym projektem przez użycie komendy ‘freeze‘ – kopiuje ona wszystkie pliki Symfony do naszego projektu, również te “brakujące” z katalogu web/sf. Wystarczy w katalogu projektu wykonać polecenie:

symfony freeze [c:/sciezka/do/katalogu/symfony/data]

Freeze zmienia także niektóre scieżki określone w konfiguracji, więc nasz projekt teraz będzie odwoływał się do bibliotek Symfony umieszczonych w naszym projekcie a nie tych globalnych. Oczywistym minusem tego rozwiązania jest konieczność zrobienia unfreeze (polecenie przeciwne do freeze) i ponownego freeze dla wszystkich swoich projektów po uaktualnieniu Symfony. Mogą się pojawić również problemy ze ścieżkami jeśli nasz projekt nie będzie znajdował się głównym katalogu naszego serwerwa WWW.

Sposób 3 – ten głupi

Jeśli żadna z powyższych metod nie działa dla Ciebie – zawsze można spróbować skopiować zawartość katalogu ścieżka_do_symfony_data/web/sf/ do  twój_projekt/web/ (zatem w moim wypadku byłoby to przeniesienie plików z katalogu C:\wamp\bin\php\php5.2.5\PEAR\data\symfony\web\sf do C:\wamp\www\twoj_projekt\web). Nie jest to oczywiście najczystsze rozwiązanie – jednym z miusów jest to, że po updacie Symfony może się okazać, że będziemy musieli przekopiować ten folder ręcznie do wszystkich swoich projektów i pojawią się zapewne problemy ze ścieżkami – przy korzystaniu z zasobów pluginów lub przy bezwględnym adresowaniu zasobów (choć jeśli zawsze będziemy korzystać z helperów symfony do generowania ścieżek nie powinno to być żadnym problemem).

Rozwiązanie 1 – Gdy mamy dostęp do plików konfiguracyjnych PHP.

Jeśli możemy wyedytować pliki konfiguracyjne PHP to problem sprowadza się jedynie do zmiany jednej linijki w PHP.ini. Plik ten zanjduje się zazwyczaj w głównym katalogu PHP (np. w moje instalacji PHP WAMP jest on w C:\wamp\bin\php\php5.2.5), wystarczy go otworzyć i odnaleźć linijkę:

max_execution_time = 30

Zmiana domyślnych 30 sekund na powiedzmy 120 powinna rozwiązać problem dla większości skryptów (normalnych skryptów ). Jedyne co nam pozostało to restart serwera www i jesteśmy w domku.

Rozwiązanie 2 – Na maszynie zdalnej.

Jest taka ładna funkcja PHP, która zwie się set_time_limit ( int $sec ), każde jej wywołanie ustawia licznik timeoutu na żądaną wartość (w sekundach) co oznacza że skrypt będzie mógł działać od teraz przez $sec sekund. Wywołanie set_time_limit(0) znosi ograniczenie czasu wykonania aplikacji.

Niestety funkcja ta nie będzie działać, jeśli PHP na serwerze działa w trybie bezpiecznym (safe mode). Więcej szczegółów można znaleźć w podręczniku PHP.

Timeout i serwery WWW

Warto wspomnieć iż serwery www również mają określony maksymalny dopuszczalny czas wykonania zapytania, np. dla Apacha domyślna wartość wynosi 300 sekund. 6 minut to więcej niż będzie nam potrzebne w 99,99% przypadków (czy w obecnych czasach wytrzymalibyście czekanie 5 minut aż się otworzy jakaś strona? ), ale istnieje oczywiście możliwość zmiany tych ustawień. Wystarczy odszukać linijkę zaczynającą sie od słowa Timeout w pliku httpd-default.conf który znajduje się razem z innym plikami konfiguracyjnymi Apacha (np. u mnie jest to C:\wamp\bin\apache\apache2.2.6\conf\extra).

Plug-in ten dodaje dodatkowy widok do Eclipsa (tzw. Symfony view), który rozszerza normalną perspektywę PHP w PDT (PHP Development Tools), umożliwia nam szybki dostęp do wszystkich frameworkowych akcji oraz jest wyposażony w edytor YAML przydatny w edycji plików konfiguracyjnych Symfony (no i dodaje super ikonkę ’s’ obok projektów Symfony ).

Czym jest Eclipse? To duży open-sourcowy projekt rozwijany przez prężną społeczność programistów z całego świata i zmierzający do utworzenia “platformy programistycznej składającej się z elastycznych frameworków i narzędzi do budowania, wdrażania i zarządzania oprogramowaniem na wszystkich etapach życia projektu” [tł. aut. z oficjalnej strony projektu]. Eclipse cieszy się duża popularnością szczególnie wśród osób piszących w Javie, ale dostępne są takaże rozbudowane IDE dla C/C++, PHP… i wielu innych.

Symfoclipse zdaje się działać poprawnie tylko z Symfony 1.0.X.
Nadal można go używać z 1.1 lub póżniejszymi ale skorzystamy właściwie tylko z edytora YML.

0. Zdecydowanie przyda się działające Symfony

( Przewodnik instalacyjny Symfony Framework. )

1a. Pakiet wszystko w jednym (All-In-One Pack = Eclipse + PDT) – dla tych którzy nie mają zainstalowanego Eclipsa.

Symfoclipse potrzebuje Eclipsa z zainstalowanym plug-inem PDT. Najłatwiejszym sposobem instalacji całości jest pobranie paczki All-In-One (polecam ściągnięcie Release Build z PDT download | Strona domowa PDT ). Proces instalacyjny jest bezproblemowy – wystarczy rozpakować zipa. Będzie nam również potrzebna Java SE 5.0+ (zapewne i tak ją macie – ale może warto pobrać nowszą wersję ?).

Przyzwyczajenie się do pracy w Eclipse może zająć trochę czasu, ale zdecydowanie warto. Nauke ułatwi fakt, iż zostało napisanych wiele przydatnych poradników i manuali dla tego środowiska.

1b. Instalacja PDT – dla osób z zainstalowanym Eclipsem.

Jeśli masz działającego Eclipsa możesz zainstalować PDT przy pomocy update manager. Należy przejść do Help Software Updates Find and Install. Wybrać opcję “Search For New Feature to Install“, dodać nową stronę (”New Remote Site…”) z linkiem “http://download.eclipse.org/tools/pdt/updates/” i kliknąć  Next aby rozpocząć ściąganie. W wypadku jakichkolwiek problemów warto zajrzeć do Eclipse Wiki.

2. Ściągnięcie i zainstalowanie Symfoclipse.

Proces instalacyjny jest taki sam jak dla większości pluginów Eclipse i wykorzystuje update managera. Należy przejść do Help Software Updates Find and Install. Wybrać “Search For New Feature to Install“, dodać nową stronę “http://noy.cc/symfoclipse/” i wybrać Next aby Eclipse zaczął pobierać Symfoclipsa. Po zakończeniu ściągania należy ponownie uruchomić program – i voila!

Funkcje Symfoclipsa

Symfony View

Jest to zmodyfikowany widok PHP Exlporer i może zostać uruchomiony przez wybranie Symfony View w Show View (Window Show View Other). Umożliwa on dostęp do poleceń CLI (wiersz poleceń – Command Line Interface) frameworka poprzez kliknięcie prawym przyciskiem myszki na katalogi Symfony w listingu projektu.

Zatem przyszedł czas by utworzyć przykładową aplikację. Po stworzeniu zwykłego projektu PHP (File New PHP Project) należy kliknąć jego ikonkę prawym przyciskiem myszki i wybrać “Init Project” z samego dołu menu kontekstowego. Rezultat jest dokładnie taki sam jak wpisanie w wierszu poleceń symfony init-project. I jak pewnie zauważyliście wszystkie komunikaty Symfony pojawiają się w konsoli Eclipse (domyślnie na dole obszaru roboczego).

Po inicjalizacji projektu można go kliknąć ponownie prawym przyciskiem myszki ( na ikonce pojawiła się już super literka ‘s‘ ) – powinniście teraz zobaczyć więcej funkcji Symfony Framework ładnie wylistowanych w menu.

Edytor YAML

Z Symfoclipse otrzymujemy także edytor YAML, który mimo swej prostoty ma jedną niezwykle ważną funkcję – wbudowany auto-walidator składni, który okazuje się niezwykle przydatny przy edycji plików konfiguracyjnych Symfony ( które są na ogól siedliskiem życia literówek i błędów wszelkiej maści ).

Edytor otwiera automatycznie pliki z rozszerzeniem .yml i .yaml z naszych projektów. Jeśli zainstniałaby potrzeba otworzenia pliku o innym rozszerzeniu wystarczy na nim kliknąć prawym klawiszem myszki i wybrać Open with Symfoclipse YAML Editor

Oczywiście poniższa tabela służy tylko znalezieniu przybliżonych wartości. Wszystko zależy od przeglądarki, jej ustawień oraz użytej czcionki, ale w większości przypadków powinno być to wystarczające. Na ogół dobrze sprawdzającym się przelicznikiem px do pt jest mnożnik 0,75 (oczywiście przy normalnym rozmiarze fontów w przeglądarce).

Punktem odniesienia dla wartości relatywnych w tabeli tj. procenty i emy jest standardowy font-size 16px (relacja 1em = 16px ustawiana jest przez większość przeglądarek gdy nie ma zadeklarowanego rozmiaru czcionki).

Zakładam, że naszym domyślnym środowiskiem jest Windows XP lub Windows Vista i zaczynamy od zera, tzn. nie mamy jeszcze postawionego i skonfigurowanego żadnego serwera WWW.

Co nam będzie potrzebne?

• WAMP (2.0 w chwili pisania)
• i… to wszystko

Z WAMPa już zainstalujemy PEARa a potem dzięki niemu Symfony, ale po kolei:

Część 1 – Instalacja WAMPa

WAMP to samoinstalująca się paczka zawierająca Apacha, MySQLa i PHP 5 (5.2.8+) – czyli dokładnie to co potrzebujemy (i dodatkowo miły dodatek w postaci PhpMyAdmina oraz SQLitemanagera). Oczywiście nie jest to jedyna taka dostępna dystrybucja, podobnie działa np. XAMPP – wybór należy do Ciebie. Można też instalować wszystkie komponenty ręcznie… tylko po co?

WAMP powinien automatycznie wypakować swoje pliki (załóżmy że np. pod C:\wamp) i uruchomić się bezproblemowo. Voila! – działający serwer z domyślną konfiguracją już jest . To nie zajęło za dużo czasu, prawda?

Większość elementów można skonfigurować przez menu skrótów dostępnego po kliknięciu na ikonkę WAMPA. WAMP “mówi” także po polsku – klikając na ikonę w trayu prawym przyciskiem myszy możemy wybrać rodzimy język z listy language.

Jeśli Twój WAMP nie chce poprawnie wystartować twierdząc, np. że port 80 jest już wykorzystywany (a nie masz uruchomionego innego serwera WWW) – przyczyną może być uruchomiony Skype. Domyślnie w opcjach Skype (Zaawansowane >> Połączenie) zaznaczone jest “Użyj portów 80 oraz 443 jako alternatywnych dla połączeń przychodzących” – wystarczy odznaczyć tą pozycję.

Aby Symfony poprawnie działał musimy także uruchomić obsługę PHP-XSL oraz Apache URL Rewrite Module (które domyślnie są wyłączone). Najpierw włączymy moduł Rewrite – klikamy na ikonkę WAMPa i z menu wybieramy Apache >> Moduły Apache i klikamy na rewrite_module (serwer automatycznie się zrestartuje). Teraz czas na XSL – postępując analogicznie PHP >> Rozszerzenia PHP i wybieramy php_xsl. Jednak istnieje jeszcze jeden plik php.ini, którego WAMP czasem nie zmienia (nie wiedzieć czemu) – zatem musimy ręcznie otworzyć C:\wamp\bin\php\php5.2.8\php.ini i usunąć średnik z poniższej linii:

;extension=php_xsl.dll

Teraz powinniśmy dodać zmienne środowiskowe by mięć dostęp do PHP i MySQL pod konsolą. Klikamy prawym przyciskiem myszy na Mój komputer i wybieramy Właściwości, następnie w zakładce Zaawansowane klikamy przycisk Zmienne środowiskowe. W zmiennych systemowych do zmiennej PATH dodajemy na końcu ;C:\wamp\bin\php\php5.2.8;C:\wamp\bin\mysql\mysql5.0.45\bin (ścieżki do naszych plików MySQLa i PHP rozdzielone średnikami).

Część 2 – Instalacja PEARa

PEAR (PHP Extension and Application Repository) to system dystrybucji rozszerzeń do języka PHP. Instalator dołączony jest domyślnie, więc i ten etap nie zajmuje dużo czasu.

Wchodzimy do katalogu PHP w WAMPie (np. C:\wamp\bin\php\php5.2.8\) i odpalamy plik go-pear.bat. Odpowiadamy na pytania instalatora by przygotować konfigurację – domyślna powinna być ok.

W katalogu PHP został dla nas utworzony plik PEAR_ENV.reg, który dla wygody doda nam automatycznie odpowiednie zmienne środowiskowe PEARa – należy go kliknąć dwukrotnie by wstawić odpowiednie dane do rejestru.

Część 3 – Instalacja Symfony

Otwieramy konsolę i wpisujemy:

> pear channel-discover pear.symfony-project.com

Jeśli wszystko się powiedzie ujrzymy:

Adding Channel “pear.symfony-project.com” succeeded
Discovery of channel “pear.symfony-project.com” succeeded

Przyszedł wreszcie ten upragniony czas by zainstalować Symfony:

> pear install symfony/symfony

Ściągnięcie paczki nie powinno trwać długo (~2 MB), a PEAR w pełni automatyzuje cały proces.

Aby zweryfikować czy Symfony zostało zainstalowane poprawnie wpiszmy:

symfony -V

Powinniśmy ujrzeć na ekranie informację zawierającą wersję zainstalowanego przed chwilą frameworka.

Część 4 – Pierwszy projekt w Symfony

Zakładając, że wszystko do tej pory poszło gładko możemy przejść do rzeczy najprzyjemniejszych – zainicjować nasz pierwszy projekt:

> cd C:\wamp\www
> mkdir mojprojekt
> cd mojprojekt
> symfony init-project mojprojekt
> symfony init-app testapp

Dla Symfony 1.2 poprawnym sposobem zainicjowania projektu jest:

> symfony generate:project mojprojekt
> symfony generate:app —escaping-strategy=on —csrf-secret=Unique$ecret testapp

Przy wywolaniu generate:app użyliśmy także dwóch (opcjonalnych) parametrów związanych z bezpieczeństwem:

• –escaping-strategy – Włącza output escaping chroniąc nasz projekt przed atakami XSS
• –csrf-secret – Generuje tokeny chroniąc nas przed atakami CSRF

Tak, Symfony 1.2 chroni nasze projekty przed dwoma najbardziej rozpowszechnionymi atakami w sieci!

Gratulacje!

Efekt swojej pracy możesz zobaczyć pod http://127.0.0.1/mojprojekt/web/

I to byłoby na tyle. Życzę wielu udanych projektów z Symfony w przyszłości

Co dalej?

• Zapraszam do przeczytania mojego poradnika na temat poprawnej konfiguracji Apacha dla projektów Symfony.
• Odwiedzenia oficjalnej strony Symfony i dalszego odkrywania tego frameworka dzięki licznym poradnikom i dobrze napisanej dokumentacji (niestety wciąż bez polskiego tłumaczenia).