From a76bf3531db725e66a31efbeaa2b2464c3d24136 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?C=C3=B4me=20Chilliet?= <come.bernigaud@opensides.be>
Date: Thu, 1 Oct 2015 12:56:09 +0200
Subject: [PATCH] Fixes #2166 Fixed semantic of plDescription
---
include/class_acl.inc | 8 ++++--
include/class_config.inc | 1 -
include/class_management.inc | 16 ++++++------
include/class_pluglist.inc | 3 +++
include/simpleplugin/class_simplePlugin.inc | 2 +-
plugins/addons/dashboard/class_dashBoard.inc | 1 +
plugins/admin/acl/class_aclManagement.inc | 3 ++-
.../admin/aclrole/class_aclRoleManagement.inc | 3 ++-
.../class_departmentManagement.inc | 5 ++--
.../admin/groups/class_groupManagement.inc | 11 ++++----
plugins/admin/users/class_userManagement.inc | 3 ++-
plugins/config/class_configInLdap.inc | 3 ++-
setup/class_setup.inc | 26 +++++++++----------
setup/class_setupStep.inc | 20 +++++++-------
setup/class_setupStep_Checks.inc | 6 ++---
setup/class_setupStep_Config.inc | 16 ++++++------
setup/class_setupStep_Finish.inc | 6 ++---
setup/class_setupStep_Language.inc | 8 +++---
setup/class_setupStep_Ldap.inc | 6 ++---
setup/class_setupStep_Migrate.inc | 6 ++---
setup/class_setupStep_Welcome.inc | 6 ++---
21 files changed, 85 insertions(+), 74 deletions(-)
diff --git a/include/class_acl.inc b/include/class_acl.inc
index b71fd3731..58e27ebaa 100644
--- a/include/class_acl.inc
+++ b/include/class_acl.inc
@@ -297,8 +297,12 @@ class acl extends plugin
'plDescription' => _('Manage access control lists'),
'plSelfModify' => FALSE,
'plPriority' => 0,
- 'plCategory' => array('acl' => array('description' => _('ACL').' & '._('ACL roles'),
- 'objectClass' => array('gosaAcl','gosaRole'))),
+ 'plCategory' => array(
+ 'acl' => array(
+ 'description' => _('ACL').' & '._('ACL roles'),
+ 'objectClass' => array('gosaAcl','gosaRole')
+ )
+ ),
'plObjectType' => array(),
'plProvidedAcls' => array()
diff --git a/include/class_config.inc b/include/class_config.inc
index cf2aefac8..69a891d98 100644
--- a/include/class_config.inc
+++ b/include/class_config.inc
@@ -1121,7 +1121,6 @@ class config {
}
array_unshift($this->data['TABS'][$tabclass], $entry);
}
-
}
} elseif (class_available($class) && is_subclass_of($class, 'simpleService')) {
@DEBUG (DEBUG_TRACE, __LINE__, __FUNCTION__, __FILE__, $class, "Adding service");
diff --git a/include/class_management.inc b/include/class_management.inc
index 24146cb35..8e5d1dc8e 100644
--- a/include/class_management.inc
+++ b/include/class_management.inc
@@ -246,23 +246,23 @@ class management
}
if (in_array_ics('plInfo', get_class_methods(get_class($this)))) {
- $plInfos = $this->plInfo();
- $plDescription = $plInfos['plDescription'];
- $plIcon = $plInfos['plIcon'];
+ $plInfos = $this->plInfo();
+ $plTitle = $plInfos['plTitle'];
+ $plIcon = $plInfos['plIcon'];
} else {
- $plDescription = $this->plDescription;
- $plIcon = $this->plIcon;
+ $plTitle = $this->plDescription;
+ $plIcon = $this->plIcon;
}
if (!preg_match('/^geticon/', $plIcon)) {
$plIcon = get_template_path($plIcon);
}
- if (get_object_info() != "") {
- $display = print_header($plIcon, _($plDescription),
+ if (get_object_info() != '') {
+ $display = print_header($plIcon, _($plTitle),
'<img alt="" class="center" src="geticon.php?context=status&icon=object-locked&size=16"/>'.
LDAP::fix(get_object_info()));
} else {
- $display = print_header($plIcon, _($plDescription));
+ $display = print_header($plIcon, _($plTitle));
}
return $display;
}
diff --git a/include/class_pluglist.inc b/include/class_pluglist.inc
index f146dcecc..0b3c18ecb 100644
--- a/include/class_pluglist.inc
+++ b/include/class_pluglist.inc
@@ -139,6 +139,9 @@ class pluglist {
if (!isset($infos['plCategory'])) {
$infos['plCategory'] = array();
}
+ if (!isset($infos['plTitle'])) {
+ $infos['plTitle'] = $infos['plShortName'];
+ }
$infos['plForeignRefs'] = array();
$infos['INDEX'] = $index;
$this->info[$cname] = $infos;
diff --git a/include/simpleplugin/class_simplePlugin.inc b/include/simpleplugin/class_simplePlugin.inc
index 78ba090ee..b0830c77d 100644
--- a/include/simpleplugin/class_simplePlugin.inc
+++ b/include/simpleplugin/class_simplePlugin.inc
@@ -749,7 +749,7 @@ class simplePlugin extends plugin
$plInfo = pluglist::pluginInfos($classname);
$plIcon = (isset($plInfo['plIcon'])?$plInfo['plIcon']:"plugin.png");
- $plHeadline = $plInfo['plShortName'];
+ $plHeadline = $plInfo['plTitle'];
if (($tabs !== FALSE) && ($tabclass === FALSE)) {
$key = key($plInfo['plObjectType']);
if (is_numeric($key)) {
diff --git a/plugins/addons/dashboard/class_dashBoard.inc b/plugins/addons/dashboard/class_dashBoard.inc
index 13f37261e..f6143f0d0 100644
--- a/plugins/addons/dashboard/class_dashBoard.inc
+++ b/plugins/addons/dashboard/class_dashBoard.inc
@@ -25,6 +25,7 @@ class dashboard extends simplePlugin
{
return array(
'plShortName' => _('Dashboard'),
+ 'plTitle' => _('Dashboard'),
'plDescription' => _('Statistics and various informations'),
'plIcon' => 'geticon.php?context=applications&icon=utilities-system-monitor&size=48',
'plObjectType' => array('dashboard' => array('name' => _('Dashboard'))),
diff --git a/plugins/admin/acl/class_aclManagement.inc b/plugins/admin/acl/class_aclManagement.inc
index 937009fd7..37996d956 100644
--- a/plugins/admin/acl/class_aclManagement.inc
+++ b/plugins/admin/acl/class_aclManagement.inc
@@ -36,7 +36,8 @@ class aclManagement extends simpleManagement
{
return array(
'plShortName' => _('ACL assignments'),
- 'plDescription' => _('Access control list management'),
+ 'plTitle' => _('ACL assignments management'),
+ 'plDescription' => _('Manage ACL roles assignments to users'),
'plIcon' => 'geticon.php?context=categories&icon=acl&size=48',
'plSection' => 'accounts',
'plPriority' => 28,
diff --git a/plugins/admin/aclrole/class_aclRoleManagement.inc b/plugins/admin/aclrole/class_aclRoleManagement.inc
index 1dd48e37a..6c75c22ad 100644
--- a/plugins/admin/aclrole/class_aclRoleManagement.inc
+++ b/plugins/admin/aclrole/class_aclRoleManagement.inc
@@ -32,7 +32,8 @@ class aclRoleManagement extends simpleManagement
{
return array(
'plShortName' => _('ACL roles'),
- 'plDescription' => _('ACL roles management'),
+ 'plTitle' => _('ACL roles management'),
+ 'plDescription' => _('Manage ACL roles'),
'plIcon' => 'geticon.php?context=categories&icon=acl&size=48',
'plSection' => 'accounts',
'plPriority' => 27,
diff --git a/plugins/admin/departments/class_departmentManagement.inc b/plugins/admin/departments/class_departmentManagement.inc
index fca2ab7c9..df7d07612 100644
--- a/plugins/admin/departments/class_departmentManagement.inc
+++ b/plugins/admin/departments/class_departmentManagement.inc
@@ -32,7 +32,8 @@ class departmentManagement extends simpleManagement
{
return array(
'plShortName' => _('Departments'),
- 'plDescription' => _('Manage departments'),
+ 'plTitle' => _('Manage departments'),
+ 'plDescription' => _('Manage departments, countries, domain components, domains, localities and organization nodes,'),
'plIcon' => 'geticon.php?context=places&icon=folder&size=48',
'plSection' => array('accounts' => array('name' => _('Users and groups'), 'priority' => 0)),
'plPriority' => 0,
@@ -62,7 +63,6 @@ class departmentManagement extends simpleManagement
$this->refreshDeps();
}
-
function refreshDeps()
{
global $config, $ui;
@@ -74,7 +74,6 @@ class departmentManagement extends simpleManagement
$headpage->refreshBasesList();
}
-
// An action handler which enables to switch into deparmtment by clicking the names.
function openEntry($action, $entry)
{
diff --git a/plugins/admin/groups/class_groupManagement.inc b/plugins/admin/groups/class_groupManagement.inc
index 0e16d956e..b8a0c8a1e 100644
--- a/plugins/admin/groups/class_groupManagement.inc
+++ b/plugins/admin/groups/class_groupManagement.inc
@@ -29,7 +29,8 @@ class groupManagement extends simpleManagement
{
return array(
'plShortName' => _('Groups and roles'),
- 'plDescription' => _('Manage groups and roles'),
+ 'plTitle' => _('Manage groups and roles'),
+ 'plDescription' => _('Allows you to manage object groups, POSIX groups and roles'),
'plIcon' => 'geticon.php?context=types&icon=resource-group&size=48',
'plSection' => 'accounts',
'plManages' => array('ogroup', 'group', 'role'),
@@ -84,14 +85,14 @@ class groupManagement extends simpleManagement
if ($grouptab->is_this_account($attrs)) {
$infos = pluglist::pluginInfos($class);
if (isset($infos['plSmallIcon'])) {
- $result .= "<input class='center' type='image' src='".htmlentities($infos['plSmallIcon'], ENT_COMPAT, 'UTF-8')."' ".
- "alt='".$infos['plShortName']."' title='".$infos['plShortName']."' ".
- "name='listing_edit_tab_".$class."_$row' style='padding:1px'/>";
+ $result .= '<input class="center" type="image" src="'.htmlentities($infos['plSmallIcon'], ENT_COMPAT, 'UTF-8').'" '.
+ 'alt="'.$infos['plTitle'].'" title="'.$infos['plTitle'].'" '.
+ 'name="listing_edit_tab_'.$class.'_'.$row.'" style="padding:1px"/>';
} else {
@DEBUG (DEBUG_TRACE, __LINE__, __FUNCTION__, __FILE__, $infos['plShortName']." ($class)", 'No icon for');
}
} else {
- $result .= "<img src='images/empty.png' alt=' ' class='center optional $class' style='padding:1px'>";
+ $result .= '<img src="images/empty.png" alt=" " class="center optional '.$class.'" style="padding:1px"/>';
}
}
}
diff --git a/plugins/admin/users/class_userManagement.inc b/plugins/admin/users/class_userManagement.inc
index 1bce22dcc..973fb10b4 100644
--- a/plugins/admin/users/class_userManagement.inc
+++ b/plugins/admin/users/class_userManagement.inc
@@ -40,7 +40,8 @@ class userManagement extends simpleManagement
{
return array(
'plShortName' => _('Users'),
- 'plDescription' => _('Manage users'),
+ 'plTitle' => _('Manage users'),
+ 'plDescription' => _('Manage user accounts and their properties'),
'plIcon' => 'geticon.php?context=types&icon=user&size=48',
'plSection' => 'accounts',
'plManages' => array('user'),
diff --git a/plugins/config/class_configInLdap.inc b/plugins/config/class_configInLdap.inc
index 589253718..f562ca61d 100644
--- a/plugins/config/class_configInLdap.inc
+++ b/plugins/config/class_configInLdap.inc
@@ -55,7 +55,8 @@ class configInLdap extends simplePlugin
{
return array(
'plShortName' => _('Configuration'),
- 'plDescription' => _('FusionDirectory configuration'),
+ 'plTitle' => _('FusionDirectory configuration'),
+ 'plDescription' => _('Configuration screen of FusionDirectory'),
'plIcon' => 'geticon.php?context=categories&icon=settings&size=48',
'plObjectType' => array(
'configuration' => array(
diff --git a/setup/class_setup.inc b/setup/class_setup.inc
index 679e99fa9..d5c14362a 100644
--- a/setup/class_setup.inc
+++ b/setup/class_setup.inc
@@ -200,11 +200,11 @@ class setup
$step->update_strings();
- $s_title = $step->get_title();
- $s_info = $step->get_small_info();
- $b_active = $step->is_active();
- $b_enabled = $step->is_enabled();
- $b_completed = $step->is_completed();
+ $s_short_name = $step->get_short_name();
+ $s_description = $step->get_description();
+ $b_active = $step->is_active();
+ $b_enabled = $step->is_enabled();
+ $b_completed = $step->is_completed();
if ($b_completed) {
$s = '<img src="geticon.php?context=status&icon=task-complete&size=16" alt="'._('Completed').'" class="center optional"/> ';
@@ -214,19 +214,19 @@ class setup
if ($b_enabled) {
if ($b_active) {
- $str .= '<li class="menuitem menucurrent" title="'.$s_info.'">';
- $str .= '<a class="navigation_title">'.$s.$s_title.'</a>';
- $str .= '<a class="navigation_info">'.$s_info.'</a>';
+ $str .= '<li class="menuitem menucurrent" title="'.$s_description.'">';
+ $str .= '<a class="navigation_title">'.$s.$s_short_name.'</a>';
+ $str .= '<a class="navigation_info">'.$s_description.'</a>';
$str .= '</li>';
} else {
- $str .= '<li class="menuitem" title="'.$s_info.'">';
+ $str .= '<li class="menuitem" title="'.$s_description.'">';
$str .= '<a onClick="document.mainform.setup_goto_step.value=\''.$key.'\';document.mainform.submit();"
- class="navigation_title">'.$s.$s_title.'</a>';
+ class="navigation_title">'.$s.$s_short_name.'</a>';
$str .= '</li>';
}
} else {
- $str .= '<li class="menuitem disabled" title="'.$s_info.'">';
- $str .= '<a class="navigation_title">'.$s.$s_title.'</a>';
+ $str .= '<li class="menuitem disabled" title="'.$s_description.'">';
+ $str .= '<a class="navigation_title">'.$s.$s_short_name.'</a>';
$str .= '</li>';
}
}
@@ -259,7 +259,7 @@ class setup
/* Create header entry */
function get_header_text()
{
- return $this->o_steps[$this->i_current]->get_long_title();
+ return $this->o_steps[$this->i_current]->get_title();
}
/* Create header entry */
diff --git a/setup/class_setupStep.inc b/setup/class_setupStep.inc
index a8c25f884..eedf6f7b6 100644
--- a/setup/class_setupStep.inc
+++ b/setup/class_setupStep.inc
@@ -21,14 +21,14 @@
class setupStep extends simplePlugin
{
- protected $s_title = "Still undefined";
- protected $s_title_long = "Still undefined";
- protected $s_info = "Still undefined";
+ protected $s_short_name = 'Still undefined';
+ protected $s_title = 'Still undefined';
+ protected $s_description = 'Still undefined';
var $is_active = FALSE;
var $is_enabled = FALSE;
var $is_completed = FALSE;
- var $header_image = "";
+ var $header_image = '';
static function getAttributesInfo()
{
@@ -47,19 +47,19 @@ class setupStep extends simplePlugin
die('abstract method');
}
- function get_title()
+ function get_short_name()
{
- return $this->s_title;
+ return $this->s_short_name;
}
- function get_long_title()
+ function get_title()
{
- return $this->s_title_long;
+ return $this->s_title;
}
- function get_small_info()
+ function get_description()
{
- return $this->s_info;
+ return $this->s_description;
}
function is_active()
diff --git a/setup/class_setupStep_Checks.inc b/setup/class_setupStep_Checks.inc
index 81ee878b2..452aa6401 100644
--- a/setup/class_setupStep_Checks.inc
+++ b/setup/class_setupStep_Checks.inc
@@ -45,9 +45,9 @@ class Step_Checks extends setupStep
function update_strings()
{
- $this->s_title = _("Installation check");
- $this->s_title_long = _("Installation check");
- $this->s_info = _("Basic checks for PHP compatibility and extensions");
+ $this->s_short_name = _('Installation check');
+ $this->s_title = _('Installation check');
+ $this->s_description = _('Basic checks for PHP compatibility and extensions');
}
/* Execute and display template */
diff --git a/setup/class_setupStep_Config.inc b/setup/class_setupStep_Config.inc
index 1f78be00a..7e8f5b3ba 100644
--- a/setup/class_setupStep_Config.inc
+++ b/setup/class_setupStep_Config.inc
@@ -28,10 +28,10 @@ class Step_Config_before_init extends setupStep
$config->current['BASE'] = '';
}
$infos = configInLdap::plInfo();
- $this->header_image = $infos['plIcon'];
- $this->s_title = $infos['plShortName'];
- $this->s_title_long = $infos['plDescription'];
- $this->s_info = $infos['plDescription'];
+ $this->header_image = $infos['plIcon'];
+ $this->s_short_name = $infos['plShortName'];
+ $this->s_title = $infos['plTitle'];
+ $this->s_description = $infos['plDescription'];
}
}
@@ -64,19 +64,19 @@ class Step_Config extends configInLdap
$this->header_image = $infos['plIcon'];
}
- function get_title()
+ function get_short_name()
{
$infos = parent::plInfo();
- return $infos['plShortName'];
+ return $infos['plTitle'];
}
- function get_long_title()
+ function get_title()
{
$infos = parent::plInfo();
return $infos['plDescription'];
}
- function get_small_info()
+ function get_description()
{
$infos = parent::plInfo();
return $infos['plDescription'];
diff --git a/setup/class_setupStep_Finish.inc b/setup/class_setupStep_Finish.inc
index 3c3b02527..8ba5ab4aa 100644
--- a/setup/class_setupStep_Finish.inc
+++ b/setup/class_setupStep_Finish.inc
@@ -37,9 +37,9 @@ class Step_Finish extends setupStep
function update_strings()
{
- $this->s_title = _('Finish');
- $this->s_info = _('Write configuration file');
- $this->s_title_long = _('Finish - write the configuration file');
+ $this->s_short_name = _('Finish');
+ $this->s_title = _('Finish - write the configuration file');
+ $this->s_description = _('Write configuration file');
}
function get_conf_data()
diff --git a/setup/class_setupStep_Language.inc b/setup/class_setupStep_Language.inc
index 54293b2b5..54cee763e 100644
--- a/setup/class_setupStep_Language.inc
+++ b/setup/class_setupStep_Language.inc
@@ -56,10 +56,10 @@ class Step_Language extends setupStep
function update_strings()
{
- $this->s_title = _("Language setup");
- $this->s_title_long = _("Language setup");
- $this->s_info = _("This step allows you to select your preferred language.");
- $this->msg = _('At this point, you can select the site wide default language. Choosing "automatic" will use the language requested by the browser. This setting can be overriden per user.');
+ $this->s_short_name = _('Language setup');
+ $this->s_title = _('Language setup');
+ $this->s_description = _('This step allows you to select your preferred language.');
+ $this->msg = _('At this point, you can select the site wide default language. Choosing "automatic" will use the language requested by the browser. This setting can be overriden per user.');
}
function execute()
diff --git a/setup/class_setupStep_Ldap.inc b/setup/class_setupStep_Ldap.inc
index fef615175..855685167 100644
--- a/setup/class_setupStep_Ldap.inc
+++ b/setup/class_setupStep_Ldap.inc
@@ -104,9 +104,9 @@ class Step_Ldap extends setupStep
function update_strings()
{
- $this->s_title = _("LDAP setup");
- $this->s_title_long = _("LDAP connection setup");
- $this->s_info = _("This dialog performs the basic configuration of the LDAP connectivity for FusionDirectory.");
+ $this->s_short_name = _('LDAP setup');
+ $this->s_title = _('LDAP connection setup');
+ $this->s_description = _('This dialog performs the basic configuration of the LDAP connectivity for FusionDirectory.');
}
function update_base_choices()
diff --git a/setup/class_setupStep_Migrate.inc b/setup/class_setupStep_Migrate.inc
index 3d807cf47..3dba83604 100644
--- a/setup/class_setupStep_Migrate.inc
+++ b/setup/class_setupStep_Migrate.inc
@@ -220,9 +220,9 @@ class Step_Migrate extends setupStep
function update_strings()
{
- $this->s_title = _("LDAP inspection");
- $this->s_title_long = _("LDAP inspection");
- $this->s_info = _("Analyze your current LDAP for FusionDirectory compatibility");
+ $this->s_short_name = _('LDAP inspection');
+ $this->s_title = _('LDAP inspection');
+ $this->s_description = _('Analyze your current LDAP for FusionDirectory compatibility');
}
function fill_defaultRoles()
diff --git a/setup/class_setupStep_Welcome.inc b/setup/class_setupStep_Welcome.inc
index 6403c0746..909a10a30 100644
--- a/setup/class_setupStep_Welcome.inc
+++ b/setup/class_setupStep_Welcome.inc
@@ -47,9 +47,9 @@ class Step_Welcome extends setupStep
/* We need to init them with a method to be able to use _() */
function update_strings()
{
- $this->s_title = _("Welcome");
- $this->s_info = _("The welcome message");
- $this->s_title_long = _("Welcome to FusionDirectory setup wizard");
+ $this->s_short_name = _('Welcome');
+ $this->s_title = _('Welcome to FusionDirectory setup wizard');
+ $this->s_description = _('The welcome message');
}
function execute()
--
GitLab