Komunikacja Flex-PHP za pomocą AMFPHP

Na początek kilka słów wstępu.
AMF (ang. Action Message Format) jest to binarny format służący do serializacji obiektów ActionScript. Służy on do wymiany danych pomiędzy aplikacjami Flex/Flash ze zdalnymi usługami (np. serwer danych w PHP). Ogólnie rzecz biorąc aplikacja zaimplementowana we Fleksie używa usług udostępnionych przez serwer (PHP) do pobierania (lub wysyłania) danych z (do) bazy danych. A jeszcze prościej pozwala z aplikacji Fleksowej bezpośrednio tworzyć obiekty klas zaimplementowanych w PHP i wywoływać ich metody.

Zanim zaczniemy pobieramy niezbędną do tego celu bibliotekę ze strony projektu http://sourceforge.net/projects/amfphp/files/#files
Po rozpakowaniu kopiujemy zawartość katalogu amfphp NR.WERSJI (u nas 1.9) do katalogu amfphp znajdującego się w katalogu głównym serwera www (web root).
Mamy następującą strukturę:

\browser - przeglądarka dostępnych usług
\core    - jądro biblioteki
\services - katalog z usługami
\gateway.php - brama, przez którą się komunikujemy
\globals.php - ustawienia
\json.php
\xmlrpc.php

Na początek definiujemy katalog, w którym będziemy umieszczać udostępnione usług (domyślnie services). Jeżeli nam to nie odpowiada możemy zmienić ścieżkę w pliku globals.php ($servicesPath).
Kolejnym krokiem będzie stworzenie testowej usługi. W tym celu w katalogu services tworzymy plik Test.php o następującej zawartości:

<?php
class Test {
    function getArray()
    {
        return array('test1','zażółć gęślą jaźń');
    }
}
?>

Teraz przechodzimy do sprawdzenia czy nasza usługa działa, czyli wpisujemy w przeglądarce adres, w naszym przypadku będzie to:
http://localhost/amfphp/browser

Zostaniemy teraz poproszeniu o konfigurację, którą zostawiamy bez zmian. Należy zwrócić uwagę, że Gateway location kieruje właśnie na nasz plik gateway.php.
W lewej kolumnie wybieramy Test. Teraz w prawym panelu powinniśmy mieć aktywną zakładkę Test z listą dostępnych metod. My mamy jedną getArray(), więc wybieramy ją i klikamy Call.
Poniżej powinna pojawić się zawartość naszej tablicy.
Jeśli mamy błędne kodowanie znaków należy sprawdzić kodowanie pliku Test.php (np. UTF-8). Następnie w pliku gateway.php odszukujemy linię:

$gateway->setCharsetHandler("utf8_decode", "ISO-8859-1", "ISO-8859-1");

i zmieniamy ją na:

$gateway->setCharsetHandler("utf8_decode", "UTF-8", "UTF-8");

gdzie pierwszy parametr to metoda konwersji, drugi kodowanie PHP, trzeci kodowanie bazy danych.

Teraz możemy rozbudować nasz przykład o kolejną metodę:

function add($num1 = 0,$num2 = 0)
{
    return $num1+$num2;
}

Dla uproszczenia nie sprawdzamy typów przekazanych zmiennych, w rzeczywistym projekcie należałoby to zrobić.
Wracamy do browser'a, odświeżamy listę metod klikając w ikonę .

Jak można zauważyć lista dostępnych metod powiększyła się o metodę add, którą klikamy i podajemy wartości 2 argumentów. Następnie klikamy Call i w oknie poniżej powinniśmy otrzymać wynik dodawania 2 podanych liczb.

Teraz przechodzimy do utworzenia aplikacji w Adobe Flex.
Na początek utworzymy 'obiekt zdalny' (RemoteObject) reprezentujący naszą klasę Test.

<mx:RemoteObject 
    id="test"
    endpoint="http://localhost/amfphp/gateway.php"
    fault="faultHandler(event)" 
    source="Test" 
    destination="amfphp">
    <mx:method name="getArray" result="resultHandler(event)" />
    <mx:method name="add" result="resultHandler(event)" />
</mx:RemoteObject>

Jak można zauważyć mamy tu zdefiniowany adres bramy (endpoint), nazwę klasy w PHP (source) oraz dwie metody getArray i add.

Kolejnym etapem będzie zdefiniowanie przycisków, które posłużą do wywołania naszych metod oraz stworzenie pola, które wyświetli dane zwrócone z serwera.

<mx:HBox>
    <mx:Button label="getArray" click="test.getArray();"/>
    <mx:Button label="add" click="test.add(2,4);"/>
    <mx:Button label="Fault" click="test.foo();"/>
</mx:HBox>
<mx:TextArea id="result" width="500" height="220"/>

Zauważmy, że dla metody add po prostu przekazujemy argumenty tak jakbyśmy wywoływali metodę bezpośrednio z PHP.
Dodatkowo utworzyliśmy jeden przycisk wywołujący nieistniejącą metodę, aby przetestować funkcję faultHandler.

Pozostało teraz zdefiniować funkcje faultHandelr i resultHandler w tym celu tworzymy sekcję mx:Script z następującą zawartością:

import mx.rpc.events.ResultEvent;
import mx.rpc.events.FaultEvent;

private function faultHandler(fault:FaultEvent):void
{
    result.text = "code:\n" + fault.fault.faultCode + "\n\nMessage:\n" + fault.fault.faultString;
}

private function resultHandler(event:ResultEvent):void
{
    result.text = event.result.toString();
}

Całość naszego przykładu powinna prezentować się następująco:

<?xml version="1.0" encoding="utf-8"?>
<mx:Application xmlns:mx="http://www.adobe.com/2006/mxml">
    <mx:Script>
        <![CDATA[
            import mx.rpc.events.ResultEvent;
            import mx.rpc.events.FaultEvent;
            private function faultHandler(fault:FaultEvent):void
            {
                result.text = "code:\n" + fault.fault.faultCode + "\n\nMessage:\n" + fault.fault.faultString;
            }

            private function resultHandler(event:ResultEvent):void
            {
                result.text = event.result.toString();
            }
        ]]>
    </mx:Script>
    <mx:RemoteObject 
        id="test"
        endpoint="http://localhost/amfphp/gateway.php"
        fault="faultHandler(event)" 
        source="Test" 
        destination="amfphp">
        <mx:method name="getArray" result="resultHandler(event)" />
        <mx:method name="add" result="resultHandler(event)" />
    </mx:RemoteObject>
    <mx:HBox>
        <mx:Button label="getArray" click="test.getArray();"/>
        <mx:Button label="add" click="test.add(2,4);"/>
        <mx:Button label="Fault" click="test.foo();"/>
    </mx:HBox>
    <mx:TextArea id="result" width="500" height="220"/>
</mx:Application>

Teraz pozostało już tylko przetestować aplikację, w tym celu klikamy w kolejne przyciski i obserwujemy wyniki w pole tekstowym poniżej. Zgodnie z przewidywaniem wywołanie metody foo spowodowało wyświetlenie komunikatu błędu The method {foo} does not exist in class {Test}.