Zend_Controller-ActionHelpers-ContextSwitch.xml 30 KB

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