Zend_Amf-Server.xml 33 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800
  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <!-- EN-Revision: 24249 -->
  3. <!-- Reviewed: no -->
  4. <sect1 id="zend.amf.server">
  5. <title>Zend_Amf_Server</title>
  6. <para>
  7. <classname>Zend_Amf_Server</classname> bietet einen <acronym>RPC</acronym>-artigen Server
  8. für die Behandlung der Anfragen die vom Adobe Flash Player durchgeführt werden indem das
  9. <acronym>AMF</acronym> Protokoll verwendet wird. Wie alle Zend Framework Serverklassen,
  10. folgt es der SoapServer <acronym>API</acronym>, und bietet ein einfach zu merkendes
  11. Interface für die Erstellung von Servern.
  12. </para>
  13. <example id="zend.amf.server.basic">
  14. <title>AMF Server Grundlagen</title>
  15. <para>
  16. Angenommen wir haben eine Klasse <classname>Foo</classname> mit einer Anzahl von
  17. öffentlichen Methoden erstellt. Man kann einen <acronym>AMF</acronym> Server erstellen
  18. indem der folgende Code verwendet wird:
  19. </para>
  20. <programlisting language="php"><![CDATA[
  21. $server = new Zend_Amf_Server();
  22. $server->setClass('Foo');
  23. $response = $server->handle();
  24. echo $response;
  25. ]]></programlisting>
  26. <para>
  27. Alternativ kann stattdessen man eine einfache Funktion als Callback anhängen:
  28. </para>
  29. <programlisting language="php"><![CDATA[
  30. $server = new Zend_Amf_Server();
  31. $server->addFunction('myUberCoolFunction');
  32. $response = $server->handle();
  33. echo $response;
  34. ]]></programlisting>
  35. <para>
  36. Man kann auch mehrere Klassen und Funktionen mischen und verwenden. Wenn man das macht
  37. wird empfohlen das jede von Ihnen einen Namespace erhält um sicherzustellen das keine
  38. Kollision von Methodennamen stattfindet; das kann durchgeführt werden indem man einfach
  39. ein zweites Stringargument entweder an <methodname>addFunction()</methodname> oder an
  40. <methodname>setClass()</methodname> übergibt:
  41. </para>
  42. <programlisting language="php"><![CDATA[
  43. $server = new Zend_Amf_Server();
  44. $server->addFunction('myUberCoolFunction', 'my')
  45. ->setClass('Foo', 'foo')
  46. ->setClass('Bar', 'bar');
  47. $response = $server->handle();
  48. echo $response;
  49. ]]></programlisting>
  50. <para>
  51. <classname>Zend_Amf_Server</classname> erlaubt es auch Services das Sie dynamisch
  52. geladen werden, basierend auf dem angegebenen Verzeichnispfad. Man kann dem Server so
  53. viele Verzeichnisse wie man will hinzufügen. Die Reihenfolge in der man die
  54. Verzeichnisse zum Server hinzufügt ist die Reihenfolge in der die
  55. <acronym>LIFO</acronym> Suche auf den Verzeichnissen durchgeführt wird um die Klasse
  56. zu finden. Das Hinzufügen von Verzeichnissen wird mit der
  57. <methodname>addDirectory()</methodname> Methode durchgeführt.
  58. </para>
  59. <programlisting language="php"><![CDATA[
  60. $server->addDirectory(dirname(__FILE__) .'/../services/');
  61. $server->addDirectory(dirname(__FILE__) .'/../package/');
  62. ]]></programlisting>
  63. <para>
  64. Wenn entfernte Services aufgerufen werden kann der Quellname einen Unterstrich ("_")
  65. oder Punkt (".") Begrenzer im Verzeichnis haben. Wenn ein Unterstrich verwendet wird
  66. werden die Namenskonventionen der <acronym>PEAR</acronym> und Zend Framework Klassen
  67. verwendet. Das bedeutet das wenn man das Sevice com_Foo_Bar
  68. aufruft wird der Server nach der Datei <filename>Bar.php</filename> suchen, und zwar in
  69. jedem der eingefügten Pfade unter <filename>com/Foo/Bar.php</filename>. Wenn die Punkt
  70. Notation für entfernte Services wie für <filename>com.Foo.Bar</filename> verwendet
  71. wird, wird jedem eingefügten Pfad <filename>com/Foo/Bar.php</filename> am Ende
  72. hinzugefügt um <filename>Bar.php</filename> automatisch zu laden.
  73. </para>
  74. <para>
  75. Alle <acronym>AMF</acronym> Anfragen die an das Skript gesendet werden, werden dann
  76. durch den Server behandelt, und eine <acronym>AMF</acronym> Antwort wird zurückgegeben.
  77. </para>
  78. </example>
  79. <note>
  80. <title>Alle angehängten Methoden und Funktionen benötigen einen Docblock</title>
  81. <para>
  82. Wie alle anderen Serverkomponenten im Zend Framework müssen die Klassenmethoden
  83. dokumentiert werden indem <acronym>PHP</acronym> Docblocks verwendet werden. Mindestens
  84. muß für jedes benötigte Argument eine Beschreibung angegeben werden sowie ein
  85. Rückgabewert. Als Beispiel:
  86. </para>
  87. <programlisting language="php"><![CDATA[
  88. // Funktion zum Anhängen:
  89. /**
  90. * @param string $name
  91. * @param string $greeting
  92. * @return string
  93. */
  94. function helloWorld($name, $greeting = 'Hello')
  95. {
  96. return $greeting . ', ' . $name;
  97. }
  98. ]]></programlisting>
  99. <programlisting language="php"><![CDATA[
  100. // Angehängte Klasse
  101. class World
  102. {
  103. /**
  104. * @param string $name
  105. * @param string $greeting
  106. * @return string
  107. */
  108. public function hello($name, $greeting = 'Hello')
  109. {
  110. return $greeting . ', ' . $name;
  111. }
  112. }
  113. ]]></programlisting>
  114. <para>
  115. Andere anmerkungen können verwendet werden, werden aber ignoriert.
  116. </para>
  117. </note>
  118. <sect2 id="zend.amf.server.flex">
  119. <title>Zum Server von Flex aus verbinden</title>
  120. <para>
  121. Zum eigenen <classname>Zend_Amf_Server</classname> von einem Flex Projekt aus zu
  122. verbinden ist recht einfach; man muß zur Endpunkt <acronym>URI</acronym> des
  123. <classname>Zend_Amf_Server</classname> Sripts zeigen.
  124. </para>
  125. <para>
  126. Nehmen wir zum Beispiel an das man einen Server erstellt hat und Ihn in der
  127. <filename>server.php</filename> Datei im Anwendungsroot platziert, und die
  128. <acronym>URI</acronym> deswegen <filename>http://example.com/server.php</filename> ist.
  129. In diesem Fall würde man die <filename>services-config.xml</filename> Datei so
  130. modifizieren damit das channel endpoint uri Attribut auf diesen Wert gesetzt ist.
  131. </para>
  132. <para>
  133. Wenn man noch keine <filename>service-config.xml</filename> Datei erstellt hat kann man
  134. das tun, indem man das Projekt im Navigator Fenster öffnet. Auf dem Projektnamen
  135. rechts-klickt und 'properties' auswählt. Im Fenster der Projekteigenschaften muß man in
  136. das 'Flex Build Path' Menü, auf den 'Library path' Tab und sicherstellen das die
  137. '<filename>rpc.swc</filename>' Datei bei den Projektpfaden hinzugefügt ist und auf Ok
  138. drücken um das Fenster zu schließen.
  139. </para>
  140. <para>
  141. Man muß dem Compiler auch mitteilen das er die <filename>service-config.xml</filename>
  142. verwenden soll um den Endpunkt des RemoteObjects zu finden. Um das zu tun muß das
  143. Fenster der Projekteigenschaften nochmals durch einen rechts-klick auf das
  144. Projektverzeichnis vom Navigator aus geöffnet und Eigenschaften ausgewählt werden. Vom
  145. Eigenschaften-Popup muß 'Flex Compiler' aufgewählt und der String:
  146. <command>-services "services-config.xml"</command> hinzugefügt werden. Auf Apply
  147. drücken, anschließend auf OK um die Option zu aktualisieren. Was man jetzt getan hat,
  148. ist dem Flex Compiler zu sagen das er in der Datei
  149. <filename>services-config.xml</filename> nach Laufzeitvariablen schauen soll die von
  150. der RemotingObject Klasse verwendet werden.
  151. </para>
  152. <para>
  153. Jetzt müssen wir Flex mitteilen welche Konfigurationsdateien der Services für die
  154. Verbindung zu unseren entfernten Methoden zu verwenden sind. Aus diesem Grund muß eine
  155. neue '<filename>services-config.xml</filename>' Datei im Flexprojekt src Verzeichnis
  156. erstellt werden. Um das zu tun, muß man auf den Projektfolder rechts klicken und 'new'
  157. 'File' auswählen was ein neues Fenster öffnet. Anschließend das Projektverzeichnis
  158. auswählen und dann die Datei '<filename>services-config.xml</filename>' benennen und
  159. auf Beenden drücken.
  160. </para>
  161. <para>
  162. Flex hat eine neue <filename>services-config.xml</filename> erstellt und Sie geöffnet.
  163. Verwende den folgenden Beispieltext für die <filename>services-config.xml</filename>
  164. Datei. Es muß sichergestellt werden das der Endpunkt so aktualisiert wird das er zu dem
  165. des eigenen Testservers passt. Anschließend sicherstellen das die Datei gespeichert
  166. wird.
  167. </para>
  168. <programlisting language="xml"><![CDATA[
  169. <?xml version="1.0" encoding="UTF-8"?>
  170. <services-config>
  171. <services>
  172. <service id="zend-service"
  173. class="flex.messaging.services.RemotingService"
  174. messageTypes="flex.messaging.messages.RemotingMessage">
  175. <destination id="zend">
  176. <channels>
  177. <channel ref="zend-endpoint"/>
  178. </channels>
  179. <properties>
  180. <source>*</source>
  181. </properties>
  182. </destination>
  183. </service>
  184. </services>
  185. <channels>
  186. <channel-definition id="zend-endpoint"
  187. class="mx.messaging.channels.AMFChannel">
  188. <endpoint uri="http://example.com/server.php"
  189. class="flex.messaging.endpoints.AMFEndpoint"/>
  190. </channel-definition>
  191. </channels>
  192. </services-config>
  193. ]]></programlisting>
  194. <para>
  195. Es gibt zwei Schlüsselpunkt im Beispiel. Erstens, aber letztes im Code, erstellen wir
  196. einen <acronym>AMF</acronym> Kanal, und spezifizieren den Endpunt als die
  197. <acronym>URL</acronym> zu unserem <classname>Zend_Amf_Server</classname>:
  198. </para>
  199. <programlisting language="xml"><![CDATA[
  200. <channel-definition id="zend-endpoint"
  201. <endpoint uri="http://example.com/server.php"
  202. class="flex.messaging.endpoints.AMFEndpoint"/>
  203. </channel-definition>
  204. ]]></programlisting>
  205. <para>
  206. Es ist zu beachten das wir diesem Kanal einen Identifikator, "zend-endpoint", gegeben
  207. haben. Das Beispiel erstellt ein Ziel für den Service auf zu diesen Kanal zeigt,
  208. und fügt es auch als ID hinzu -- in diesem Zall "zend".
  209. </para>
  210. <para>
  211. In unseren Flex <acronym>MXML</acronym> Dateien müssen wir ein RemoteObject an das
  212. Service binden. In <acronym>MXML</acronym> kann das wie folgt getan werden:
  213. </para>
  214. <programlisting language="xml"><![CDATA[
  215. <mx:RemoteObject id="myservice"
  216. fault="faultHandler(event)"
  217. showBusyCursor="true"
  218. destination="zend">
  219. ]]></programlisting>
  220. <para>
  221. Hier haben wir ein neues entferntes Objekt definiert das durch "myservice"
  222. identifiziert an das Serviceziel "zend" gebunden ist das wir in der
  223. <filename>services-config.xml</filename> Datei definiert haben. Dann rufen wir die
  224. Methoden auf Ihnen in unserem ActionScript einfach durch Aufruf von
  225. "myservice.&lt;method&gt;" auf. Als Beispiel:
  226. </para>
  227. <programlisting language="ActionScript"><![CDATA[
  228. myservice.hello("Wade");
  229. ]]></programlisting>
  230. <para>
  231. Wenn wir Namespaces aktivieren würden wir "myservice.&lt;namespace&gt;.&lt;method&gt;"
  232. verwenden:
  233. </para>
  234. <programlisting language="ActionScript"><![CDATA[
  235. myservice.world.hello("Wade");
  236. ]]></programlisting>
  237. <para>
  238. Für weitere Informationen über den Aufruf von Flex RemoteObject, <ulink
  239. url="http://livedocs.adobe.com/flex/3/html/help.html?content=data_access_4.html">besuchen
  240. Sie die Adobe Flex 3 Hilfeseite</ulink>.
  241. </para>
  242. </sect2>
  243. <sect2 id="zend.amf.server.errors">
  244. <title>Fehlerbehandlung</title>
  245. <para>
  246. Standardmäßig werden alle Exceptions die in den angehängten Klassen oder Funktionen
  247. geworfen werden gefangen und als <acronym>AMF</acronym> Fehlermeldungen zurückgegeben.
  248. Trotzdem wird der Inhalt des ErrorMessage Objekts variieren basierend darauf ob der
  249. Server im "Produktions" Modus ist (der Standardzustand) oder nicht.
  250. </para>
  251. <para>
  252. Wenn er in Produktionsmodus ist wird nur der Exceptioncode zurückgegeben. Wenn der
  253. Produktionsmodus ausgeschaltet wird -- etwas das nur für das Testen getan werden sollte
  254. -- werden die meisten Exceptiondetails zurückgegeben: Die Meldung der Exception, die
  255. Zeile, und der Backtrace werden alle angehängt.
  256. </para>
  257. <para>
  258. Um den Produktionsmodus auszuschalten muß das folgende getan werden:
  259. </para>
  260. <programlisting language="php"><![CDATA[
  261. $server->setProduction(false);
  262. ]]></programlisting>
  263. <para>
  264. Um Ihn wieder einzuschalten, muß stattdessen einfach ein boolscher
  265. <constant>TRUE</constant> Wert übergeben werden:
  266. </para>
  267. <programlisting language="php"><![CDATA[
  268. $server->setProduction(true);
  269. ]]></programlisting>
  270. <note>
  271. <title>Der Produktionsmode sollte sparsam deaktiviert werden!</title>
  272. <para>
  273. Wir empfehlen den Produktionsmode nur während der Entwicklung auszuschalten.
  274. Exceptionmeldungen und Backtraces können sensitive Systeminformationen enthalten
  275. auf die nicht von Aussenstehenden zugegriffen werden darf. Selbst wenn
  276. <acronym>AMF</acronym> ein binäres Format ist, ist die Spezifikation offen, was
  277. bedeutet das jeder den Payload potentiell deserialisieren kann.
  278. </para>
  279. </note>
  280. <para>
  281. Ein Feld bei dem man im speziellen Vorsichtig sein muß ist bei <acronym>PHP</acronym>
  282. Fehlern selbst. Wenn die <acronym>INI</acronym> Direktive
  283. <property>display_errors</property> aktiviert ist, wird jeder <acronym>PHP</acronym>
  284. Fehler für das aktuelle Error Reporting Level direkt in der Ausgabe dargestellt -- was
  285. den <acronym>AMF</acronym> Antwortpayload potentiell unterbrechen kann. Wir empfehlen
  286. die <property>display_errors</property> Direktive in der Produktion auszuschalten um
  287. solche Probleme zu verhindern.
  288. </para>
  289. </sect2>
  290. <sect2 id="zend.amf.server.response">
  291. <title>AMF Antworten</title>
  292. <para>
  293. Fallweise ist es gewünscht das Antwortobjekt leicht zu manipulieren, typischerweise um
  294. zusätzliche Nachrichtenheader zurückzugeben. Die <methodname>handle()</methodname>
  295. Methode des Servers gibt das Antwortobjekt zurück, was es erlaubt das zu tun.
  296. </para>
  297. <example id="zend.amf.server.response.messageHeaderExample">
  298. <title>Nachrichtenheader der AMF Antwort hinzufügen</title>
  299. <para>
  300. In diesem Beispiel fügen wir einen 'foo' Nachrichtenheader mit dem Wert 'bar' zu der
  301. Antwort hinzu bevor sie zurückgegeben wird.
  302. </para>
  303. <programlisting language="php"><![CDATA[
  304. $response = $server->handle();
  305. $response->addAmfHeader(new Zend_Amf_Value_MessageHeader('foo', true, 'bar'))
  306. echo $response;
  307. ]]></programlisting>
  308. </example>
  309. </sect2>
  310. <sect2 id="zend.amf.server.typedobjects">
  311. <title>Typ Objekte</title>
  312. <para>
  313. Ähnlich wie <acronym>SOAP</acronym>, erlaubt es <acronym>AMF</acronym> Objekte zwischen
  314. dem Client und dem Server zu übergeben. Das erlaubt eine große Flexibilität und Bindung
  315. zwischen den zwei Umgebungen.
  316. </para>
  317. <para>
  318. <classname>Zend_Amf</classname> bietet drei Methoden für das Mappen von ActionScript und
  319. <acronym>PHP</acronym> Objekten.
  320. </para>
  321. <itemizedlist>
  322. <listitem>
  323. <para>
  324. Erstens kann man explizite Bindungen auf Serverlevel erstellen indem die
  325. <methodname>setClassMap()</methodname> Methode verwendet wird. Das erste
  326. Argument ist der ActionScript Klassenname, das zweite ist der Name der
  327. <acronym>PHP</acronym> Klasse auf die gemappt wird:
  328. </para>
  329. <programlisting language="php"><![CDATA[
  330. // Die ActionScript Klasse 'ContactVO' auf die PHP Klasse 'Contact' mappen:
  331. $server->setClassMap('ContactVO', 'Contact');
  332. ]]></programlisting>
  333. </listitem>
  334. <listitem>
  335. <para>
  336. Zweitens kann die öffentliche Eigenschaft <varname>$_explicitType</varname> in
  337. der <acronym>PHP</acronym> Klasse gesetzt werden, wobei der Wert die
  338. ActionScript Klasse repräsentiert auf die gemappt wird:
  339. </para>
  340. <programlisting language="php"><![CDATA[
  341. class Contact
  342. {
  343. public $_explicitType = 'ContactVO';
  344. }
  345. ]]></programlisting>
  346. </listitem>
  347. <listitem>
  348. <para>
  349. Drittens, in ähnlicher Art und Weise, kann eine öffentliche Methode
  350. <methodname>getASClassName()</methodname> in der <acronym>PHP</acronym> Klasse
  351. definiert werden; diese Methode sollte die passende ActionScript Klasse
  352. zurückgeben:
  353. </para>
  354. <programlisting language="php"><![CDATA[
  355. class Contact
  356. {
  357. public function getASClassName()
  358. {
  359. return 'ContactVO';
  360. }
  361. }
  362. ]]></programlisting>
  363. </listitem>
  364. </itemizedlist>
  365. <para>
  366. Auch wenn wir nun den ContactVO auf dem Server erstellt have müssen wir nun seine
  367. korrespondierende Klasse in <acronym>AS3</acronym> für das Server Objekt erstellen das
  368. gemappt werden soll.
  369. </para>
  370. <para>
  371. Einen Rechtsklick auf das src Verzeichnis des Flex Projekts und New -> ActionScript File
  372. auswählen. Name der Datei ContactVO und finish drücken um die neue Datei zu sehen.
  373. Den folgenden Code in die Datei kopieren um die Erstellung der Klasse fertigzustellen.
  374. </para>
  375. <programlisting language="as"><![CDATA[
  376. package
  377. {
  378. [Bindable]
  379. [RemoteClass(alias="ContactVO")]
  380. public class ContactVO
  381. {
  382. public var id:int;
  383. public var firstname:String;
  384. public var lastname:String;
  385. public var email:String;
  386. public var mobile:String;
  387. public function ProductVO():void {
  388. }
  389. }
  390. }
  391. ]]></programlisting>
  392. <para>
  393. Die Klasse ist syntaktisch identisch zu der von <acronym>PHP</acronym> mit dem gleichen
  394. Namen. Die Variablennamen sind exakt die gleichen und müssen im gleichen Fall sein um
  395. korrekt zu arbeiten. Es gibt zwei eindeutige <acronym>AS3</acronym> Metatags in dieser
  396. Klasse. Das Erste kann gebunden werden was ein Änderungsevent wirft wenn es
  397. aktualisiert wird. Das zweite Tag ist das RemoteClass Tag welches definiert das diese
  398. Klasse ein gemapptes entferntes Objekt haben kann, in diesem Fall mit dem Aliasnamen
  399. <emphasis>ContactVO</emphasis>. Es ist erforderlich das dieses Tag und der Wert der in
  400. der <acronym>PHP</acronym> Klasse gesetzt wurde, strikt identisch sind.
  401. </para>
  402. <programlisting language="as"><![CDATA[
  403. [Bindable]
  404. private var myContact:ContactVO;
  405. private function getContactHandler(event:ResultEvent):void {
  406. myContact = ContactVO(event.result);
  407. }
  408. ]]></programlisting>
  409. <para>
  410. Das folgende Ergebnisevent vom Serviceaufruf wird sofort zu Flex ContactVO gecastet.
  411. Alles das bei myContact gebunden ist, wird mit den von ContactVO zurückgegebenen
  412. Daten aktualisiert.
  413. </para>
  414. </sect2>
  415. <sect2 id="zend.amf.server.resources">
  416. <title>Ressourcen</title>
  417. <para>
  418. <classname>Zend_Amf</classname> bietet Tools für das Mappen von Ressource Typen die
  419. von Service Klassen in von ActionScript verwendbaren Daten zurückgegeben werden.
  420. </para>
  421. <para>
  422. Um spezielle Ressource Typen zu behandeln, muss der Benutzer eine Plugin Klasse
  423. erstellen die nach dem Ressource Namen benannt ist, mit großgeschriebenen Wörtern
  424. und entfernten Leerzeichen (ein Ressouce Typ "mysql result" wird zu MysqlResult),
  425. mit einem Präfix, z.B. <classname>My_MysqlResult</classname>. Diese Klasse sollte eine
  426. Methode implementieren, <methodname>parse()</methodname>, die ein Argument - die
  427. Ressource - annimmt und den Wert zurückgibt der an das ActionScript gesendet werden
  428. sollte. Die Klasse sollte in der Datei vorhanden sein nachdem die letzte Komponente des
  429. Namens benannt ist, z.B. <filename>MysqlResult.php</filename>.
  430. </para>
  431. <para>
  432. Das Verzeichnis das die Plugins für das Ressource Handling enthält sollte beim Typloader
  433. von <classname>Zend_Amf</classname> registriert sein:
  434. </para>
  435. <programlisting language="php"><![CDATA[
  436. Zend_Amf_Parse_TypeLoader::addResourceDirectory(
  437. "My",
  438. "application/library/resources/My"
  439. );
  440. ]]></programlisting>
  441. <para>
  442. Für eine detailierte Diskussion für das Laden von Plugins, sehen Sie bitte in das
  443. Kapitel <link linkend="zend.loader.pluginloader">Plugin Loader</link>.
  444. </para>
  445. <para>
  446. Das Standardverzeichnis für Ressourcen von <classname>Zend_Amf</classname> wird
  447. automatisch registriert und enthält aktuell Handler für "mysql result" und "stream"
  448. Ressourcen.
  449. </para>
  450. <programlisting language="php"><![CDATA[
  451. // Beispiel für die Implementierung von Ressourcen und die Behandlung
  452. // von Mysql Ergebnis Typen
  453. class Zend_Amf_Parse_Resource_MysqlResult
  454. {
  455. /**
  456. * Parse resource into array
  457. *
  458. * @param resource $resource
  459. * @return array
  460. */
  461. public function parse($resource) {
  462. $result = array();
  463. while($row = mysql_fetch_assoc($resource)) {
  464. $result[] = $row;
  465. }
  466. return $result;
  467. }
  468. }
  469. ]]></programlisting>
  470. <para>
  471. Der Versuch einen unbekannten Ressource Typ zurückzugeben (z.B. einen für den kein
  472. Handler Plugin existiert) führt zu einer Exception.
  473. </para>
  474. </sect2>
  475. <sect2 id="zend.amf.server.flash">
  476. <title>Von Flash aus auf den Server verbinden</title>
  477. <para>
  478. Auf den <classname>Zend_Amf_Server</classname> vom Flash Projekt aus zu verbinden ist
  479. etwas anders als von Flex aus. Trotzdem sind die Funktionen mit
  480. <classname>Zend_Amf_Server</classname> die gleichen wie mit Flex sobald die Verbindung
  481. erstellt wurde. Das folgende Beispiel kann auch von einer Flex <acronym>AS3</acronym>
  482. Datei aus verwendet werden. Wir werden die selbe <classname>Zend_Amf_Server</classname>
  483. Konfiguration mit der World Klasse unserer Verbindung wiederverwenden.
  484. </para>
  485. <para>
  486. Öffne Flash CS und erstelle eine neue Flash Datei (ActionScript 3). Benenne das
  487. Dokument <filename>ZendExample.fla</filename> und speichere das Dokument in einem
  488. Verzeichnis das wir für dieses Beispiel verwenden werden. Erstelle eine neue
  489. <acronym>AS3</acronym> Datei im selben Verzeichnis und benenne die Datei
  490. <filename>Main.as</filename>. Öffne beide Dateien im Editor. Wir werden jetzt diese
  491. zwei Dateien über die Document Klasse verbinden. Wähle ZendExample aus und klicke auf
  492. "stage". Im Eigenschaftsfenster von "stage" ändere die Document Klasse auf Main. Das
  493. verbindet die <filename>Main.as</filename> ActionScript Datei mit dem Benutzer
  494. Interface von <filename>ZendExample.fla</filename>. Wenn die Flashdatei ZendExample
  495. ausgeführt wird, dann wird die Klasse <filename>Main.as</filename> gestartet. Als
  496. nächstes werden wir ein ActionScript hinzufügen um den <acronym>AMF</acronym> Aufruf
  497. durchzuführen.
  498. </para>
  499. <para>
  500. Jetzt werden wir eine Main Klasse erstellen damit wir die Daten zum Server schicken und
  501. das Ergebnis anzeigen lassen können. Kopiere den folgenden Code in die
  502. <filename>Main.as</filename> Datei und wird werden den Code anschauen um zu erklären
  503. was die Rolle eines jeden Elements ist.
  504. </para>
  505. <programlisting language="as"><![CDATA[
  506. package {
  507. import flash.display.MovieClip;
  508. import flash.events.*;
  509. import flash.net.NetConnection;
  510. import flash.net.Responder;
  511. public class Main extends MovieClip {
  512. private var gateway:String = "http://example.com/server.php";
  513. private var connection:NetConnection;
  514. private var responder:Responder;
  515. public function Main() {
  516. responder = new Responder(onResult, onFault);
  517. connection = new NetConnection;
  518. connection.connect(gateway);
  519. }
  520. public function onComplete( e:Event ):void{
  521. var params = "Zum Server geschickt";
  522. connection.call("World.hello", responder, params);
  523. }
  524. private function onResult(result:Object):void {
  525. // Die zurückgegebenen Daten anzeigen
  526. trace(String(result));
  527. }
  528. private function onFault(fault:Object):void {
  529. trace(String(fault.description));
  530. }
  531. }
  532. }
  533. ]]></programlisting>
  534. <para>
  535. Wir müssen zuerst zwei ActionScript Bibliotheken importieren die den Haufen an Arbeit
  536. erledigen. Das erste ist NetConnection welches wie eine Zweiwege-Leitung, zwischen dem
  537. Client und dem Server, funktioniert. Das zweite ist ein Responder Objekt welches die
  538. Rückgabewerte des Servers behandelt relativ zum Erfolg oder Mißerfolg des Aufrufs.
  539. </para>
  540. <programlisting language="as"><![CDATA[
  541. import flash.net.NetConnection;
  542. import flash.net.Responder;
  543. ]]></programlisting>
  544. <para>
  545. In der Klasse benötigen wir drei Variable um NetConnection, Responder, und die Gateway
  546. <acronym>URL</acronym> zu unserer <classname>Zend_Amf_Server</classname> Installation
  547. zu repräsentieren.
  548. </para>
  549. <programlisting language="as"><![CDATA[
  550. private var gateway:String = "http://example.com/server.php";
  551. private var connection:NetConnection;
  552. private var responder:Responder;
  553. ]]></programlisting>
  554. <para>
  555. Im Main Contructor erstellen wir einen Responder und eine neue Verbindung zum
  556. <classname>Zend_Amf_Server</classname> Endpunkt. Der Responder definiert zwei
  557. unterschiedliche Methoden für die Behandlung des Servers. Der Einfachheit halber haben
  558. wir Sie onResult und onFault benannt.
  559. </para>
  560. <programlisting language="as"><![CDATA[
  561. responder = new Responder(onResult, onFault);
  562. connection = new NetConnection;
  563. connection.connect(gateway);
  564. ]]></programlisting>
  565. <para>
  566. In der onComplete Funktion, welche ausgeführt wird sobald das Konstrukt fertiggestellt
  567. wurde, senden wir die Daten zum Server. Wird benötigen eine weitere zusätzliche Zeile
  568. die den Aufruf der <classname>Zend_Amf_Server</classname> World->hello Funktion
  569. durchführt.
  570. </para>
  571. <programlisting language="as"><![CDATA[
  572. connection.call("World.hello", responder, params);
  573. ]]></programlisting>
  574. <para>
  575. Als wir die Responder Variable erstellt haben, haben wir auch eine onResult und eine
  576. onFault Funktion definiert welche die Antwort des Servers behandeln. Wir haben diese
  577. Funktionen für ein erfolgreiches Ergebnis der Servers hunzugefügt. Ein erfolgreicher
  578. Eventhandler wird immer dann ausgeführt wenn die Verbindung zum Server richtig
  579. handgehabt wird.
  580. </para>
  581. <programlisting language="as"><![CDATA[
  582. private function onResult(result:Object):void {
  583. // Display the returned data
  584. trace(String(result));
  585. }
  586. ]]></programlisting>
  587. <para>
  588. Die onFault Funktion wird aufgerufen wenn eine ungültige Antwort vom Server
  589. zurückgekommen ist. Das passiert wenn auf dem Server ein Fehler stattgefunden hat, die
  590. <acronym>URL</acronym> zum Server ungültig ist, der entfernte Service oder die Methode
  591. nicht existiert, und bei jedem anderen Verbindungsrelevanten Problem.
  592. </para>
  593. <programlisting language="as"><![CDATA[
  594. private function onFault(fault:Object):void {
  595. trace(String(fault.description));
  596. }
  597. ]]></programlisting>
  598. <para>
  599. Das ActionScripts für die Erstellung der entfernten Verbindung ist jetzt fertiggestellt.
  600. Der Aufruf der ZendExample Datei führt jetzt die Verbindung zu
  601. <classname>Zend_Amf</classname> aus. Rückblickend haben wir die benötigten Variablen
  602. hinzugefügt um eine Verbindung zum entfernten Server zu öffnen, definiert welche
  603. Methoden in der Anwendung verwendet werden sollen wenn die Anwendung eine Antwort vom
  604. Server empfängt, und schlußendlich die Anzeige der zurückgegebenen Daten über
  605. <methodname>trace()</methodname>.
  606. </para>
  607. </sect2>
  608. <sect2 id="zend.amf.server.auth">
  609. <title>Authentication</title>
  610. <para>
  611. <classname>Zend_Amf_Server</classname> erlaubt es Authentifizierung und Authorisierungs-
  612. Hooks zu spezifizieren um den Zugriff auf Services zu kontrollieren. Es wird die
  613. Infrastruktur verwendet die von den
  614. <link linkend="zend.auth"><classname>Zend_Auth</classname></link> und
  615. <link linkend="zend.acl"><classname>Zend_Acl</classname></link> Komponenten angeboten
  616. wird.
  617. </para>
  618. <para>
  619. Um Authentifizierung zu definieren, muß der Benutzer einen Authentifizierungs-Adapter
  620. anbieten der die abstrakte Klasse <classname>Zend_Amf_Auth_Abstract</classname>
  621. erweitert. Der Adapter sollte die <methodname>authenticate()</methodname> Methode
  622. implementieren so wie jeder normale
  623. <link linkend="zend.auth.introduction.adapters">Authentifizierungs-Adapter</link>.
  624. </para>
  625. <para>
  626. Der Adapter sollte die Eigenschaften <emphasis>_username</emphasis> und
  627. <emphasis>_password</emphasis> von der Vorgängerklasse
  628. <classname>Zend_Amf_Auth_Abstract</classname> verwenden um authentifizieren zu können.
  629. Diese Werte werden vom Server gesetzt, indem die
  630. <methodname>setCredentials()</methodname> Methode verwendet wird, bevor
  631. <methodname>authenticate()</methodname> aufgerufen wird wenn die Zugangsdaten in den
  632. <acronym>AMF</acronym> Anfrage-Headern empfangen wurden.
  633. </para>
  634. <para>
  635. Die Identität die vom Adapter zurückgegeben wird sollte ein Objekt sein das die
  636. Eigenschaft <property>role</property> enthält damit die Zugriffskontrolle von
  637. <acronym>ACL</acronym> funktioniert.
  638. </para>
  639. <para>
  640. Wenn das Authentifizierungs Ergebnis nicht erfolgreich war, wird die Anfrage nicht
  641. weiter bearbeitet und eine Fehlermeldung wird zurückgegeben mit den Gründen für den
  642. Fehlschlag genommen vom Ergebnis
  643. </para>
  644. <para>
  645. Der Adapter wird zum Server verbunden indem die <methodname>setAuth()</methodname>
  646. Methode verwendet wird:
  647. </para>
  648. <programlisting language="php"><![CDATA[
  649. $server->setAuth(new My_Amf_Auth());
  650. ]]></programlisting>
  651. <para>
  652. Die Zugriffskontrolle wird durchgeführt indem das <classname>Zend_Acl</classname>
  653. Objekt verwendet wird das von der <methodname>setAcl()</methodname> Methode gesetzt
  654. wurde:
  655. </para>
  656. <programlisting language="php"><![CDATA[
  657. $acl = new Zend_Acl();
  658. createPermissions($acl); // Zugriffs-Struktur erstellen
  659. $server->setAcl($acl);
  660. ]]></programlisting>
  661. <para>
  662. Wenn das <acronym>ACL</acronym> Objekt gesetzt ist, und die Klasse die aufgerufen wird
  663. die <methodname>initAcl()</methodname> Methode definiert wird diese Methode, mit dem
  664. <acronym>ACL</acronym> Objekt als Argument, aufgerufen. Die Klasse kann dann
  665. zusätzliche <acronym>ACL</acronym> Regeln erstellen und <constant>TRUE</constant>
  666. zurückgeben, oder <constant>FALSE</constant> wenn keine Zugriffskontrolle für diese
  667. Klasse benötigt wird.
  668. </para>
  669. <para>
  670. Nachdem die <acronym>ACL</acronym> gesetzt wurde, wird der Server prüfen ob mit der,
  671. von der Authentifizierung gesetzten, Rolle Zugriff erlaubt ist, die Ressource im
  672. Klassennamen ist (oder <constant>NULL</constant> für Funktionsaufrufe) und ob die
  673. Privilegien der Funktionsname sind. Wenn keine Authentifizierung angegeben wurde, wird
  674. die <emphasis>anonymous</emphasis> verwendet, wenn diese definiert wurde, andernfalls
  675. wird der Zugriff verweigert.
  676. </para>
  677. <programlisting language="php"><![CDATA[
  678. if($this->_acl->isAllowed($role, $class, $function)) {
  679. return true;
  680. } else {
  681. require_once 'Zend/Amf/Server/Exception.php';
  682. throw new Zend_Amf_Server_Exception("Access not allowed");
  683. }
  684. ]]></programlisting>
  685. </sect2>
  686. </sect1>