Zend_Controller-ActionHelpers-ContextSwitch.xml 29 KB

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