Changeset 3692

Timestamp:

07/17/2016 11:14:42 AM (9 years ago)

Author:

ocean90

Message:

Translate, Rosetta Roles: Improve docs and return always an array in WPorg_GP_Rosetta_Roles::get_project_id_access_list().

File:

• sites/trunk/wordpress.org/public_html/wp-content/plugins/wporg-gp-rosetta-roles/wporg-gp-rosetta-roles.php (modified) (7 diffs)

sites/trunk/wordpress.org/public_html/wp-content/plugins/wporg-gp-rosetta-roles/wporg-gp-rosetta-roles.php

@@ -69 +69 @@
         }
 
-        if ( $args['action'] !== 'approve' || ! in_array( $args['object_type'], array( 'project|locale|set-slug', 'translation-set' ) ) ) {
+        if ( 'approve' !== $args['action'] || ! in_array( $args['object_type'], array( 'project|locale|set-slug', 'translation-set' ) ) ) {
             return false;
         }
@@ -82 +82 @@
         $current_project_id = $locale_and_project_id->project_id;
 
-        // Simple check to see if they're an approver or not
+        // Simple check to see if they're an approver or not.
         if ( ! $this->is_approver_for_locale( $args['user_id'], $locale_slug ) ) {
             return false;
         }
 
-        // Grab the list of Projects (or 'all') that the user can approve
+        // Grab the list of Projects (or 'all') that the user can approve.
         $project_access_list = $this->get_project_id_access_list( $args['user_id'], $locale_slug );
         if ( ! $project_access_list ) {
@@ -127 +127 @@
 
     /**
-     * Determine if a given user is a Global Admin.
+     * Determines if a given user is a Global Admin.
      *
      * Users present as an administrator on global.wordpress.org are treated as a
      * global administrator in GlotPress.
      *
-     * @param int $user A BackPress User object or user ID for the user to check.
-     *
-     * @return bool
+     * @param int $user_id User ID.
+     * @return bool True, if user is an admin, false if not.
      */
     public function is_global_administrator( $user_id ) {
@@ -148 +147 @@
 
     /**
-     * Determine if a given user is a Translation Approver for a Locale.
-     *
-     * @param int $user A BackPress User object or user ID for the user to check.
-     *
-     * @return bool
+     * Determines if a given user is a Translation Approver for a Locale.
+     *
+     * @param int    $user_id     User ID.
+     * @param string $locale_slug The Locale for which we are checking.
+     * @return bool True, if user is an approver, false if not.
      */
     public function is_approver_for_locale( $user_id, $locale_slug ) {
@@ -191 +190 @@
 
     /**
-     * Retrieve a list of Project ID's which the current user can approve for.
+     * Retrieves a list of project ID's which a user can approve for.
      *
      * This is likely to be incorrrect in the event that the user is a Translation Editor or Global Admin.
      * The array item 'all' is special, which means to allow access to all projects.
      *
-     * @param int    $user            A BackPress User object or user ID for the user to check.
-     * @param string $locale_slug     The Locale for which we are checking
-     * @param int    $include_children Whether to include the children project ID's in the return
-     *
+     * @param int    $user_id          User ID.
+     * @param string $locale_slug      The Locale for which we are checking.
+     * @param bool   $include_children Whether to include the children project ID's in the return.
      * @return array A list of the Project ID's for which the current user can approve translations for.
      */
@@ -227 +225 @@
 
         if ( ! $project_access_list ) {
-            return false;
+            return array();
         }
 
@@ -382 +380 @@
      * @param string $object_type Current object type.
      * @param string $object_id   Current object ID.
-     * @return array Locale and project ID.
+     * @return array|false Locale and project ID, false on failure.
      */
     public function get_locale_and_project_id( $object_type, $object_id ) {