{"id":1094,"date":"2018-04-05T16:19:00","date_gmt":"2018-04-05T14:19:00","guid":{"rendered":"http:\/\/evileu.de\/zum-schwarzen-pinguin\/?p=1094"},"modified":"2018-04-05T16:54:12","modified_gmt":"2018-04-05T14:54:12","slug":"joomla-modul-ein-bisschen-aufgebohrt-mit-benutzereingaben","status":"publish","type":"post","link":"https:\/\/evileu.de\/zum-schwarzen-pinguin\/2018\/04\/05\/joomla-modul-ein-bisschen-aufgebohrt-mit-benutzereingaben\/","title":{"rendered":"Joomla-Modul ein bisschen aufgebohrt – mit Benutzereingaben"},"content":{"rendered":"

Ich hab ja in diesem Artikel <\/a>ein WordPress-Widget erstellt, das die Gesamtzahl der ver\u00f6ffentlichten Rezepte sowie die Anzahl der Rezepte einer frei w\u00e4hlbaren Kategorie anzeigt. So nach dem Muster:<\/p>\n

312 Rezepte insgesamt<\/h3>\n

46 davon Vegetarisch<\/h3>\n

Ob das mit unserem Joomla-Modul auch hinzukriegen ist?<\/p>\n

Anzahl der Beitr\u00e4ge der Kategorie Rezepte<\/h2>\n

Meine Rezeptkategorie hat die ID 8, das kann man in der Tabelle #__categories nachschauen. Dazu hab ich folgendes Code Snippet gefunden:<\/p>\n

$model = JModelLegacy::getInstance('Articles', 'ContentModel');\r\n\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0$model->setState('filter.category_id', 8); \/\/ Set category ID here\r\n\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0$articles = $model->getItems();\r\n\r\n\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0$num_articles = count($articles); \/\/ Returns the number of articles in category<\/pre>\n
Kommt mir ein bisschen arg umst\u00e4ndlich vor, aber wenns funktioniert…<\/p>\n
Ich m\u00f6chte jetzt aber nat\u00fcrlich ausw\u00e4hlen k\u00f6nnen, zu welcher Kategorie die Gesamtzahl der Beitr\u00e4ge ausgegeben werden soll, weil ich in Joomla so sch\u00f6ne M\u00f6glichkeiten habe, \u00fcber die Kategorisierung meine Ausgabe auf der Webseite zu strukturieren. Das hei\u00dft aber, wir brauchen ein Eingabefeld (Dropdown), in dem der Benutzer anw\u00e4hlen kann, welche Kategorie ausgegeben werden soll.<\/p>\n
Eingabefelder f\u00fcr eigene Module in Joomla<\/h2>\n
Sind nicht arg schwer zu realisieren, die Joomla-Doku zu dem Thema ist schon mal recht gut, schaut mal hier rein:<\/p>\n
https:\/\/docs.joomla.org\/J3.x:Creating_a_simple_module\/Adding_Form_Fields<\/a><\/p>\n
Ich machs aber hier nochmal step by step, damit man es auch nachvollziehen kann. Wir setzen auf unser Hallo-Welt Modul aus dem vorigen Beitrag<\/a> auf und erweitern die mod_helloworld.xml, in der kann man ein einfaches Texteingabefeld so erstellen:<\/p>\n
\u00a0<config>\r\n\u00a0\u00a0 \u00a0<fields name=\"params\">\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 <fieldset name=\"basic\">\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 <field name=\"param1<\/span>\" type=\"text<\/span>\" default=\"\" label=\"Bitte Titel eingeben<\/span>\" description=\"\"><\/field>\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 <\/fieldset>\r\n\u00a0\u00a0\u00a0 <\/fields>\r\n\u00a0\u00a0\u00a0 <\/config><\/pre>\n
Die Felddefinition muss innerhalb der config-Tags stehen. Wenn man sich jetzt mal das Modul aschaut, m\u00fcsste das Feld eigentlich schon da sein:<\/p>\n
\"texteingabefeld\"
texteingabefeld<\/p><\/div>\n
Wie kommt man jetzt an den Inhalt des Feldes ran, den unser Benutzer eiingegeben hat? Das passiert in der mod_helloworld.php, und zwar so:<\/p>\n
$variable = $params->get('param1<\/span>');\r\n\r\n<\/pre>\n
Die $variable kann man jetzt an die helper-Klasse \u00fcbergeben:<\/p>\n
$hello = modHelloWorldHelper::getHello($variable<\/span>);<\/pre>\n
Und da kann man dann damit weiterarbeiten. Bevor ich da noch weiter darauf eingehe, erstmal:<\/p>\n
Die Anforderungen<\/h2>\n
Den Titel des Moduls kann der Anwender beim Erstellen unter Erweiterungen->Module->neu->Mein Hallo-Welt Modul selber eingeben, den fragen wir nicht nochmal extra ab. Daf\u00fcr brauchen wir aber ein Dropdown-Feld, in dem die Kategorie (z.B. „Rezepte“) ausgew\u00e4hlt werden kann, f\u00fcr die die Gesamtzahl der Beitr\u00e4ge ausgegeben soll. Und wir brauchen noch ein zweites Dropdownfeld f\u00fcr das „featured tag“ (z.B. „Vegetarisch“, aber dazu kommen wir sp\u00e4ter. Jetzt werfen wir erstmal einen Blick auf:<\/p>\n
Die vordefinierten Form Field Types<\/h2>\n
Da bietet Joomla etwas wirklich praktisches an, es gibt eine ganz Latte von vordefinierten Formularfeldern, hier die Doku dazu: https:\/\/docs.joomla.org\/Standard_form_field_types<\/a><\/p>\n
Da klemmen wir uns gleich mal den Formularfeldtyp „Kategorie<\/a>„, der macht n\u00e4mlich genau das was wir brauchen. In der XML-Datei sieht das so aus:<\/p>\n
<field name=\"mycategory<\/span>\" type=\"category\" extension=\"com_content\" label=\"Eine Kategorie ausw\u00e4hlen\" description=\"\" \/><\/pre>\n
In der mod_helloworld.php holen wir uns den Inhalt mit:<\/p>\n
$kat = $params->get('mycategory');<\/pre>\n
Und im Modul-Backend kriegen wir unsere Dropdown-Liste mit den Kategorien:<\/p>\n
\"dropdown_kategorien\"
dropdown_kategorien<\/p><\/div>\n
In der \u00fcbergebenen Variablen steckt \u00fcbrigens die numerische ID der Kategorie Rezepte, die k\u00f6nnen wir gleich direkt weiterverwerten, und zwar in der helper.php:<\/p>\n
public static function getHello($params)\r\n\u00a0\u00a0\u00a0 {\r\n\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0$model = JModelLegacy::getInstance('Articles', 'ContentModel');\r\n\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0$model->setState('filter.category_id', $params<\/span>); \/\/ Set category ID here\r\n\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0$articles = $model->getItems();\r\n\r\n\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0$num_articles = count($articles); \/\/ Returns the number of articles in category\r\n\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0\r\n\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0echo \"Insgesamt \".$num_articles.\" Rezepte<br>\";\u00a0\u00a0 \u00a0\r\n\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0\r\n\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0\r\n\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0\r\n\u00a0\u00a0\u00a0 }<\/pre>\n
Voraussetzung daf\u00fcr ist nat\u00fcrlich, dass wir sie in der mod_helloworld.php auch als Parameter an die Helper-Klasse \u00fcbergeben haben, aber dazu gleich mehr, zuerst schauen wir uns mal die Ausgabe an:<\/p>\n
\"insgesamt_rezepte\"
insgesamt_rezepte<\/p><\/div>\n
Das pa\u00dft soweit, jetzt m\u00fcssen wir nur noch den Ausgabetext dynamisch anpassen, es kann ja auch jemand die Kategorie „Kochb\u00fccher“ angew\u00e4hlt haben, dann darf da nicht „Rezepte“ stehen. Das machen wir so:<\/p>\n
\/\/Name der Kategorie zur ID holen\r\n\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0$db = JFactory::getDbo();\r\n\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0$db->setQuery(\"SELECT cat.title FROM #__categories cat WHERE cat.id='\".$params->kat.\"<\/span>'\"); \r\n\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0$category_title = $db->loadResult();\r\n\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0\r\n\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0echo \"Insgesamt \".$num_articles.\" \".$category_title.\"<br>\";<\/pre>\n
Nicht dran st\u00f6ren dass hier „.$params->kat.“ steht, das kommt daher, dass ich ein Array von Parametern \u00fcbergeben habe, mehr dazu gleich. Jedenfalls wird jetzt auch der richtige Kategoriename angezeigt:<\/span>
\n<\/span><\/p>\n
\"2kochbuecher\"
2kochbuecher<\/p><\/div>\n
Mehr als ein Formularfeld, mehrere Parameter zum \u00dcbergeben<\/h2>\n
Wir brauchen aber noch ein zweites Formularfeld f\u00fcr die Tags, und dazu werfen wir einen kurzen Blick darauf, wie wir mehr als eine Variable an die Helper-Klasse \u00fcbergeben k\u00f6nnen. Kurze Erinnerung, wie die zwei Felddefinitionen in der XML-Datei aussehen:<\/p>\n
<fields name=\"params\">\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 <fieldset name=\"basic\">\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 <field name=\"param1<\/span>\" type=\"text\" default=\"\" label=\"Bitte Text eingeben\" description=\"\"><\/field>\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 \u00a0\r\n\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0\r\n\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0<field name=\"mycategory<\/span>\" type=\"category\" extension=\"com_content\" label=\"Eine Kategorie ausw\u00e4hlen\" description=\"\" \/>\r\n\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 <\/fieldset>\r\n\u00a0\u00a0\u00a0 <\/fields><\/pre>\n
Die Inhalte der Felder holen wir uns in der mod_helloworld.php \u00fcber die Feldnamen:<\/p>\n
$kat = $params->get('mycategory');\r\n$variable = $params->get('param1');<\/pre>\n
Dann packen wir sie in ein Standardobjekt und \u00fcbergeben dieses an die Helper-Klasse:<\/p>\n
$data = new stdClass();\r\n\/\/Objekt f\u00fcllen\r\n$data->kat = $kat<\/span>;\r\n$data->variable = $variable<\/span>;\r\n\r\n\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0\r\n$hello = modHelloWorldHelper::getHello($data<\/span>);\r\n\r\n<\/pre>\n
In der helper.php holen wir uns die \u00fcbergebenen Variablen, die ja in unserem Objekt stecken, mit ihrem Namen, also z.B. $params->kat. Das $params stammt aus der Funktionsdefinition der public static function getHello($params<\/strong>)) <\/em>wer da etwas anderes stehen hat, muss das entsprechend anpassen. Hier nochmal die komplette function: <\/span><\/span><\/p>\n
public static function getHello($params)\r\n\u00a0\u00a0\u00a0 {\r\n\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0\/\/Anzahl der Artikel zur \u00fcbergebenen Kategorie-ID holen\r\n\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0$model = JModelLegacy::getInstance('Articles', 'ContentModel');\r\n\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0$model->setState('filter.category_id', $params->kat); \/\/ Set category ID here\r\n\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0$articles = $model->getItems();\r\n\r\n\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0$num_articles = count($articles); \/\/ Returns the number of articles in category\r\n\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0\r\n\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0\/\/Name der Kategorie zur ID holen\r\n\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0$db = JFactory::getDbo();\r\n\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0$db->setQuery(\"SELECT cat.title FROM #__categories cat WHERE cat.id='\".$params->kat.\"'\"); \r\n\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0$category_title = $db->loadResult();\r\n\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0\r\n\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0echo \"Insgesamt \".$num_articles.\" \".$category_title.\"<br>\";\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 \u00a0\r\n\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0\r\n\u00a0\u00a0\u00a0 }<\/pre>\n
Das sieht jetzt schon ziemlich gut aus. Leider habe ich f\u00fcr die Tags keinen vordefinierten Formularfeldtyp gefunden, da m\u00fcssen wir was basteln, aber dazu gibt es einen neuen Beitrag.<\/p>\n","protected":false},"excerpt":{"rendered":"
Ich hab ja in diesem Artikel ein WordPress-Widget erstellt, das die Gesamtzahl der ver\u00f6ffentlichten Rezepte sowie die Anzahl der Rezepte einer frei w\u00e4hlbaren Kategorie anzeigt. So nach dem Muster: 312 Rezepte insgesamt 46 davon Vegetarisch Ob das mit unserem Joomla-Modul auch hinzukriegen ist? Anzahl der Beitr\u00e4ge der Kategorie Rezepte Meine Rezeptkategorie hat die ID 8, […]<\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":[],"categories":[1,28,33],"tags":[],"_links":{"self":[{"href":"https:\/\/evileu.de\/zum-schwarzen-pinguin\/wp-json\/wp\/v2\/posts\/1094"}],"collection":[{"href":"https:\/\/evileu.de\/zum-schwarzen-pinguin\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/evileu.de\/zum-schwarzen-pinguin\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/evileu.de\/zum-schwarzen-pinguin\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/evileu.de\/zum-schwarzen-pinguin\/wp-json\/wp\/v2\/comments?post=1094"}],"version-history":[{"count":4,"href":"https:\/\/evileu.de\/zum-schwarzen-pinguin\/wp-json\/wp\/v2\/posts\/1094\/revisions"}],"predecessor-version":[{"id":1103,"href":"https:\/\/evileu.de\/zum-schwarzen-pinguin\/wp-json\/wp\/v2\/posts\/1094\/revisions\/1103"}],"wp:attachment":[{"href":"https:\/\/evileu.de\/zum-schwarzen-pinguin\/wp-json\/wp\/v2\/media?parent=1094"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/evileu.de\/zum-schwarzen-pinguin\/wp-json\/wp\/v2\/categories?post=1094"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/evileu.de\/zum-schwarzen-pinguin\/wp-json\/wp\/v2\/tags?post=1094"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}