Za\u0142\u00f3\u017cmy, \u017ce chcemy, aby nasza aplikacja dzia\u0142a\u0142a w taki spos\u00f3b, \u017ce gdy przychodzi pe\u0142ne nowe zapytanie o ca\u0142\u0105 stron\u0119, pokazuje widok akcji razem z pe\u0142nym layoutem, a gdy zapytanie przychodzi przez AJAX, wysy\u0142a tylko widok akcji, a layout pomija. Jest to do\u015b\u0107 popularna forma dynamizacji nawigacji po stronie za pomoc\u0105 schematu hashbang<\/em> (#!<\/em>) albo jeszcze lepiej pushState<\/em>.<\/p>\n

Rozpoznanie zapytania Ajaksowego odbywa si\u0119 na podstawie nag\u0142\u00f3wka\u00a0X-Requested-With<\/em>. Wi\u0119kszo\u015b\u0107 framework\u00f3w z obs\u0142ug\u0105 AJAX ustawia go na warto\u015b\u0107\u00a0XMLHttpRequest<\/em>. Zend Framework dostarcza metody \u0142atwego sprawdzenia tego nag\u0142\u00f3wka i warto\u015bci z poziomu kontrolera\u00a0$this->getRequest()->isXmlHttpRequest()<\/span>\u00a0. Je\u017celi w takim przypadku chcemy wy\u0142\u0105czy\u0107 wykorzystanie layoutu i wys\u0142a\u0107 do przegl\u0105darki sam widok akcji, musimy model widoku (zaleca odpowied\u017a akcji kontrolera) ustawi\u0107 jako ko\u0144cowy („terminal<\/em>„):<\/p>\n

\/**\n * @return \\Zend\\View\\Model\\ViewModel\n *\/\npublic function myAction()\n{\n    \/\/ tutaj kod akcji i ustawienie zmiennych, kt\u00f3re mo\u017cna przekaza\u0107 do widoku\n\n    $vm = new \\Zend\\View\\Model\\ViewModel();\n\n    if ($this->getRequest()->isXmlHttpRequest()) {\n        $vm->setTerminal(true);\n    }\n\n    return $vm;\n}<\/pre>\n
I to wystarczy aby w ten spos\u00f3b rozr\u00f3\u017cni\u0107 zwracan\u0105 zawarto\u015b\u0107.<\/p>\n
Odpowied\u017a JSON (w zale\u017cno\u015bci od \u017c\u0105danego formatu)<\/h3>\n
Buduj\u0105c aplikacj\u0119 w ten spos\u00f3b, \u017ceby mog\u0142a ona od razu dzia\u0142a\u0107 jako API, mo\u017cemy np. wy\u015bwietla\u0107 dane w formacie JSON na \u017c\u0105danie. Co pozwoli wchodz\u0105c na przyk\u0142adowy URL \/users<\/em> zobaczy\u0107 list\u0119 u\u017cytkownik\u00f3w jako normalna strona HTML, kt\u00f3ra jest cz\u0119\u015bci\u0105 serwisu, a wchodz\u0105c na \/users.json<\/em> zobaczymy informacje o tych u\u017cytkownikach w formacje JSON. Zachowuj\u0105c przy tym przestrzeganie wszystkich parametr\u00f3w z query<\/em>, np. stronicowanie albo wyszukiwanie.<\/p>\n
Zend Framework w wersji 2 wprowadzi\u0142 nowy spos\u00f3b wy\u015bwietlania. Wy\u015bwietlanie sk\u0142ada si\u0119 z wielu warstw, z kt\u00f3rych najwa\u017cniejsze to:<\/p>\n
\n
modele wy\u015bwietlania (View Models<\/em>), kt\u00f3re \u0142\u0105cz\u0105 zmienne z plikami widok\u00f3w (np. phtml) oraz steruj\u0105 renderowaniem. Domy\u015blnym obiektem tworzonym przez akcj\u0119 jest obiekt klasy\u00a0Zend\\View\\Model\\ViewModel<\/em>. Nawet zwracaj\u0105c tablic\u0119 zmiennych, ZF2 tworzy z niej ViewModel<\/em> z domy\u015blnymi ustawieniami.<\/span><\/li>\n
renderery (Renderers<\/em>, nie przychodzi mi do g\u0142owy dobre t\u0142umaczenie), kt\u00f3re odpowiadaj\u0105 za wczytanie pliku widoku, przekazanie tam zmiennych i wyrenderowanie wyniku. Domy\u015blnie u\u017cywane s\u0105 podobnie jak w ZF1 pliki phtml, kt\u00f3re s\u0105 HTMLem z osadzonymi fragmentami PHP. Jest troch\u0119 r\u00f3\u017cnic w stosunku do poprzedniej wersji frameworka (tam podobn\u0105 rol\u0119 spe\u0142nia\u0142\u00a0Zend_View<\/em>), ale og\u00f3lna zasada dzia\u0142ania jest ta sama.<\/li>\n
strategie renderowania (Rendering Strategies<\/em>), czyli druga obok modeli wy\u015bwietlania najwi\u0119ksza r\u00f3\u017cnica, gdzie w zale\u017cno\u015bci od r\u00f3\u017cnych warunk\u00f3w (typ modelu, typ \u017c\u0105dania z przegl\u0105darki, wersja mobilna\/desktop), wynik renderowania b\u0119dzie r\u00f3\u017cny.<\/li>\n<\/ul>\n
Jest jeszcze kilka innych warstw, ale z do\u015bwiadczenia wiem, \u017ce s\u0105 one mniej istotne i zazwyczaj domy\u015blne ustawienia wystarczaj\u0105.<\/p>\n
Aby m\u00f3c prawid\u0142owo wy\u015bwietla\u0107 dane z akcji jako format JSON, pierwsze co musimy zrobi\u0107, to w\u0142\u0105czy\u0107 strategi\u0119 renderowania JSON obok standardowej strategii wy\u015bwietlania plik\u00f3w HTML. Robimy to w konfiguracji jednego z modu\u0142\u00f3w naszej aplikacji w sekcji ’view_manager’<\/em>:<\/p>\n
<?php\n\nreturn array(\n    \/\/ to jest tylko fragment pliku konfiguracyjnego\n    'view_manager' => array(\n        'strategies' => array(\n\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 'ViewJsonStrategy',\n\u00a0 \u00a0 \u00a0 \u00a0 ),\n    ),\n);<\/pre>\n
Nast\u0119pnie w akcji kontrolera zamiast standardowego ViewModel<\/em> zwracamy JsonModel<\/em>. Przekazane jako pierwszy argument zmienne w postaci tablicy zostan\u0105 automatycznie przekszta\u0142cone do formatu JSON<\/em> oraz wys\u0142ane do odpowiedzi z typem MIME<\/em> application\/json<\/em>\u00a0(dzi\u0119ki u\u017cyciu strategii). Mo\u017cemy np. zbudowa\u0107 aplikacj\u0119 w taki spos\u00f3b, aby u\u017cytkownik wchodz\u0105c przez przegl\u0105dark\u0119 na zwyk\u0142y adres dostawa\u0142 standardowy widok HTML, a wchodz\u0105c na adres z rozszerzeniem .json<\/em>\u00a0dostawa\u0142 odpowied\u017a w tym formacie.<\/p>\n
Aby to zrobi\u0107, do \u015bcie\u017cki adresowej musimy doda\u0107 parametr, np. w ten spos\u00f3b:<\/p>\n
<?php\n\nreturn array(\n    \/\/ to jest tylko fragment pliku konfiguracyjnego\n    'router' => array(\n        'routes' => array(\n            'home' => array(\n                'type'    => 'Literal',\n                'options' => array(\n                    'route'    => '\/',\n                    'defaults' => array(\n                        '__NAMESPACE__' => 'Application\\Controller',\n                        'controller'    => 'Index',\n                        'action'        => 'index',\n                    ),\n                ),\n                'may_terminate' => true,\n                'child_routes' => array(\n                    'default' => array(\n                        'type'    => 'Segment',\n                        'options' => array(\n                            'route'    => '[:controller[\/:action[\/:id]]][.:format]',\n                            'constraints' => array(\n                                'controller' => '[a-zA-Z][a-zA-Z0-9_-]*',\n                                'action'     => '[a-zA-Z][a-zA-Z0-9_-]*',\n                                'id'         => '[0-9]*',\n                            ),\n                            'defaults' => array(\n                            ),\n                        ),\n                    ),\n                ),\n            ),\n        ),\n    ),\n);<\/pre>\n
Przyk\u0142adowy kontroler, kt\u00f3ry pozwoli pobra\u0107 list\u0119 u\u017cytkownik\u00f3w pod adresem\u00a0\/users<\/em>\u00a0oraz wersj\u0119 JSON<\/em> pod adresem \/users.json<\/em> mo\u017ce wygl\u0105da\u0107 nast\u0119puj\u0105co:<\/p>\n
<?php\n\nnamespace Application\\Controller;\n\nuse Application\\Model\\Users\\UserQuery;\nuse Zend\\Mvc\\Controller\\AbstractActionController;\nuse Zend\\View\\Model\\JsonModel;\nuse Zend\\View\\Model\\ViewModel;\n\n\/**\n * Class UsersController\n *\/\nclass UsersController extends AbstractActionController\n{\n    \/**\n     * @return JsonModel|ViewModel\n     *\/\n    public function indexAction()\n    {\n        $users = UserQuery::create()->findAllByParams($this->getRequest()->getQuery()->toArray());\n\n        switch ($this->params('format')) {\n            case 'json':\n                $usersData = array();\n                foreach ($users as $user) {\n                    $usersData[] = $user->toArray();\n                }\n                return new JsonModel(array(\n                    'success' => true,\n                    'users' => $usersData,\n                ));\n            default:\n                return new ViewModel(array(\n                    'users' => $users,\n                ));\n        }\n    }\n}<\/pre>\n
Podsumowuj\u0105c<\/h3>\n
Wykorzystanie w odpowiedni spos\u00f3b technik opisanych powy\u017cej pozwoli na zbudowanie dynamicznych, ajaksowych, nowoczesnych aplikacji, daj\u0105cym u\u017cytkownik wygod\u0119 poruszania si\u0119. Druga metoda pozawala te\u017c na zbudowanie w bardzo prosty spos\u00f3b API w tworzonym oprogramowaniu, tak aby zewn\u0119trzne aplikacje mog\u0142y w \u0142atwy spos\u00f3b pobiera\u0107 lub tworzy\u0107 dane w serwisie.<\/p>\n","protected":false},"excerpt":{"rendered":"
Patrz\u0105c na fora w Internecie oraz zapytania programist\u00f3w, mam wra\u017cenie, \u017ce obs\u0142uga zapyta\u0144 AJAXowych oraz zwracanie odpowiedzi w formacie JSON w Zend Framework 2 nie jest oczywista. Poni\u017cej postaram si\u0119 przybli\u017cy\u0107 ten temat. 5 lat temu pisa\u0142em o tym temacie w kontek\u015bcie Zend Framework 1. Dzisiaj, kilka miesi\u0119cy po premierze ZF2, nadszed\u0142 czas na od\u015bwie\u017cenie tematu.<\/p>\n","protected":false},"author":1,"featured_media":951,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"jetpack_post_was_ever_published":false,"jetpack_publicize_message":"","jetpack_is_tweetstorm":false,"jetpack_publicize_feature_enabled":true,"jetpack_social_post_already_shared":true,"jetpack_social_options":{"image_generator_settings":{"template":"highway","enabled":false}}},"categories":[14,4,5],"tags":[28,30,19,20],"jetpack_publicize_connections":[],"yoast_head":"\n