From 95b3b1702e698ee6a8ef4e288761bda576b209aa Mon Sep 17 00:00:00 2001 From: Jean-Christian Denis Date: Mon, 24 Apr 2023 14:38:03 +0200 Subject: [PATCH] add some code descriptions --- src/Cleaner/Caches.php | 15 ++++++++++++++- src/Cleaner/Logs.php | 7 +++++++ src/Cleaner/Plugins.php | 6 ++++++ src/Cleaner/Preferences.php | 11 +++++++---- src/Cleaner/Settings.php | 11 +++++++---- src/Cleaner/Tables.php | 7 +++++++ src/Cleaner/Themes.php | 6 ++++++ src/Cleaner/Vars.php | 7 +++++++ src/Cleaner/Versions.php | 7 +++++++ 9 files changed, 68 insertions(+), 9 deletions(-) diff --git a/src/Cleaner/Caches.php b/src/Cleaner/Caches.php index c415b32..49827b8 100644 --- a/src/Cleaner/Caches.php +++ b/src/Cleaner/Caches.php @@ -21,6 +21,12 @@ use Dotclear\Plugin\Uninstaller\{ ValueDescriptor }; +/** + * Cleaner for Dotclear cache directory used by modules. + * + * It allows modules to delete an entire sub folder + * of DC_TPL_CACHE directory path. + */ class Caches extends AbstractCleaner { use TraitCleanerDir; @@ -37,6 +43,7 @@ class Caches extends AbstractCleaner protected function actions(): array { return [ + // delete a $ns folder and thier files. new ActionDescriptor([ 'id' => 'delete', 'select' => __('delete selected cache directories'), @@ -44,6 +51,7 @@ class Caches extends AbstractCleaner 'success' => __('"%s" cache directory deleted'), 'error' => __('Failed to delete "%s" cache directory'), ]), + // delete $ns folder files but keep folder new ActionDescriptor([ 'id' => 'empty', 'select' => __('empty selected cache directories'), @@ -56,7 +64,12 @@ class Caches extends AbstractCleaner public function distributed(): array { - return ['cbfeed', 'cbtpl', 'dcrepo', 'versions']; + return [ + 'cbfeed', + 'cbtpl', + 'dcrepo', + 'versions' + ]; } public function values(): array diff --git a/src/Cleaner/Logs.php b/src/Cleaner/Logs.php index 70baab4..f2831bb 100644 --- a/src/Cleaner/Logs.php +++ b/src/Cleaner/Logs.php @@ -26,6 +26,12 @@ use Dotclear\Plugin\Uninstaller\{ ValueDescriptor }; +/** + * Cleaner for Dotclear logs used by modules. + * + * It allows modules to delete a "log_table" + * of Dotclear dcLog::LOG_TABLE_NAME database table. + */ class Logs extends AbstractCleaner { protected function properties(): array @@ -40,6 +46,7 @@ class Logs extends AbstractCleaner protected function actions(): array { return [ + // delete all $ns log_table entries new ActionDescriptor([ 'id' => 'delete_all', 'select' => __('delete selected logs tables'), diff --git a/src/Cleaner/Plugins.php b/src/Cleaner/Plugins.php index d69409f..7888aed 100644 --- a/src/Cleaner/Plugins.php +++ b/src/Cleaner/Plugins.php @@ -21,6 +21,11 @@ use Dotclear\Plugin\Uninstaller\{ ValueDescriptor }; +/** + * Cleaner for Dotclear plugins. + * + * It allows modules to delete their own folder. + */ class Plugins extends AbstractCleaner { use TraitCleanerDir; @@ -37,6 +42,7 @@ class Plugins extends AbstractCleaner protected function actions(): array { return [ + // delete $ns plugin folder new ActionDescriptor([ 'id' => 'delete', 'select' => __('delete selected plugins files and directories'), diff --git a/src/Cleaner/Preferences.php b/src/Cleaner/Preferences.php index e8fe9d4..b43461a 100644 --- a/src/Cleaner/Preferences.php +++ b/src/Cleaner/Preferences.php @@ -27,10 +27,10 @@ use Dotclear\Plugin\Uninstaller\{ }; /** - * Users preferences cleaner. + * Cleaner for Dotclear user preferences. * - * Cleaner manages entire users preferences workspace - * except 'delete_related' which can pickup preference ws/id pairs + * It allows modules to delete for users or global a preference workspace. + * It also allows to pick-up specific preference id by using delete_related action. */ class Preferences extends AbstractCleaner { @@ -46,6 +46,7 @@ class Preferences extends AbstractCleaner protected function actions(): array { return [ + // delete global $ns preferences workspace new ActionDescriptor([ 'id' => 'delete_global', 'select' => __('delete selected global preferences workspaces'), @@ -53,6 +54,7 @@ class Preferences extends AbstractCleaner 'success' => __('"%s" global preferences workspace deleted'), 'error' => __('Failed to delete "%s" global preferences workspace'), ]), + // delete users $ns preferences workspace new ActionDescriptor([ 'id' => 'delete_local', 'select' => __('delete selected users preferences workspaces'), @@ -60,6 +62,7 @@ class Preferences extends AbstractCleaner 'success' => __('"%s" users preferences workspace deleted'), 'error' => __('Failed to delete "%s" users preferences workspace'), ]), + // delete user and global $ns preferences workspace new ActionDescriptor([ 'id' => 'delete_all', 'select' => __('delete selected preferences workspaces'), @@ -67,7 +70,7 @@ class Preferences extends AbstractCleaner 'success' => __('"%s" preferences workspace deleted'), 'error' => __('Failed to delete "%s" preferences workspace'), ]), - // $ns = 'pref_ws:pref_id;pref_ws:pref_id;...' for global and users preferences + // delete users and globals specific $ws:$id settings using 'pref_ws:pref_id;pref_ws:pref_id;' as $ns new ActionDescriptor([ 'id' => 'delete_related', 'query' => __('delete related preferences'), diff --git a/src/Cleaner/Settings.php b/src/Cleaner/Settings.php index cf5510a..8bc2f9f 100644 --- a/src/Cleaner/Settings.php +++ b/src/Cleaner/Settings.php @@ -27,10 +27,10 @@ use Dotclear\Plugin\Uninstaller\{ }; /** - * Settings cleaner. + * Cleaner for Dotclear blog settings. * - * Cleaner manages entire setting namespace - * except 'delete_related' which can pickup settings ns/id pairs + * It allows modules to delete for blogs or global a settings namespace. + * It also allows to pick-up specific setting id by using delete_related action. */ class Settings extends AbstractCleaner { @@ -46,6 +46,7 @@ class Settings extends AbstractCleaner protected function actions(): array { return [ + // delete global $ns settings namespace new ActionDescriptor([ 'id' => 'delete_global', 'select' => __('delete selected global settings namespaces'), @@ -53,6 +54,7 @@ class Settings extends AbstractCleaner 'success' => __('"%s" global settings namespace deleted'), 'error' => __('Failed to delete "%s" global settings namespace'), ]), + // delete blogs $ns settings namespace new ActionDescriptor([ 'id' => 'delete_local', 'select' => __('delete selected blog settings namespaces'), @@ -60,6 +62,7 @@ class Settings extends AbstractCleaner 'success' => __('"%s" blog settings namespace deleted'), 'error' => __('Failed to delete "%s" blog settings namespace'), ]), + // delete blogs and global settings namespace new ActionDescriptor([ 'id' => 'delete_all', 'select' => __('delete selected settings namespaces'), @@ -67,7 +70,7 @@ class Settings extends AbstractCleaner 'success' => __('"%s" settings namespace deleted'), 'error' => __('Failed to delete "%s" settings namespace'), ]), - // $ns = 'setting_ns:setting_id;setting_ns:setting_id;...' for global and blogs settings + // delete blogs and globals specific $ns:$id settings using 'setting_ns:setting_id;setting_ns:setting_id;' as $ns new ActionDescriptor([ 'id' => 'delete_related', 'query' => __('delete related settings'), diff --git a/src/Cleaner/Tables.php b/src/Cleaner/Tables.php index 55fe705..f9259d8 100644 --- a/src/Cleaner/Tables.php +++ b/src/Cleaner/Tables.php @@ -30,6 +30,11 @@ use Dotclear\Plugin\Uninstaller\{ ValueDescriptor }; +/** + * Cleaner for Dotclear cache directory used by modules. + * + * It allows modules to delete or truncate a database table. + */ class Tables extends AbstractCleaner { protected function properties(): array @@ -44,6 +49,7 @@ class Tables extends AbstractCleaner protected function actions(): array { return [ + // delete $ns database table new ActionDescriptor([ 'id' => 'delete', 'select' => __('delete selected tables'), @@ -51,6 +57,7 @@ class Tables extends AbstractCleaner 'success' => __('"%s" table deleted'), 'error' => __('Failed to delete "%s" table'), ]), + // truncate (empty) $ns database table new ActionDescriptor([ 'id' => 'empty', 'select' => __('empty selected tables'), diff --git a/src/Cleaner/Themes.php b/src/Cleaner/Themes.php index 3dced85..4759bd2 100644 --- a/src/Cleaner/Themes.php +++ b/src/Cleaner/Themes.php @@ -22,6 +22,11 @@ use Dotclear\Plugin\Uninstaller\{ ValueDescriptor }; +/** + * Cleaner for Dotclear themes. + * + * It allows modules to delete their own folder. + */ class Themes extends AbstractCleaner { use TraitCleanerDir; @@ -38,6 +43,7 @@ class Themes extends AbstractCleaner protected function actions(): array { return [ + // delete $ns theme folder new ActionDescriptor([ 'id' => 'delete', 'select' => __('delete selected themes files and directories'), diff --git a/src/Cleaner/Vars.php b/src/Cleaner/Vars.php index 58a232f..e32939e 100644 --- a/src/Cleaner/Vars.php +++ b/src/Cleaner/Vars.php @@ -21,6 +21,12 @@ use Dotclear\Plugin\Uninstaller\{ ValueDescriptor }; +/** + * Cleaner for Dotclear VAR directory used by modules. + * + * It allows modules to delete an entire sub folder + * of DC_VAR directory path. + */ class Vars extends AbstractCleaner { use TraitCleanerDir; @@ -37,6 +43,7 @@ class Vars extends AbstractCleaner protected function actions(): array { return [ + // delete a $ns folder and their files new ActionDescriptor([ 'id' => 'delete', 'select' => __('delete selected var directories'), diff --git a/src/Cleaner/Versions.php b/src/Cleaner/Versions.php index c16561d..cc056e8 100644 --- a/src/Cleaner/Versions.php +++ b/src/Cleaner/Versions.php @@ -22,6 +22,12 @@ use Dotclear\Plugin\Uninstaller\{ ValueDescriptor }; +/** + * Cleaner for Dotclear modules versions. + * + * It allows modules to delete their versions + * from Dotclear dcCore::VERSION_TABLE_NAME database table. + */ class Versions extends AbstractCleaner { protected function properties(): array @@ -36,6 +42,7 @@ class Versions extends AbstractCleaner protected function actions(): array { return [ + // delete $ns version new ActionDescriptor([ 'id' => 'delete', 'select' => __('delete selected versions numbers'),