{"id":21330581,"url":"https://github.com/friendsofredaxo/properties","last_synced_at":"2025-07-01T06:32:45.668Z","repository":{"id":65801716,"uuid":"138287287","full_name":"FriendsOfREDAXO/properties","owner":"FriendsOfREDAXO","description":"REDAXO-Properties für Templates und Module","archived":false,"fork":false,"pushed_at":"2024-09-11T06:34:32.000Z","size":49,"stargazers_count":20,"open_issues_count":0,"forks_count":1,"subscribers_count":4,"default_branch":"main","last_synced_at":"2025-04-06T17:22:11.398Z","etag":null,"topics":["backend","developers","frontend","properties","redaxo","redaxo-addon"],"latest_commit_sha":null,"homepage":"","language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/FriendsOfREDAXO.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2018-06-22T10:02:44.000Z","updated_at":"2024-09-11T06:34:36.000Z","dependencies_parsed_at":"2023-08-30T14:37:08.412Z","dependency_job_id":"9c18349b-41b9-4df9-914b-12ea3bafe01a","html_url":"https://github.com/FriendsOfREDAXO/properties","commit_stats":null,"previous_names":[],"tags_count":9,"template":false,"template_full_name":null,"purl":"pkg:github/FriendsOfREDAXO/properties","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/FriendsOfREDAXO%2Fproperties","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/FriendsOfREDAXO%2Fproperties/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/FriendsOfREDAXO%2Fproperties/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/FriendsOfREDAXO%2Fproperties/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/FriendsOfREDAXO","download_url":"https://codeload.github.com/FriendsOfREDAXO/properties/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/FriendsOfREDAXO%2Fproperties/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":262912966,"owners_count":23383610,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["backend","developers","frontend","properties","redaxo","redaxo-addon"],"created_at":"2024-11-21T22:22:18.514Z","updated_at":"2025-07-01T06:32:45.625Z","avatar_url":"https://github.com/FriendsOfREDAXO.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"\n# REDAXO-Properties für Templates und Module\n\nHier können REDAXO-Properties gesetzt werden die man zum Beispiel in Templates, Modulen und AddOns verwenden kann. Die Properties sind im Backend und Frontend verfügbar. Siehe auch https://redaxo.org/doku/master/eigenschaften#set-property.\nUnter dem Menüpunkt **System** können die Properties verwaltet werden (siehe auch `package.yml`).\n\nOft werden in verschiedenen Templates/Modulen die gleichen Einstellungen wie z.B. bestimmte Artikel-Id's, Anzahl Datensätze usw. benötigt. Durch die Verwendung von Properties können diese Einstellungen (einfach und flexibel) **zentral an einer Stelle** gepflegt und dann in Templates/Modulen/AddOns verwendet werden.\n\n\u003e **Hinweis:** Es können nur Properties angelegt werden die noch nicht existieren. So werden Kollisionen mit den Core-Properties vermieden.\n\n## Formatierung\n\nDie Formatierung für die Properties ist angelehnt an die bekannten ini-Dateien und die language-Files von REDAXO-AddOns, und bewusst einfach gehalten.\nDie Properties werden in der AddOn-Konfiguration gespeichert und werden bei einem REDAXO-Export auch exportiert.\n\n**Zeilen-Format**:\n\n`propertyName = propertyInhalt`\noder\n`propertyName=propertyInhalt`\n\n* jede Property-Einstellung in einer Zeile\n* Kommentare beginnen mit '#' am Zeilenanfang\n* Inline-Kommentare mit '#' möglich (ein Leerzeichen vor und nach dem #!)\n* automatisches Type-Casting\n* JSON-Properties möglich\n\n\u003e **Hinweis:** Bereits bestehende REDAXO-Properties oder Properties aus anderen Addons werden nicht überschrieben!\n\n\u003e **Hinweis:** Properties können durch setzen eines frei wählbaren PREFIXes für die eigene Übersicht gruppiert werden.\nZum Beispiel: `PREFIX = my.`\nAlternativ kann auch die Section-Schreibweise (ini-Dateien) verwendet werden.\nZum Beispiel: `[my.]`\n\n## Type-Casting\n\nDie definierten Properties werden automatisch in den entsprechenden Variablen-Typ gecasted.\n\n**Beispiele**\n\n`property = Text` -\u003e (string) Text\n`property = 1` -\u003e (integer) 1\n`property = 1.0` -\u003e (float) 1\n`property = 1,234` -\u003e (float) 1.234\n`property = .123` -\u003e (float) 0.123\n`property = \"asdf\"` -\u003e (string) asdf\n`property = '\"asdf\"'` -\u003e (string) \"asdf\"\n`property = true` -\u003e (boolean) true\n`propery = FALSE` -\u003e (boolean) false\n`property = {\"erstens\": 1, \"zweitens\": 2}` -\u003e array(2) { [\"erstens\"]=\u003e int(1) [\"zweitens\"]=\u003e int(2) }\n\n\u003e **Hinweis:** JSON-Properties müssen im gültigen JSON-Format notiert werden!\n\n## Beispiele für Property-Einstellungen\n\nMit gesetztem PREFIX ...\n\n```ini\n# Einstellungen für den News-Bereich                                  Zugriff im Modul/Template\nPREFIX = news.\nlistLimit = 10       # Anzahl Teaser-Einträge für die Startseite      rex::getProperty('news.listLimit')\ndetailArticle = 123  # Artikel-ID für die News-Anzeige                rex::getProperty('news.detailArticle')\n\n# Diverse Artikel-ID's\nPREFIX = id.\nsearch = 123         # Artikel-ID für die Suche                       rex::getProperty('id.search')\nbasket = 456         # Artikel-ID für den Warenkorb                   rex::getProperty('id.basket')\n```\n\noder alternativ mit Sections statt Prefix ...\n\n```ini\n# Einstellungen für den News-Bereich                                  Zugriff im Modul/Template\n[news.]\nlistLimit = 10       # Anzahl Teaser-Einträge für die Startseite      rex::getProperty('news.listLimit')\ndetailArticle = 123  # Artikel-ID für die News-Anzeige                rex::getProperty('news.detailArticle')\n\n# Diverse Artikel-ID's\n[id.]\nsearch = 123         # Artikel-ID für die Suche                       rex::getProperty('id.search')\nbasket = 456         # Artikel-ID für den Warenkorb                   rex::getProperty('id.basket')\n```\n\n## Verwendung im Template / Modul\n\nVerwendung der oben definierten Properties im Template oder Modul\n\n```php\n// Zugriff auf Properties mit gesetztem PREFIX = news. / Section [news.]\n$limit = rex::getProperty('news.listLimit');\n```\n\nAlternativ zur PHP-Schreibweise kann auch folgende Schreibweise in Templates verwendet werden.\n\n\u003e **Hinweis:** Funktioniert nicht bei Properties im JSON-Format!\n\n```\nREX_PROPERTY[news.listLimit]\nREX_PROPERTY[key=news.listLimit]\n```\n\n## Anwendungs-Beispiel\n\nFür ein Galerie-Modul müssen mindestens 3 Bilder ausgewählt werden.\n\n**Property-Einstellungen**\n\n```ini\n# Backend-Properties\nPREFIX = be.\nminimumGalleryPics = 3\n\n# Frontend-Properties\nPREFIX = fe.\n...\n```\n\n**Modul-Input**\n\n```php\n\u003c?php\n// Hinweis im Edit-Modus (am Modul-Anfang)\n$_imagelist = explode(',', \"REX_MEDIALIST[1]\");\nif (rex_request('save', 'string', '') == '1') {\n    if (count($_imagelist) \u003c rex::getProperty('be.minimumGalleryPics')) {\n        echo rex_view::warning('Achtung! Keine oder zu wenige Bilder ausgewählt (mind. ' . rex::getProperty('be.minimumGalleryPics') . ')! Es erfolgt keine Ausgabe!');\n    }\n}\n?\u003e\n...\n```\n\n**Modul-Output**\n\n```php\n\u003c?php\n// Hinweis nur im Backend (am Modul-Anfang), im Frontend keine Ausgabe\n$_imagelist = explode(',', \"REX_MEDIALIST[1]\");\nif (count($_imagelist) \u003c rex::getProperty('be.minimumGalleryPics')) {\n    if (rex::isBackend()) {\n        echo rex_view::warning('Achtung! Keine oder zu wenige Bilder ausgewählt (mind. ' . rex::getProperty('be.minimumGalleryPics') . ')! Es erfolgt keine Ausgabe!');\n    }\n    return;\n}\n?\u003e\n\n...\n```\n\n## Empfehlungen / Sonstiges\n\n* PREFIX= oder [Section] setzen!\n* Properties im CamelCase notieren -\u003e https://en.wikipedia.org/wiki/Camel_case\n* Es sind auch mehrere PREFIXe/Sections zur Gruppierung von Properties möglich\n* Durch den Eintrag **load: early** in der package.yml sind die Properties auch in (fast) allen AddOns verfügbar","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffriendsofredaxo%2Fproperties","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ffriendsofredaxo%2Fproperties","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffriendsofredaxo%2Fproperties/lists"}