Zend_Controller-ActionHelpers-ContextSwitch.xml 30 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746
  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <!-- EN-Revision: 15617 -->
  3. <!-- Reviewed: no -->
  4. <sect3 id="zend.controller.actionhelpers.contextswitch">
  5. <title>ContextSwitch und AjaxContext</title>
  6. <para>
  7. Der <code>ContextSwitch</code> Action Helfer ist vorgesehen für die Erleicherung bei der
  8. Rückgabe von unserschiedlichen Antwortformaten oder Anfragen. Der <code>AjaxContext</code>
  9. Helfer ist eine spezialisierte Version von <code>ContextSwitch</code> die die
  10. Rückgabe von Antworten zu XmlHttpRequests erleichtert.
  11. </para>
  12. <para>
  13. Um einen von Ihnen zu aktivieren, muß der Kontroller darauf hingewiesen werden welche
  14. Aktion zu welchem Kontext antworten kann. Wenn eine hereinkommende Anfrage einen gültigen
  15. Kontext für eine gegebene Aktion indiziert, dann wird der Helfer:
  16. </para>
  17. <itemizedlist>
  18. <listitem><para>
  19. das Layout ausschalten wenn es eingeschaltet ist.
  20. </para></listitem>
  21. <listitem><para>
  22. einen alternativen View suffix setzen, was effektiv ein separates View Skript für
  23. den Kontext benötigt.
  24. </para></listitem>
  25. <listitem><para>
  26. die richtigen Antwort Header für den gewünschten Kontext senden.
  27. </para></listitem>
  28. <listitem><para>
  29. optional den spezifizierten Callback aufrufen um den Kontext zu definieren und/oder
  30. anschließende Berechnungen durchführen.
  31. </para></listitem>
  32. </itemizedlist>
  33. <para>
  34. Als Beispiel wird der folgende Kontroller angenommen:
  35. </para>
  36. <programlisting language="php"><![CDATA[
  37. class NewsController extends Zend_Controller_Action
  38. {
  39. /**
  40. * Landeseite; leitet zu listAction() weiter
  41. */
  42. public function indexAction()
  43. {
  44. $this->_forward('list');
  45. }
  46. /**
  47. * News Items auflisten
  48. */
  49. public function listAction()
  50. {
  51. }
  52. /**
  53. * Ein News Item anzeigen
  54. */
  55. public function viewAction()
  56. {
  57. }
  58. }
  59. ]]></programlisting>
  60. <para>
  61. Angenommen wir wollen das <code>listAction()</code> auch im XML Format vorhanden ist. Statt
  62. der Erstellung einer anderen Aktion, kann angezeigt werden das eine XML Antwort
  63. zurückgegeben wird:
  64. </para>
  65. <programlisting language="php"><![CDATA[
  66. class NewsController extends Zend_Controller_Action
  67. {
  68. public function init()
  69. {
  70. $contextSwitch = $this->_helper->getHelper('contextSwitch');
  71. $contextSwitch->addActionContext('list', 'xml')
  72. ->initContext();
  73. }
  74. // ...
  75. }
  76. ]]></programlisting>
  77. <para>
  78. Was macht das:
  79. </para>
  80. <itemizedlist>
  81. <listitem><para>
  82. Setzt den 'Content-Type' Antwort Header auf 'text/xml'.
  83. </para></listitem>
  84. <listitem><para>
  85. Ändert den View Suffix auf 'xml.phtml' (oder, wenn ein alternativer View Suffix
  86. verwendet wird, 'xml.[dein Suffix]').
  87. </para></listitem>
  88. </itemizedlist>
  89. <para>
  90. Jetzt muß ein neues View Skript erstellt werden, 'news/list.xml.phtml', welches das XML
  91. erzeugt und darstellt.
  92. </para>
  93. <para>
  94. Um zu ermitteln ob eine Anfrage eine Kontextänderung initiiert, prüft der Helfer auf ein
  95. token im Anfrage Objekt. Standardäßig schaut er auf den 'format' Parameter, durch den das
  96. konfiguriert werden kann. Das bedeutet das, in den meisten Fällen, um eine Kontextänderung
  97. zu triggern, ein 'format' Parameter in der Anfrage hinzugefügt werden kann:
  98. </para>
  99. <itemizedlist>
  100. <listitem><para>
  101. über URL Parameter: <code>/news/list/format/xml</code> (beachte, das Standard
  102. Routing Schema erlaubt übliche Schlüssel/Werte Paare nach der Aktion)
  103. </para></listitem>
  104. <listitem><para>
  105. über Abfrage String: z.B., <code>/news/list?format=xml</code>
  106. </para></listitem>
  107. </itemizedlist>
  108. <para>
  109. <code>ContextSwitch</code> erlaubt es beliebige Kontexte zu spezifizieren, inklusive
  110. welche Kontextänderung stattfinden wird (wenn überhaupt), jegliche Antwort Header die
  111. gesendet werden sollen, und beliebige Callbacks für Initialisierung und folgende
  112. Bearbeitung.
  113. </para>
  114. <sect4 id="zend.controller.actionhelpers.contextswitch.contexts">
  115. <title>Vorhandene Standard Kontexte</title>
  116. <para>
  117. Standardmäßig sind zwei Kontexte im <code>ContextSwitch</code> Helfer vorhanden: json
  118. und xml.
  119. </para>
  120. <itemizedlist>
  121. <listitem>
  122. <para>
  123. <emphasis>JSON</emphasis>. Der JSON Kontext setzt den 'Content-Type' Antwort
  124. Header auf 'application/json' und den View Skript Suffix auf 'json.phtml'.
  125. </para>
  126. <para>
  127. Trotzdem wird standardmäßig kein View Skript benötigt. Es serialisiert einfach
  128. alle View Variablen und sendet die JSON Antwort sofort aus.
  129. </para>
  130. <para>
  131. Dieses Verhalten kann deaktiviert werden indem die auto-JSON Serialisierung
  132. abgeschaltet wird:
  133. </para>
  134. <programlisting language="php"><![CDATA[
  135. $this->_helper->contextSwitch()->setAutoJsonSerialization(false);
  136. ]]></programlisting>
  137. </listitem>
  138. <listitem>
  139. <para>
  140. <emphasis>XML</emphasis>. Der XML Kontext setzt den 'Content-Type' Antwort
  141. Header auf 'text/xml' und den View Skript Suffix auf 'xml.phtml'. Es muß ein
  142. neues View Skript für den Kontext erstellt werden.
  143. </para>
  144. </listitem>
  145. </itemizedlist>
  146. </sect4>
  147. <sect4 id="zend.controller.actionhelpers.contextswitch.custom">
  148. <title>Eigene Kontexte erstellen</title>
  149. <para>
  150. Manchmal sind die Standardkontexte nicht genug. Zum Beispiel wenn man YAML zurückgeben
  151. will, oder PHP serialisieren, ein RSS oder ATOM Feed, usw. <code>ContextSwitch</code>
  152. erlaubt es das zu tun.
  153. </para>
  154. <para>
  155. Der einfachste Weg einen neuen Kontext hinzuzufügen ist über die
  156. <code>addContext()</code> Methode. Diese Methoe nimmt zwei Argumente, den Namen des
  157. Kontextes, und eine Array Spezifikation. Die Spezifikation sollte ein oder mehrere der
  158. folgenden Dinge enthalten:
  159. </para>
  160. <itemizedlist>
  161. <listitem>
  162. <para><emphasis>suffix</emphasis>: Der Suffix der dem Standard View Suffix angefügt
  163. werden soll der im ViewRenderer registriert ist.</para>
  164. </listitem>
  165. <listitem>
  166. <para><emphasis>headers</emphasis>: Ein Array von Header/Wert Paaren das als Teil
  167. der Antwort gesendet werden soll.</para>
  168. </listitem>
  169. <listitem>
  170. <para>
  171. <emphasis>callbacks</emphasis>: Ein Array das ein oder mehrere der Schlüssel
  172. 'init' oder 'post' enthält, die auf gültige PHP Callbacks zeigen und die für die
  173. Initialisierung des Contextes und die Nachbearbeitung verwendet werden können.
  174. </para>
  175. <para>Initialisierungs Callbacks treten auf wenn der Kontext durch
  176. <code>ContextSwitch</code> erkannt wird. Sie können verwendet werden um spezielle
  177. Logik auszuführen die stattfinden soll. Als Beispiel verwendet der JSON Kontext
  178. einen Callback um den ViewRenderer auszuschalten wenn auto-JSON Serialisierung
  179. eingeschaltet ist.</para>
  180. <para>Nachbearbeitung tritt wärend der <code>postDispatch()</code> Routine der
  181. Aktion auf, und kann verwendet werden um spezielle Logik auszuführen. Als Beispiel
  182. verwendet der JSON Kontext einen Callback um festzustellen ob auto-JSON
  183. Serialisierung eingeschaltet ist; wenn dem so ist, serialisiert es die View
  184. Variablen zu JSON und sendet die Antwort, aber wenn dem nicht so ist, schaltet es
  185. den ViewRenderer wieder ein.</para>
  186. </listitem>
  187. </itemizedlist>
  188. <para>
  189. Es gibt eine Vielzahl an Methoden für die Interaktion mit Kontexten:
  190. </para>
  191. <itemizedlist>
  192. <listitem><para>
  193. <code>addContext($context, array $spec)</code>: Fügt einen neuen Kontext hinzu.
  194. Wirft eine Ausnahme wenn der Kontext bereits existiert.
  195. </para></listitem>
  196. <listitem><para>
  197. <code>setContext($context, array $spec)</code>: Fügt einen neuen Kontext hinzu oder
  198. überschreibt einen bestehenden Kontext. Verwendet die gleiche Spezifikation wie
  199. <code>addContext()</code>.
  200. </para></listitem>
  201. <listitem><para>
  202. <code>addContexts(array $contexts)</code>: Fügt viele Kontexte auf einmal hinzu.
  203. Das <code>$contexts</code> Array sollte ein Array von Kontext/Spezifikation Paaren
  204. sein. Wenn einer der Kontexte bereits existiert, wird eine Ausnahme geworfen.
  205. </para></listitem>
  206. <listitem><para>
  207. <code>setContexts(array $contexts)</code>: Fügt neue Kontexte hinzu und
  208. überschreibt bestehende. Verwendet die gleiche Spezifikation wie
  209. <code>addContexts()</code>.
  210. </para></listitem>
  211. <listitem><para>
  212. <code>hasContext($context)</code>: Gibt true zurück wenn der Kontext existiert,
  213. andernfalls false.
  214. </para></listitem>
  215. <listitem><para>
  216. <code>getContext($context)</code>: Empfängt einen einzelnen Kontext
  217. durch den Namen. Gibt ein Array zurück das der Spezifikation folgt die in
  218. <code>addContext()</code> verwendet wird.
  219. </para></listitem>
  220. <listitem><para>
  221. <code>getContexts()</code>: Empfängt alle Kontexte. Gibt ein Array von
  222. Kontext/Spezifikation Paaren zurück.
  223. </para></listitem>
  224. <listitem><para>
  225. <code>removeContext($context)</code>: Entfernt einen einzelnen Kontext durch seinen
  226. Namen. Gibt im Erfolgsfall true zurück, und false wenn der Kontext nicht gefunden
  227. wurde.
  228. </para></listitem>
  229. <listitem><para>
  230. <code>clearContexts()</code>: Entfernt alle Kontexte.
  231. </para></listitem>
  232. </itemizedlist>
  233. </sect4>
  234. <sect4 id="zend.controller.actionhelpers.contextswitch.actions">
  235. <title>Kontexte per Aktion setzen</title>
  236. <para>
  237. Es gibt zwei Mechanismen für das Setzen vorhandener Kontexte. Es kann entweder manuell
  238. ein Array im Kontroller erstellt werden, oder es können verschiedene Methoden in
  239. <code>ContextSwitch</code> verwendet werden um Sie zu bauen.
  240. </para>
  241. <para>
  242. Die prinzipielle Methode für das Hinzufügen von Aktion/Kontext Relationen ist
  243. <code>addActionContext()</code>. Sie erwartet zwei Argumente, die Aktion zu der der
  244. Kontext hinzugefügt werden soll, und entweder den Namen des Kontextes oder ein Array
  245. von Kontexten. Als Beispiel nehmen wir die folgende Controller Klasse an:
  246. </para>
  247. <programlisting language="php"><![CDATA[
  248. class FooController extends Zend_Controller_Action
  249. {
  250. public function listAction()
  251. {
  252. }
  253. public function viewAction()
  254. {
  255. }
  256. public function commentsAction()
  257. {
  258. }
  259. public function updateAction()
  260. {
  261. }
  262. }
  263. ]]></programlisting>
  264. <para>
  265. Angenommen wir sollen einen XML Kontext zu der 'list' Aktion hinzufügen, und XML und
  266. JSON Kontexte zu der 'comments' Aktion. Wir können das in der <code>init()</code>
  267. Methode machen:
  268. </para>
  269. <programlisting language="php"><![CDATA[
  270. class FooController extends Zend_Controller_Action
  271. {
  272. public function init()
  273. {
  274. $this->_helper->contextSwitch()
  275. ->addActionContext('list', 'xml')
  276. ->addActionContext('comments', array('xml', 'json'))
  277. ->initContext();
  278. }
  279. }
  280. ]]></programlisting>
  281. <para>
  282. Alternativ kann einfach die Array-Eigenschaft <code>$contexts</code> definiert werden:
  283. </para>
  284. <programlisting language="php"><![CDATA[
  285. class FooController extends Zend_Controller_Action
  286. {
  287. public $contexts = array(
  288. 'list' => array('xml'),
  289. 'comments' => array('xml', 'json')
  290. );
  291. public function init()
  292. {
  293. $this->_helper->contextSwitch()->initContext();
  294. }
  295. }
  296. ]]></programlisting>
  297. <para>
  298. Das obige ist weniger Overhead, aber enthält auch potentielle Fehler.
  299. </para>
  300. <para>
  301. Die folgenden Methoden können verwendet werden um die Kontext-Mappings zu erstellen:
  302. </para>
  303. <itemizedlist>
  304. <listitem>
  305. <para>
  306. <code>addActionContext($action, $context)</code>: markiert einen oder mehrere
  307. Kontexte als in einer Aktion vorhanden. Wenn bereits Mapping existieren wird
  308. einfach bei diesen Mappings angehängt. <code>$context</code> kann ein einzelner
  309. Kontext sein, oder ein Array von Kontexten.
  310. </para>
  311. <para>
  312. Ein Wert von <code>true</code> für den Kontext markiert alle vorhandenen
  313. Kontexte als vorhanden für die Aktion.
  314. </para>
  315. <para>
  316. Ein leerer Wert für $context deaktiviert alle Kontexte für die gegebene Aktion.
  317. </para>
  318. </listitem>
  319. <listitem><para>
  320. <code>setActionContext($action, $context)</code>: markiert einen oder mehrere
  321. Kontexte als in einer Aktion vorhanden. Wenn bereits Mappings existieren werden
  322. Sie mit den spezifizierten ersetzt. <code>$context</code> kann ein einzelner
  323. Kontext sein, oder ein Array von Kontexten.
  324. </para></listitem>
  325. <listitem><para>
  326. <code>addActionContexts(array $contexts)</code>: fügt mehrere Aktion/Kontext
  327. Paare auf einmal hinzu. <code>$contexts</code> sollte ein assoziatives Array
  328. von Aktion/Kontext Paaren sein. Es entspricht <code>addActionContext()</code>,
  329. was bedeutet das wenn eine Paarung bereits existiert, diese hinzugefügt wird.
  330. </para></listitem>
  331. <listitem><para>
  332. <code>setActionContexts(array $contexts)</code>: fungiert wie
  333. <code>addActionContexts()</code>, überschreibt aber bestehende Aktion/Kontext
  334. Paare.
  335. </para></listitem>
  336. <listitem><para>
  337. <code>hasActionContext($action, $context)</code>: ermittelt ob eine spezielle
  338. Aktion einen gegebenen Kontext hat.
  339. </para></listitem>
  340. <listitem><para>
  341. <code>getActionContexts($action = null)</code>: gibt entweder alle Kontexte
  342. für eine gegebene Aktion zurück, oder alle Aktion/Kontext Paare.
  343. </para></listitem>
  344. <listitem><para>
  345. <code>removeActionContext($action, $context)</code>: entfernt ein oder mehrere
  346. Kontexte von einer gegebenen Aktion. <code>$context</code> kann ein einzelner
  347. Kontext sein, oder ein Array von Kontexten.
  348. </para></listitem>
  349. <listitem><para>
  350. <code>clearActionContexts($action = null)</code>: entfernt alle Kontexte von
  351. einer gegebenen Aktion, oder von allen Aktionen mit Kontexten.
  352. </para></listitem>
  353. </itemizedlist>
  354. </sect4>
  355. <sect4 id="zend.controller.actionhelpers.contextswitch.initcontext">
  356. <title>Kontext Switching initialisieren</title>
  357. <para>
  358. Um Kontext Switching zu initialisieren, muß <code>initContext()</code> im Action
  359. Controller aufgerufen werden:
  360. </para>
  361. <programlisting language="php"><![CDATA[
  362. class NewsController extends Zend_Controller_Action
  363. {
  364. public function init()
  365. {
  366. $this->_helper->contextSwitch()->initContext();
  367. }
  368. }
  369. ]]></programlisting>
  370. <para>
  371. In einigen Fällen, will man einen Kontext erzwingen der verwendet werden soll; zum
  372. Beispiel wenn man nur den XML Kontext erlauben will wenn Kontext Switching aktiviert
  373. ist. Das kann durch die Übergaben des Kontextes zu <code>initContext()</code> getan
  374. werden:
  375. </para>
  376. <programlisting language="php"><![CDATA[
  377. $contextSwitch->initContext('xml');
  378. ]]></programlisting>
  379. </sect4>
  380. <sect4 id="zend.controller.actionhelpers.contextswitch.misc">
  381. <title>Zusätzliche Funktionalitäten</title>
  382. <para>
  383. Eine Vielzahl an Methoden kann verwendet werden um das Verhalten des
  384. <code>ContextSwitch</code> Helfers zu verändern. Diese sind:
  385. </para>
  386. <itemizedlist>
  387. <listitem>
  388. <para>
  389. <code>setAutoJsonSerialization($flag)</code>: Standardmäßig serialisieren JSON
  390. Kontexte alle View Variablen in die JSON Notierung und geben diese als Antwort
  391. zurück. Wenn man seine eigene Antwort erstellen will, sollte das ausgeschaltet
  392. werden; das muß vor dem Aufruf von <code>initContext()</code> geschehen.
  393. </para>
  394. <programlisting language="php"><![CDATA[
  395. $contextSwitch->setAutoJsonSerialization(false);
  396. $contextSwitch->initContext();
  397. ]]></programlisting>
  398. <para>
  399. Der Wert des Flags erhält man mit <code>getAutoJsonSerialization()</code>.
  400. </para>
  401. </listitem>
  402. <listitem>
  403. <para>
  404. <code>setSuffix($context, $suffix, $prependViewRendererSuffix)</code>: Mit
  405. dieser Methode kann ein anderer Suffix spezifiziert werden der für einen
  406. gegebenen Kontext verwendet werden soll. Das dritte Argument wird verwendet um
  407. anzuzeigen ob der aktuelle Suffix des ViewRenderers dem neuen Suffix
  408. vorangestellt werden soll oder nicht; dieses Flag ist standardmäßig aktiviert.
  409. </para>
  410. <para>
  411. Die Übergabe eines leeren Werte an den Suffix führt dazu das nur der Suffix des
  412. ViewRenderers verwendet wird.
  413. </para>
  414. </listitem>
  415. <listitem>
  416. <para>
  417. <code>addHeader($context, $header, $content)</code>: Fügt einen Antwort Header
  418. für einen gegebenen Kontext hinzu. <code>$header</code> ist der Headername, und
  419. <code>$content</code> ist der Wert der an diesen Header übergeben werden soll.
  420. </para>
  421. <para>
  422. Jeder Kontxt kann mehrere Header haben; <code>addHeader()</code> fügt
  423. zusätzliche Header in den Header Stack des Kontextes ein.
  424. </para>
  425. <para>
  426. Wenn der spezifizierte <code>$header</code> bereits für diesen Kontext
  427. existiert, wird eine Ausnahme geworfen.
  428. </para>
  429. </listitem>
  430. <listitem>
  431. <para>
  432. <code>setHeader($context, $header, $content)</code>: <code>setHeader()</code>
  433. funktioniert wie <code>addHeader()</code>, ausser das sie erlaubt das
  434. existierende Kontext Header überschrieben werden.
  435. </para>
  436. </listitem>
  437. <listitem>
  438. <para>
  439. <code>addHeaders($context, array $headers)</code>: Fügt einen gegebenen Kontext
  440. mehrere Header auf einmal hinzu. Entspricht <code>addHeader()</code>, was
  441. bedeutet das eine Ausnahme geworfen wird wenn der Header bereits existiert.
  442. <code>$headers</code> ist ein Array von Header/Kontext Paaren.
  443. </para>
  444. </listitem>
  445. <listitem>
  446. <para>
  447. <code>setHeaders($context, array $headers.)</code>: Wie
  448. <code>addHeaders()</code>, nur das es <code>setHeader()</code> entspricht und
  449. damit das Überschreiben existierender Header erlaubt.
  450. </para>
  451. </listitem>
  452. <listitem>
  453. <para>
  454. <code>getHeader($context, $header)</code>: Enpfängt den Wert eines Headers für
  455. einen gegebenen Kontext. Gibt null zurück wenn dieser nicht gefunden wird.
  456. </para>
  457. </listitem>
  458. <listitem>
  459. <para>
  460. <code>removeHeader($context, $header)</code>: Entfernt einen einzelnen Header
  461. für einen gegebenen Kontext.
  462. </para>
  463. </listitem>
  464. <listitem>
  465. <para>
  466. <code>clearHeaders($context, $header)</code>: Entfernt alle Header für einen
  467. gegebenen Kontext.
  468. </para>
  469. </listitem>
  470. <listitem>
  471. <para>
  472. <code>setCallback($context, $trigger, $callback)</code>: Setzt einen Callback
  473. bei einem gegebenen Trigger für einen gegebenen Kontext. Trigger können
  474. entweder 'init' oder 'post' sein (was zeigt das der Callback entweder bei der
  475. Initialisierung oder der Nachbearbeitung aufgerufen wird).
  476. <code>$callback</code> sollte ein gültiger PHP Callback sein.
  477. </para>
  478. </listitem>
  479. <listitem>
  480. <para>
  481. <code>setCallbacks($context, array $callbacks)</code>: Setzt mehrere Callbacks
  482. für einen gegebenen Kontext. <code>$callbacks</code> sollte ein
  483. Trigger/Callback Paar sein. Aktuell sind die meisten Callbacks die registriert
  484. werden können zwei, einer für Initialisierung und einer für die
  485. Nachbearbeitung.
  486. </para>
  487. </listitem>
  488. <listitem>
  489. <para>
  490. <code>getCallback($context, $trigger)</code>: Empfängt einen Callback für einen
  491. gegebenen Trigger in einem gegebenen Kontext.
  492. </para>
  493. </listitem>
  494. <listitem>
  495. <para>
  496. <code>getCallbacks($context)</code>: Empfängt alle Callbacks für einen gegebenen
  497. Kontext. Gibt ein Array von Trigger/Callback Paaren zurück.
  498. </para>
  499. </listitem>
  500. <listitem>
  501. <para>
  502. <code>removeCallback($context, $trigger)</code>: Entfernt einen Callback für
  503. einen gegebenen Trigger und Kontext.
  504. </para>
  505. </listitem>
  506. <listitem>
  507. <para>
  508. <code>clearCallbacks($context)</code>: Entfernt alle Callbacks für einen
  509. gegebenen Kontext.
  510. </para>
  511. </listitem>
  512. <listitem>
  513. <para>
  514. <code>setContextParam($name)</code>: Setzt den Anfrageparameter der geprüft
  515. werden muß um zu entscheiden ob eine Kontextumschaltung angefragt wurde oder
  516. nicht. Der Wert ist standardmäßig 'format', aber dieser Zugriffspunkt kann
  517. verwendet werden um einen alternativen wert zu setzen.
  518. </para>
  519. <para>
  520. <code>getContextParam()</code> kann verwendet werden um den aktuellen Wert zu
  521. erhalten.
  522. </para>
  523. </listitem>
  524. <listitem>
  525. <para>
  526. <code>setAutoDisableLayout($flag)</code>: Standardmäßig sind Layouts
  527. ausgeschaltet wenn eine Kontextumschaltung erfolgt; das ist weil Layouts
  528. typischerweise dafür verwendet werden um normale Antworten darzustellen, und
  529. Sie in alternativen Kontexten keine Bedeutung haben. Wenn man trotzdem Layouts
  530. verwenden will (möglicherweise hat man ein Layout für einen neuen Kontext),
  531. kann dieses Verhalten mit der Übergabe eines false Wertes an
  532. <code>setAutoDisableLayout()</code> geändert werden. Das sollte aber
  533. <emphasis>before</emphasis> dem Aufruf von <code>initContext()</code>
  534. geschehen.
  535. </para>
  536. <para>
  537. Um den Wert dieses Flags zu erhalten, kann der Zugriffspunkt
  538. <code>getAutoDisableLayout()</code> verwendet werden.
  539. </para>
  540. </listitem>
  541. <listitem>
  542. <para>
  543. <code>getCurrentContext()</code> kann verwendet werden um festzustellen welcher
  544. Kontext erkannt wurde, wenn überhaupt. Er gibt null zurück wenn keine
  545. Kontextumschaltung stattgefunden hat, oder wenn er aufgerufen wurde bevor
  546. <code>initContext()</code> stattgefunden hat.
  547. </para>
  548. </listitem>
  549. </itemizedlist>
  550. </sect4>
  551. <sect4 id="zend.controller.actionhelpers.contextswitch.ajaxcontext">
  552. <title>AjaxContext Funktionalität</title>
  553. <para>
  554. Der <code>AjaxContext</code> Helfer erweitert <code>ContextSwitch</code>, sodas alle
  555. für <code>ContextSwitch</code> gelisteten Funktionalitäten in Ihm vorhanden sind. Es
  556. gibt trotzdem ein paar wichtige Änderungen.
  557. </para>
  558. <para>
  559. Zuerst, verwendet es eine andere Action Kontroller Eigenschaft<code>$ajaxable</code>
  560. um Kontexte festzustellen. Damit kann man verschiedene Kontexte verwenden für AJAX
  561. gegenüber normalen HTTP Anfragen. Die verschiedenen <code>*ActionContext*()</code>
  562. Methoden von <code>AjaxContext</code> schreiben in diese Eigenschaft.
  563. </para>
  564. <para>
  565. Zweitens, wird nur dann getriggert wenn ein XmlHttpRequest stattgefunden hat, was durch
  566. die <code>isXmlHttpRequest()</code> Methode den Anfrageobjektes festgestellt wird.
  567. Deshalb wird, wenn der Kontextparameter ('format') in der Anfrage übergeben wird, aber
  568. die anfrage nicht als XmlHttpRequest gemacht wurde, keine Kontextumschaltung
  569. getriggert.
  570. </para>
  571. <para>
  572. Drittens, fügr der <code>AjaxContext</code> einen zusätzlichen, HTML, Kontext hinzu. In
  573. diesem Kontext setzt er den Suffix auf 'ajax.phtml' um diesen Kontext von einer
  574. normalen Anfrage zu unterscheiden. Es werden keine zusätzlichen Header zurückgegeben.
  575. </para>
  576. <example id="zend.controller.actionhelpers.contextswitch.ajaxcontext.example">
  577. <title>Aktionen erlauben auf Ajax Anfragen zu antworten</title>
  578. <para>
  579. In dem folgenden Beispiel erlauben wir Anfragen auf die Aktionen 'view', 'form' und
  580. 'process' auf AJAX Anfragen zu antworten. In den ersten zwei Fällen, 'view' und
  581. 'form' wird ein HTML Teilstück zurückgegeben mit dem die Seite aktualisiert werden
  582. soll; im letzteren wird JSON zurückgegeben.
  583. </para>
  584. <programlisting language="php"><![CDATA[
  585. class CommentController extends Zend_Controller_Action
  586. {
  587. public function init()
  588. {
  589. $ajaxContext = $this->_helper->getHelper('AjaxContext');
  590. $ajaxContext->addActionContext('view', 'html')
  591. ->addActionContext('form', 'html')
  592. ->addActionContext('process', 'json')
  593. ->initContext();
  594. }
  595. public function viewAction()
  596. {
  597. // Ein einzelnes Kommentar holen um es anzuzeigen.
  598. // Wenn AjaxContext erkannt wurde, verwendet es das
  599. // comment/view.ajax.phtml View Skript.
  600. }
  601. public function formAction()
  602. {
  603. // Stellt die "add new comment" Form dar.
  604. // Wenn AjaxContext erkannt wurde, verwendes es das
  605. // comment/form.ajax.phtml View Skript.
  606. }
  607. public function processAction()
  608. {
  609. // Bearbeitet einen neuen Kommentar
  610. // Gibt das Ergebnis als JSON zurück; fügt die Ergebnisse einfach als
  611. // View Variablen hinzu, und JSON wird zurückgegeben.
  612. }
  613. }
  614. ]]></programlisting>
  615. <para>
  616. Auf der Seite des Clients, wird die JAX Bibliothe einfach die Endpunkte
  617. '/comment/view', '/comment/form', und '/comment/process' anfragen, und den
  618. 'format' Parameter übergeben: '/comment/view/format/html',
  619. '/comment/form/format/html', '/comment/process/format/json'. (Oder der Parameter
  620. kann über GET übergeben werden: z.B. , "?format=json".)
  621. </para>
  622. <para>
  623. Angenommen die Bibliothek übergibt den 'X-Requested-With: XmlHttpRequest'
  624. Header, dann werden diese Aktionen das richtige Antwortformat zurückgeben.
  625. </para>
  626. </example>
  627. </sect4>
  628. </sect3>
  629. <!--
  630. vim:se ts=4 sw=4 et:
  631. -->