{"id":191,"date":"2009-11-10T01:15:31","date_gmt":"2009-11-10T00:15:31","guid":{"rendered":"http:\/\/webpiraten.de\/?p=191"},"modified":"2009-11-10T01:15:31","modified_gmt":"2009-11-10T00:15:31","slug":"eigene-configs-in-agavi-nutze","status":"publish","type":"post","link":"https:\/\/webpiraten.de\/index.php\/frameworks\/eigene-configs-in-agavi-nutze\/","title":{"rendered":"Eigene Configs in Agavi nutzen"},"content":{"rendered":"

F\u00fcr diverse Aufgaben in gr\u00f6\u00dferen Projekten ist es notwendig, eigene XML-Konfigurationsdateien zu nutzen. Die Definition umfangreicher Einstellungen in der settings.xml wird schnell anstrengend und das Holen der Werte per AgaviConfig::get('setting.name', 'default');<\/code> un\u00fcbersichtlich. Agavi bietet es aber an, eigene Konfigurationsdateien zu erstellen und diese nicht nur zu validieren, sondern auch zur Wiederverwendung zu cachen.
\nIn der Agavi FAQ<\/a> habe ich dazu mal ein Beispiel verfasst.<\/p>\n

Einfach einen Config-Handler in der config_handlers.xml<\/code> definieren:<\/p>\n

\r\n<handler pattern="%core.config_dir%\/project\/foo\/*.xml" class="AgaviReturnArrayConfigHandler" \/>\r\n<\/pre>\n
und dann direkt in den Actions, Views und Models benutzen:<\/p>\n
\r\nif (!isset($config['baz']))\r\n{\r\n    throw new LogicException('baz is missing!');\r\n}\r\n\r\nif (isset($config['bars']))\r\n{\r\n    foreach ($config['bars'] as $foo => $data)\r\n    {\r\n        $this->doSomethingWithEach($foo, $data);\r\n    }\r\n}\r\n<\/pre>\n
Die XML-Datei f\u00fcr den obigen Code k\u00f6nnte beispielweise so aussehen:<\/p>\n
\r\n<ae:configurations>\r\n    <ae:configuration>\r\n        <baz>asdf<\/baz>\r\n        <foo>-1<\/foo>\r\n        <bars>\r\n            <some>...more data and xml...<\/some>\r\n            <more>...more data and xml...<\/more>\r\n            <deep>...more data and xml...<\/deep>\r\n            <structs>...more data and xml...<\/structs>\r\n        <\/bars>\r\n    <\/ae:configuration>\r\n    <ae:configuration environment="production.*">\r\n        <baz>bleh<\/baz>\r\n        <foo>1<\/foo>\r\n    <\/ae:configuration>\r\n<\/ae:configurations>\r\n<\/pre>\n
Gut zu erkennen ist der Vorteil eigener Configs: Man kann die Agavi-Features f\u00fcr Konfigurationsdateien nutzen und auf einfache Art und Weise environmentspezifische Einstellungen vornehmen (z.B. in „Production“ andere Werte f\u00fcr Logdateien, URLs oder Einstellungen nutzen als w\u00e4hrend der Entwicklung oder beim Testen).<\/p>\n
Ebenfalls gut zu erkennen im PHP-Code ist, dass man lauter Abfragen \u00fcber die Existenz bestimmer Elemente macht, die man sich mit vern\u00fcnftiger Validierung sparen kann, da invalide XML-Dokumente gar nicht erst als korrekt angesehen werden von Agavi. Um seine XML-Strukturen zu validieren definiert man per validation<\/code> Parameter ein XML-Schema und definiert noch gleich einen eigenen ConfigHandler, den man schreibt und per autoload.xml<\/code> bekannt macht:<\/p>\n
\r\n<handler pattern="%core.config_dir%\/project\/foo\/*.foo.xml" class="FooDefinitionConfigHandler">\r\n    <validation>%core.config_dir%\/xsd\/foo_definition.xsd<\/validation\/>\r\n<\/handler>\r\n<\/pre>\n
Der ConfigHandler k\u00f6nnte so beginnen:<\/p>\n
\r\nclass FooDefinitionConfigHandler extends AgaviXmlConfigHandler\r\n{\r\n    \/\/ notwendige Methoden implementieren und XML-Struktur validieren...\r\n}\r\n<\/pre>\n
F\u00fcr Beispiele einfach in die in Agavi verwendeten XSDs und entsprechende ConfigHandler sehen. Viel Spa\u00df. :)<\/p>\n","protected":false},"excerpt":{"rendered":"
Eigene XML-Konfigurationsdateien mit Agavi definieren, validieren und verwenden. Eine kurze Einf\u00fchrung mit Beispielnutzung des AgaviReturnArrayConfigHandler.<\/p>\n","protected":false},"author":2,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[27,3,5,79],"tags":[8,116,115,119,117,648,118],"class_list":["post-191","post","type-post","status-publish","format-standard","hentry","category-agavi-framework","category-frameworks","category-php","category-xml","tag-agavi","tag-confighandler","tag-konfiguration","tag-schema","tag-validierung","tag-xml","tag-xsd"],"_links":{"self":[{"href":"https:\/\/webpiraten.de\/index.php\/wp-json\/wp\/v2\/posts\/191","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/webpiraten.de\/index.php\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/webpiraten.de\/index.php\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/webpiraten.de\/index.php\/wp-json\/wp\/v2\/users\/2"}],"replies":[{"embeddable":true,"href":"https:\/\/webpiraten.de\/index.php\/wp-json\/wp\/v2\/comments?post=191"}],"version-history":[{"count":6,"href":"https:\/\/webpiraten.de\/index.php\/wp-json\/wp\/v2\/posts\/191\/revisions"}],"predecessor-version":[{"id":197,"href":"https:\/\/webpiraten.de\/index.php\/wp-json\/wp\/v2\/posts\/191\/revisions\/197"}],"wp:attachment":[{"href":"https:\/\/webpiraten.de\/index.php\/wp-json\/wp\/v2\/media?parent=191"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/webpiraten.de\/index.php\/wp-json\/wp\/v2\/categories?post=191"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/webpiraten.de\/index.php\/wp-json\/wp\/v2\/tags?post=191"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}