From 3374e0daba5ec675ea0c67ec6f766744b327213e Mon Sep 17 00:00:00 2001 From: Alexander Walther Date: Fri, 14 Jul 2023 17:13:27 +0200 Subject: [PATCH] Update pfade.md (#287) @alxndr-w Danke , und klar merge ich gerne --- pfade.md | 325 ++++++++++++++++++++++++++++++++++++++++++++----------- 1 file changed, 260 insertions(+), 65 deletions(-) diff --git a/pfade.md b/pfade.md index f7182b3d..c7cb451e 100644 --- a/pfade.md +++ b/pfade.md @@ -60,9 +60,15 @@ Gibt den Base Pfad mit der übergebenen Datei oder dem Ordner zurück Beispiele: -`rex_path::base()` => '/htdocs/meinverzeichnis/' +```php +rex_path::base() +// ergibt: "/htdocs/meinverzeichnis/" +``` -`rex_path::base('index.php')` => '/htdocs/meinverzeichnis/index.php' +```php +rex_path::base('index.php') +// ergibt: "/htdocs/meinverzeichnis/index.php" +``` @@ -72,9 +78,15 @@ Gibt den Frontend-Pfad mit der übergebenen Datei oder dem Ordner zurück Beispiele: -`rex_path::frontend()` => '/htdocs/meinverzeichnis/' +```php +rex_path::frontend() +// ergibt: "/htdocs/meinverzeichnis/" +``` -`rex_path::frontend('index.php')` => '/htdocs/meinverzeichnis/index.php' +```php +rex_path::frontend('index.php') +// ergibt: "/htdocs/meinverzeichnis/index.php" +``` @@ -83,7 +95,10 @@ Beispiele: Pfad zum Frontend-Controller Beispiel: -`rex_path::frontendController()` => '/htdocs/meinverzeichnis/index.php' +```php +rex_path::frontendController() +// ergibt: "/htdocs/meinverzeichnis/index.php" +``` @@ -92,9 +107,15 @@ Beispiel: Pfad zum Backend Beispiel: -`rex_path::backend()` => '/htdocs/meinverzeichnis/redaxo/' +```php +rex_path::backend() +// ergibt: "/htdocs/meinverzeichnis/redaxo/" +``` -`rex_path::backend('meinedatei.php')` => '/htdocs/meinverzeichnis/redaxo/meinedatei.php' +```php +rex_path::backend('meinedatei.php') +// ergibt: "/htdocs/meinverzeichnis/redaxo/meinedatei.php" +``` @@ -103,7 +124,10 @@ Beispiel: Pfad zum Backend-Controller Beispiel: -`rex_path::backendController()` => '/htdocs/meinverzeichnis/redaxo/index.php' +```php +rex_path::backendController() +// ergibt: "/htdocs/meinverzeichnis/redaxo/index.php" +``` @@ -112,7 +136,10 @@ Beispiel: Pfad zum Media-Verzeichnis Beispiel: -`rex_path::media()` => '/htdocs/meinverzeichnis/media/' +```php +rex_path::media() +// ergibt: "/htdocs/meinverzeichnis/media/" +``` @@ -121,7 +148,10 @@ Beispiel: Pfad zum Assets-Verzeichnis Beispiel: -`rex_path::assets()` => '/htdocs/meinverzeichnis/assets/' +```php +rex_path::assets() +// ergibt: "/htdocs/meinverzeichnis/assets/" +``` @@ -130,8 +160,14 @@ Beispiel: Pfad zum Assets-Verzeichnis des Core Beispiel: -`rex_path::coreAssets()` => '/htdocs/meinverzeichnis/assets/core/' -`rex_path::coreAssets('file.txt')` => '/htdocs/meinverzeichnis/assets/core/file.txt' +```php +rex_path::coreAssets() +// ergibt: "/htdocs/meinverzeichnis/assets/core/" +``` +```php +rex_path::coreAssets('file.txt') +// ergibt: "/htdocs/meinverzeichnis/assets/core/file.txt" +``` @@ -140,8 +176,14 @@ Beispiel: Pfad zum Assets-Verzeichnis eines AddOns Beispiel: -`rex_path::addonAssets('meinaddon')` => '/htdocs/meinverzeichnis/assets/addons/meinaddon/' -`rex_path::addonAssets('meinaddon','file.txt')` => '/htdocs/meinverzeichnis/assets/addons/meinaddon/file.txt' +```php +rex_path::addonAssets('meinaddon') +// ergibt: "/htdocs/meinverzeichnis/assets/addons/meinaddon/" +``` +```php +rex_path::addonAssets('meinaddon','file.txt') +// ergibt: "/htdocs/meinverzeichnis/assets/addons/meinaddon/file.txt" +``` @@ -150,8 +192,14 @@ Beispiel: Pfad zum Assets-Verzeichnis eines Plugins Beispiel: -`rex_path::pluginAssets('meinaddon','meinplugin')` => '/htdocs/meinverzeichnis/assets/addons/meinaddon/plugins/meinplugin/' -`rex_path::pluginAssets('meinaddon','meinplugin','file.txt')` => '/htdocs/meinverzeichnis/assets/addons/meinaddon/plugins/meinplugin/file.txt' +```php +rex_path::pluginAssets('meinaddon','meinplugin') +// ergibt: "/htdocs/meinverzeichnis/assets/addons/meinaddon/plugins/meinplugin/" +``` +```php +rex_path::pluginAssets('meinaddon','meinplugin','file.txt') +// ergibt: "/htdocs/meinverzeichnis/assets/addons/meinaddon/plugins/meinplugin/file.txt" +``` @@ -160,7 +208,10 @@ Beispiel: Pfad zum Data-Verzeichnis Beispiel: -`rex_path::data()` => '/htdocs/meinverzeichnis/data/' +```php +rex_path::data() +// ergibt: "/htdocs/meinverzeichnis/data/" +``` @@ -169,8 +220,14 @@ Beispiel: Pfad zum Data-Verzeichnis des Core Beispiel: -`rex_path::coreData()` => '/htdocs/meinverzeichnis/data/core/' -`rex_path::coreData('file.txt')` => '/htdocs/meinverzeichnis/data/core/file.txt' +```php +rex_path::coreData() +// ergibt: "/htdocs/meinverzeichnis/data/core/" +``` +```php +rex_path::coreData('file.txt') +// ergibt: "/htdocs/meinverzeichnis/data/core/file.txt" +``` @@ -179,8 +236,14 @@ Beispiel: Pfad zum Data-Verzeichnis eines AddOns Beispiel: -`rex_path::addonData('meinaddon')` => '/htdocs/meinverzeichnis/data/addons/meinaddon/' -`rex_path::addonData('meinaddon','file.txt')` => '/htdocs/meinverzeichnis/data/addons/meinaddon/file.txt' +```php +rex_path::addonData('meinaddon') +// ergibt: "/htdocs/meinverzeichnis/data/addons/meinaddon/" +``` +```php +rex_path::addonData('meinaddon','file.txt') +// ergibt: "/htdocs/meinverzeichnis/data/addons/meinaddon/file.txt" +``` @@ -189,8 +252,14 @@ Beispiel: Pfad zum Data-Verzeichnis eines Plugins Beispiel: -`rex_path::pluginData('meinaddon','meinplugin')` => '/htdocs/meinverzeichnis/data/addons/meinaddon/plugins/meinplugin/' -`rex_path::pluginData('meinaddon','meinplugin','file.txt')` => '/htdocs/meinverzeichnis/data/addons/meinaddon/plugins/meinplugin/file.txt' +```php +rex_path::pluginData('meinaddon','meinplugin') +// ergibt: "/htdocs/meinverzeichnis/data/addons/meinaddon/plugins/meinplugin/" +``` +```php +rex_path::pluginData('meinaddon','meinplugin','file.txt') +// ergibt: "/htdocs/meinverzeichnis/data/addons/meinaddon/plugins/meinplugin/file.txt" +``` @@ -199,8 +268,14 @@ Beispiel: Pfad zum Cache-Verzeichnis Beispiel: -`rex_path::cache()` => '/htdocs/meinverzeichnis/redaxo/cache/' -`rex_path::cache('file.txt')` => '/htdocs/meinverzeichnis/redaxo/cache/file.txt' +```php +rex_path::cache() +// ergibt: "/htdocs/meinverzeichnis/redaxo/cache/" +``` +```php +rex_path::cache('file.txt') +// ergibt: "/htdocs/meinverzeichnis/redaxo/cache/file.txt" +``` @@ -209,8 +284,14 @@ Beispiel: Pfad zum Data-Verzeichnis Beispiel: -`rex_path::coreCache()` => '/htdocs/meinverzeichnis/redaxo/cache/core/' -`rex_path::coreCache('file.txt')` => '/htdocs/meinverzeichnis/redaxo/cache/core/file.txt' +```php +rex_path::coreCache() +// ergibt: "/htdocs/meinverzeichnis/redaxo/cache/core/" +``` +```php +rex_path::coreCache('file.txt') +// ergibt: "/htdocs/meinverzeichnis/redaxo/cache/core/file.txt" +``` @@ -219,8 +300,14 @@ Beispiel: Pfad zum Cache-Verzeichnis eines AddOns Beispiel: -`rex_path::addonCache('meinaddon')` => '/htdocs/meinverzeichnis/redaxo/cache/addons/meinaddon/' -`rex_path::addonCache('meinaddon','file.txt')` => '/htdocs/meinverzeichnis/redaxo/cache/addons/meinaddon/file.txt' +```php +rex_path::addonCache('meinaddon') +// ergibt: "/htdocs/meinverzeichnis/redaxo/cache/addons/meinaddon/" +``` +```php +rex_path::addonCache('meinaddon','file.txt') +// ergibt: "/htdocs/meinverzeichnis/redaxo/cache/addons/meinaddon/file.txt" +``` @@ -229,8 +316,14 @@ Beispiel: Pfad zum Cache-Verzeichnis eines Plugins Beispiel: -`rex_path::pluginCache('meinaddon','meinplugin')` => '/htdocs/meinverzeichnis/redaxo/cache/addons/meinaddon/plugins/meinplugin/' -`rex_path::pluginCache('meinaddon','meinplugin','file.txt')` => '/htdocs/meinverzeichnis/redaxo/cache/addons/meinaddon/plugins/meinplugin/file.txt' +```php +rex_path::pluginCache('meinaddon','meinplugin') +// ergibt: "/htdocs/meinverzeichnis/redaxo/cache/addons/meinaddon/plugins/meinplugin/" +``` +```php +rex_path::pluginCache('meinaddon','meinplugin','file.txt') +// ergibt: "/htdocs/meinverzeichnis/redaxo/cache/addons/meinaddon/plugins/meinplugin/file.txt" +``` @@ -248,8 +341,14 @@ Beispiel: Pfad zum Src-Verzeichnis Beispiel: -`rex_path::src()` => '/htdocs/meinverzeichnis/redaxo/src/' -`rex_path::src('file.txt')` => '/htdocs/meinverzeichnis/redaxo/src/file.txt' +```php +rex_path::src() +// ergibt: "/htdocs/meinverzeichnis/redaxo/src/" +``` +```php +rex_path::src('file.txt') +// ergibt: "/htdocs/meinverzeichnis/redaxo/src/file.txt" +``` @@ -258,8 +357,14 @@ Beispiel: Pfad zum Core-Verzeichnis Beispiel: -`rex_path::core()` => '/htdocs/meinverzeichnis/redaxo/src/core/' -`rex_path::core('file.txt')` => '/htdocs/meinverzeichnis/redaxo/src/core/file.txt' +```php +rex_path::core() +// ergibt: "/htdocs/meinverzeichnis/redaxo/src/core/" +``` +```php +rex_path::core('file.txt') +// ergibt: "/htdocs/meinverzeichnis/redaxo/src/core/file.txt" +``` @@ -268,8 +373,14 @@ Beispiel: Pfad zum AddOn-Verzeichnis Beispiel: -`rex_path::addon('meinaddon')` => '/htdocs/meinverzeichnis/redaxo/src/addons/meinaddon/' -`rex_path::addon('meinaddon','file.txt')` => '/htdocs/meinverzeichnis/redaxo/src/addons/meinaddon/file.txt' +```php +rex_path::addon('meinaddon') +// ergibt: "/htdocs/meinverzeichnis/redaxo/src/addons/meinaddon/" +``` +```php +rex_path::addon('meinaddon','file.txt') +// ergibt: "/htdocs/meinverzeichnis/redaxo/src/addons/meinaddon/file.txt" +``` @@ -278,8 +389,14 @@ Beispiel: Pfad zum PlugIn-Verzeichnis Beispiel: -`rex_path::plugin('meinaddon','meinplugin')` => '/htdocs/meinverzeichnis/redaxo/src/addons/meinaddon/plugins/meinplugin/' -`rex_path::plugin('meinaddon','meinplugin','file.txt')` => '/htdocs/meinverzeichnis/redaxo/src/addons/meinaddon/plugins/meinplugin/file.txt' +```php +rex_path::plugin('meinaddon','meinplugin') +// ergibt: "/htdocs/meinverzeichnis/redaxo/src/addons/meinaddon/plugins/meinplugin/" +``` +```php +rex_path::plugin('meinaddon','meinplugin','file.txt') +// ergibt: "/htdocs/meinverzeichnis/redaxo/src/addons/meinaddon/plugins/meinplugin/file.txt" +``` @@ -288,7 +405,10 @@ Beispiel: Wandelt einen relativen Pfad zu einem absoluten Pfad Beispiel: -`rex_path::absolute('../../src/addons')` => 'src/addons' +```php +rex_path::absolute('../../src/addons') +// ergibt: "src/addons" +``` @@ -305,8 +425,14 @@ Funktionen, die Parameter zu URLs umschreiben, können die URL auch "escaped" zu Liefert den Basispfad der Website Beispiel: -`rex_url::base()` => '/' -`rex_url::base('file.txt')` => '/file.txt' +```php +rex_url::base() +// ergibt: "/" +``` +```php +rex_url::base('file.txt') +// ergibt: "/file.txt" +``` @@ -315,10 +441,19 @@ Beispiel: Liefert den Frontendpfad der Website Beispiel: -`rex_url::frontend()` => '/' +```php +rex_url::frontend() +// ergibt: "/" +``` Bei Installation in einem Unterverzeichnis: -`rex_url::frontend()` => '/verzeichnis/' -`rex_url::frontend('file.txt')` => '/verzeichnis/file.txt' +```php +rex_url::frontend() +// ergibt: "/verzeichnis/" +``` +```php +rex_url::frontend('file.txt') +// ergibt: "/verzeichnis/file.txt" +``` @@ -327,8 +462,14 @@ Bei Installation in einem Unterverzeichnis: Generiert eine URL aus übergebenen Parametern Beispiel: -`rex_url::frontendController(['key'=>'value'])` => '/index.php?key=value' -`rex_url::frontendController(['k1'=>'v1','k2'=>'v2'], true)` => '/index.php?k1=v1& k2=v2' +```php +rex_url::frontendController(['key'=>'value']) +// ergibt: "/index.php?key=value" +``` +```php +rex_url::frontendController(['k1'=>'v1','k2'=>'v2'], true) +// ergibt: "/index.php?k1=v1& k2=v2" +``` @@ -337,8 +478,14 @@ Beispiel: Liefert den Backendpfad der Website Beispiel: -`rex_url::backend()` => '/redaxo/' -`rex_url::backend('file.txt')` => '/redaxo/file.txt' +```php +rex_url::backend() +// ergibt: "/redaxo/" +``` +```php +rex_url::backend('file.txt') +// ergibt: "/redaxo/file.txt" +``` @@ -347,8 +494,14 @@ Beispiel: Generiert eine Backend-URL aus übergebenen Parametern Beispiel: -`rex_url::backendController(['key'=>'value'])` => '/redaxo/index.php?key=value' -`rex_url::backendController(['k1'=>'v1','k2'=>'v2'], true)` => '/redaxo/index.php?k1=v1& k2=v2' +```php +rex_url::backendController(['key'=>'value']) +// ergibt: "/redaxo/index.php?key=value" +``` +```php +rex_url::backendController(['k1'=>'v1','k2'=>'v2'], true) +// ergibt: "/redaxo/index.php?k1=v1& k2=v2" +``` @@ -357,8 +510,14 @@ Beispiel: Generiert eine URL zu einer Backend Seite Beispiel: -`rex_url::backendPage('mypage',['key'=>'value'])` => '/redaxo/index.php?page=mypage&key=value' -`rex_url::backendPage('mypage',['k1'=>'v1','k2'=>'v2'], true)` => '/redaxo/index.php?page=mypage& k1=v1& k2=v2' +```php +rex_url::backendPage('mypage',['key'=>'value']) +// ergibt: "/redaxo/index.php?page=mypage&key=value" +``` +```php +rex_url::backendPage('mypage',['k1'=>'v1','k2'=>'v2'], true) +// ergibt: "/redaxo/index.php?page=mypage& k1=v1& k2=v2" +``` @@ -367,8 +526,14 @@ Beispiel: Generiert eine URL zur aktuellen Backend-Seite. Sollte sinnvollerweise nur von einer Backend-Page aufgerufen werden, ansonsten ist der Parameter `page` leer. Beispiel: -`rex_url::currentBackendPage(['key'=>'value'])` => '/redaxo/index.php?page=currpage&key=value' -`rex_url::currentBackendPage(['k1'=>'v1','k2'=>'v2'], true)` => '/redaxo/index.php?page=currpage& k1=v1& k2=v2' +```php +rex_url::currentBackendPage(['key'=>'value']) +// ergibt: "/redaxo/index.php?page=currpage&key=value" +``` +```php +rex_url::currentBackendPage(['k1'=>'v1','k2'=>'v2'], true) +// ergibt: "/redaxo/index.php?page=currpage& k1=v1& k2=v2" +``` @@ -377,8 +542,14 @@ Beispiel: Liefert den Frontendpfad zum Media-Verzeichnis Beispiel: -`rex_url::media()` => '/media/' -`rex_url::media('file.txt')` => '/media/file.txt' +```php +rex_url::media() +// ergibt: "/media/" +``` +```php +rex_url::media('file.txt') +// ergibt: "/media/file.txt" +``` @@ -387,8 +558,14 @@ Beispiel: Liefert den Frontendpfad zum Assets-Verzeichnis Beispiel: -`rex_url::assets()` => '/assets/' -`rex_url::assets('file.txt')` => '/assets/file.txt' +```php +rex_url::assets() +// ergibt: "/assets/" +``` +```php +rex_url::assets('file.txt') +// ergibt: "/assets/file.txt" +``` @@ -397,8 +574,14 @@ Beispiel: Liefert den Frontendpfad zum Assets-Verzeichnis des Core Beispiel: -`rex_url::coreAssets()` => '/assets/core/' -`rex_url::coreAssets('file.txt')` => '/assets/core/file.txt' +```php +rex_url::coreAssets() +// ergibt: "/assets/core/" +``` +```php +rex_url::coreAssets('file.txt') +// ergibt: "/assets/core/file.txt" +``` @@ -407,8 +590,14 @@ Beispiel: Liefert den Frontendpfad zum Assets-Verzeichnis eines AddOns Beispiel: -`rex_url::addonAssets('meinaddon')` => '/assets/addons/meinaddon/' -`rex_url::addonAssets('meinaddon','file.txt')` => '/assets/addons/meinaddon/file.txt' +```php +rex_url::addonAssets('meinaddon') +// ergibt: "/assets/addons/meinaddon/" +``` +```php +rex_url::addonAssets('meinaddon','file.txt') +// ergibt: "/assets/addons/meinaddon/file.txt" +``` @@ -417,5 +606,11 @@ Beispiel: Liefert den Frontendpfad zum Assets-Verzeichnis eines Plugins Beispiel: -`rex_url::pluginAssets('meinaddon','meinplugin')` => '/assets/addons/meinaddon/plugins/meinplugin/' -`rex_url::pluginAssets('meinaddon','meinplugin','file.txt')` => '/assets/addons/meinaddon/plugins/meinplugin/file.txt' +```php +rex_url::pluginAssets('meinaddon','meinplugin') +// ergibt: "/assets/addons/meinaddon/plugins/meinplugin/" +``` +```php +rex_url::pluginAssets('meinaddon','meinplugin','file.txt') +// ergibt: "/assets/addons/meinaddon/plugins/meinplugin/file.txt" +```