MDL-20712 using just $capablities for capability definition array, al…

…l other files in db/* do not use component names in definition array; old capability array names are of course supported
ralferlebach · Nov 4, 2009 · 0ac940b · 0ac940b
1 parent e3acc8a
commit 0ac940b
Show file tree

Hide file tree

Showing 64 changed files with 92 additions and 124 deletions.
diff --git a/admin/report/courseoverview/db/access.php b/admin/report/courseoverview/db/access.php
@@ -23,7 +23,7 @@
 //                                                                       //
 ///////////////////////////////////////////////////////////////////////////
 
-$report_courseoverview_capabilities = array(
+$capabilities = array(
 
     'report/courseoverview:view' => array(
         'riskbitmask' => RISK_PERSONAL,

diff --git a/admin/report/questioninstances/db/access.php b/admin/report/questioninstances/db/access.php
@@ -23,7 +23,7 @@
 //                                                                       //
 ///////////////////////////////////////////////////////////////////////////
 
-$report_questioninstances_capabilities = array(
+$capabilities = array(
 
     'report/questioninstances:view' => array(
         'captype' => 'read',

diff --git a/admin/report/security/db/access.php b/admin/report/security/db/access.php
@@ -23,7 +23,7 @@
 //                                                                       //
 ///////////////////////////////////////////////////////////////////////////
 
-$report_security_capabilities = array(
+$capabilities = array(
 
     'report/security:view' => array(
         'riskbitmask' => RISK_CONFIG,

diff --git a/admin/report/unittest/db/access.php b/admin/report/unittest/db/access.php
@@ -23,7 +23,7 @@
 //                                                                       //
 ///////////////////////////////////////////////////////////////////////////
 
-$report_unittest_capabilities = array(
+$capabilities = array(
 
     'report/unittest:view' => array(
         'riskbitmask' => RISK_DATALOSS,

diff --git a/blocks/online_users/db/access.php b/blocks/online_users/db/access.php
@@ -23,7 +23,7 @@
 //                                                                       //
 ///////////////////////////////////////////////////////////////////////////
 
-$block_online_users_capabilities = array(
+$capabilities = array(
 
     'block/online_users:viewlist' => array(
 

diff --git a/blocks/rss_client/db/access.php b/blocks/rss_client/db/access.php
@@ -14,7 +14,7 @@
 //
 // It is important that capability names are unique. The naming convention
 // for capabilities that are specific to modules and blocks is as follows:
-//   [mod/block]/<component_name>:<capabilityname>
+//   [mod/block]/<plugin_name>:<capabilityname>
 //
 // component_name should be the same as the directory name of the mod or block.
 //
@@ -25,13 +25,10 @@
 //           block/recent_activity:view
 //           moodle/site:deleteuser
 //
-// The variable name for the capability definitions array follows the format
-//   $<componenttype>_<component_name>_capabilities
-//
-// For the core capabilities, the variable is $moodle_capabilities.
+// The variable name for the capability definitions array is $capabilities
 
 
-$block_rss_client_capabilities = array(
+$capabilities = array(
 
     'block/rss_client:manageownfeeds' => array(
 

diff --git a/course/report/log/db/access.php b/course/report/log/db/access.php
@@ -23,7 +23,7 @@
 //                                                                       //
 ///////////////////////////////////////////////////////////////////////////
 
-$coursereport_log_capabilities = array(
+$capabilities = array(
 
     'coursereport/log:view' => array(
         'riskbitmask' => RISK_PERSONAL,

diff --git a/course/report/outline/db/access.php b/course/report/outline/db/access.php
@@ -23,7 +23,7 @@
 //                                                                       //
 ///////////////////////////////////////////////////////////////////////////
 
-$coursereport_outline_capabilities = array(
+$capabilities = array(
 
     'coursereport/outline:view' => array(
         'riskbitmask' => RISK_PERSONAL,

diff --git a/course/report/participation/db/access.php b/course/report/participation/db/access.php
@@ -23,7 +23,7 @@
 //                                                                       //
 ///////////////////////////////////////////////////////////////////////////
 
-$coursereport_participation_capabilities = array(
+$capabilities = array(
 
     'coursereport/participation:view' => array(
         'riskbitmask' => RISK_PERSONAL,

diff --git a/course/report/progress/db/access.php b/course/report/progress/db/access.php
@@ -23,7 +23,7 @@
 //                                                                       //
 ///////////////////////////////////////////////////////////////////////////
 
-$coursereport_progress_capabilities = array(
+$capabilities = array(
 
     'coursereport/progress:view' => array(
         'riskbitmask' => RISK_PERSONAL,

diff --git a/course/report/stats/db/access.php b/course/report/stats/db/access.php
@@ -23,7 +23,7 @@
 //                                                                       //
 ///////////////////////////////////////////////////////////////////////////
 
-$coursereport_stats_capabilities = array(
+$capabilities = array(
 
     'coursereport/stats:view' => array(
         'riskbitmask' => RISK_PERSONAL,

diff --git a/enrol/authorize/db/access.php b/enrol/authorize/db/access.php
@@ -1,6 +1,6 @@
 <?php
 
-$enrol_authorize_capabilities = array(
+$capabilities = array(
 
     'enrol/authorize:managepayments' => array(
         'riskbitmask' => RISK_PERSONAL,

diff --git a/grade/export/ods/db/access.php b/grade/export/ods/db/access.php
@@ -15,7 +15,7 @@
 // You should have received a copy of the GNU General Public License
 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
 
-$gradeexport_ods_capabilities = array(
+$capabilities = array(
 
     'gradeexport/ods:view' => array(
         'riskbitmask' => RISK_PERSONAL,

diff --git a/grade/export/txt/db/access.php b/grade/export/txt/db/access.php
@@ -15,7 +15,7 @@
 // You should have received a copy of the GNU General Public License
 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
 
-$gradeexport_txt_capabilities = array(
+$capabilities = array(
 
     'gradeexport/txt:view' => array(
         'riskbitmask' => RISK_PERSONAL,

diff --git a/grade/export/xls/db/access.php b/grade/export/xls/db/access.php
@@ -15,7 +15,7 @@
 // You should have received a copy of the GNU General Public License
 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
 
-$gradeexport_xls_capabilities = array(
+$capabilities = array(
 
     'gradeexport/xls:view' => array(
         'riskbitmask' => RISK_PERSONAL,

diff --git a/grade/export/xml/db/access.php b/grade/export/xml/db/access.php
@@ -15,7 +15,7 @@
 // You should have received a copy of the GNU General Public License
 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
 
-$gradeexport_xml_capabilities = array(
+$capabilities = array(
 
     'gradeexport/xml:view' => array(
         'riskbitmask' => RISK_PERSONAL,

diff --git a/grade/import/csv/db/access.php b/grade/import/csv/db/access.php
@@ -15,7 +15,7 @@
 // You should have received a copy of the GNU General Public License
 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
 
-$gradeimport_csv_capabilities = array(
+$capabilities = array(
 
     'gradeimport/csv:view' => array(
         'captype' => 'write',

diff --git a/grade/import/xml/db/access.php b/grade/import/xml/db/access.php
@@ -15,7 +15,7 @@
 // You should have received a copy of the GNU General Public License
 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
 
-$gradeimport_xml_capabilities = array(
+$capabilities = array(
 
     'gradeimport/xml:view' => array(
         'captype' => 'write',

diff --git a/grade/report/grader/db/access.php b/grade/report/grader/db/access.php
@@ -15,7 +15,7 @@
 // You should have received a copy of the GNU General Public License
 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
 
-$gradereport_grader_capabilities = array(
+$capabilities = array(
 
     'gradereport/grader:view' => array(
         'riskbitmask' => RISK_PERSONAL,

diff --git a/grade/report/outcomes/db/access.php b/grade/report/outcomes/db/access.php
@@ -15,7 +15,7 @@
 // You should have received a copy of the GNU General Public License
 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
 
-$gradereport_outcomes_capabilities = array(
+$capabilities = array(
 
     'gradereport/outcomes:view' => array(
         'riskbitmask' => RISK_PERSONAL,

diff --git a/grade/report/overview/db/access.php b/grade/report/overview/db/access.php
@@ -15,7 +15,7 @@
 // You should have received a copy of the GNU General Public License
 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
 
-$gradereport_overview_capabilities = array(
+$capabilities = array(
 
     'gradereport/overview:view' => array(
         'riskbitmask' => RISK_PERSONAL,

diff --git a/grade/report/user/db/access.php b/grade/report/user/db/access.php
@@ -15,7 +15,7 @@
 // You should have received a copy of the GNU General Public License
 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
 
-$gradereport_user_capabilities = array(
+$capabilities = array(
 
     'gradereport/user:view' => array(
         'riskbitmask' => RISK_PERSONAL,

diff --git a/lib/accesslib.php b/lib/accesslib.php
@@ -3177,7 +3177,11 @@ function load_capability_def($component) {
     $capabilities = array();
     if (file_exists($defpath)) {
         require($defpath);
-        $capabilities = ${$component.'_capabilities'};
+        if (!empty(${$component.'_capabilities'})) {
+            // legacy capability array name
+            // since 2.0 we prefer $capabilities instead - it is easier to use and matches db/* files
+            $capabilities = ${$component.'_capabilities'};
+        }
     }
 
     return $capabilities;

diff --git a/lib/db/access.php b/lib/db/access.php
@@ -14,7 +14,7 @@
 //
 // It is important that capability names are unique. The naming convention
 // for capabilities that are specific to modules and blocks is as follows:
-//   [mod/block]/<component_name>:<capabilityname>
+//   [mod/block]/<plugin_name>:<capabilityname>
 //
 // component_name should be the same as the directory name of the mod or block.
 //
@@ -25,13 +25,10 @@
 //           block/recent_activity:view
 //           moodle/site:deleteuser
 //
-// The variable name for the capability definitions array follows the format
-//   $<componenttype>_<component_name>_capabilities
-//
-// For the core capabilities, the variable is $moodle_capabilities.
+// The variable name for the capability definitions array is $capabilities
 
 
-$moodle_capabilities = array(
+$capabilities = array(
 
     'moodle/site:doanything' => array(
 

diff --git a/mod/assignment/db/access.php b/mod/assignment/db/access.php
@@ -14,7 +14,7 @@
 //
 // It is important that capability names are unique. The naming convention
 // for capabilities that are specific to modules and blocks is as follows:
-//   [mod/block]/<component_name>:<capabilityname>
+//   [mod/block]/<plugin_name>:<capabilityname>
 //
 // component_name should be the same as the directory name of the mod or block.
 //
@@ -25,13 +25,10 @@
 //           block/recent_activity:view
 //           moodle/site:deleteuser
 //
-// The variable name for the capability definitions array follows the format
-//   $<componenttype>_<component_name>_capabilities
-//
-// For the core capabilities, the variable is $moodle_capabilities.
+// The variable name for the capability definitions array is $capabilities
 
 
-$mod_assignment_capabilities = array(
+$capabilities = array(
 
     'mod/assignment:view' => array(
 

diff --git a/mod/chat/db/access.php b/mod/chat/db/access.php
@@ -14,7 +14,7 @@
 //
 // It is important that capability names are unique. The naming convention
 // for capabilities that are specific to modules and blocks is as follows:
-//   [mod/block]/<component_name>:<capabilityname>
+//   [mod/block]/<plugin_name>:<capabilityname>
 //
 // component_name should be the same as the directory name of the mod or block.
 //
@@ -25,13 +25,10 @@
 //           block/recent_activity:view
 //           moodle/site:deleteuser
 //
-// The variable name for the capability definitions array follows the format
-//   $<componenttype>_<component_name>_capabilities
-//
-// For the core capabilities, the variable is $moodle_capabilities.
+// The variable name for the capability definitions array is $capabilities
 
 
-$mod_chat_capabilities = array(
+$capabilities = array(
 
     'mod/chat:chat' => array(
 

diff --git a/mod/choice/db/access.php b/mod/choice/db/access.php
@@ -14,7 +14,7 @@
 //
 // It is important that capability names are unique. The naming convention
 // for capabilities that are specific to modules and blocks is as follows:
-//   [mod/block]/<component_name>:<capabilityname>
+//   [mod/block]/<plugin_name>:<capabilityname>
 //
 // component_name should be the same as the directory name of the mod or block.
 //
@@ -25,13 +25,10 @@
 //           block/recent_activity:view
 //           moodle/site:deleteuser
 //
-// The variable name for the capability definitions array follows the format
-//   $<componenttype>_<component_name>_capabilities
-//
-// For the core capabilities, the variable is $moodle_capabilities.
+// The variable name for the capability definitions array is $capabilities
 
 
-$mod_choice_capabilities = array(
+$capabilities = array(
 
     'mod/choice:choose' => array(
 

diff --git a/mod/data/db/access.php b/mod/data/db/access.php
@@ -14,7 +14,7 @@
 //
 // It is important that capability names are unique. The naming convention
 // for capabilities that are specific to modules and blocks is as follows:
-//   [mod/block]/<component_name>:<capabilityname>
+//   [mod/block]/<plugin_name>:<capabilityname>
 //
 // component_name should be the same as the directory name of the mod or block.
 //
@@ -25,13 +25,10 @@
 //           block/recent_activity:view
 //           moodle/site:deleteuser
 //
-// The variable name for the capability definitions array follows the format
-//   $<componenttype>_<component_name>_capabilities
-//
-// For the core capabilities, the variable is $moodle_capabilities.
+// The variable name for the capability definitions array is $capabilities
 
 
-$mod_data_capabilities = array(
+$capabilities = array(
 
     'mod/data:viewentry' => array(
 

diff --git a/mod/feedback/db/access.php b/mod/feedback/db/access.php
@@ -14,7 +14,7 @@
 //
 // It is important that capability names are unique. The naming convention
 // for capabilities that are specific to modules and blocks is as follows:
-//   [mod/block]/<component_name>:<capabilityname>
+//   [mod/block]/<plugin_name>:<capabilityname>
 //
 // component_name should be the same as the directory name of the mod or block.
 //
@@ -25,13 +25,10 @@
 //           block/recent_activity:view
 //           moodle/site:deleteuser
 //
-// The variable name for the capability definitions array follows the format
-//   $<componenttype>_<component_name>_capabilities
-//
-// For the core capabilities, the variable is $moodle_capabilities.
+// The variable name for the capability definitions array is $capabilities
 
 
-$mod_feedback_capabilities = array(
+$capabilities = array(
 
     'mod/feedback:view' => array(
 

diff --git a/mod/folder/db/access.php b/mod/folder/db/access.php
@@ -23,7 +23,7 @@
  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 
-$mod_folder_capabilities = array(
+$capabilities = array(
 /* TODO: review public portfolio API first!
     'mod/folder:portfolioexport' => array(