Changeset 7915 for sites/trunk/wordcamp.org/public_html/wp-content/plugins/camptix-badge-generator/includes/indesign-badges.php

Timestamp:

11/29/2018 03:19:31 AM (8 years ago)

Author:

iandunn

Message:

CampTix Badge Generator: Apply coding standards.

File:

• sites/trunk/wordcamp.org/public_html/wp-content/plugins/camptix-badge-generator/includes/indesign-badges.php (modified) (19 diffs)

sites/trunk/wordcamp.org/public_html/wp-content/plugins/camptix-badge-generator/includes/indesign-badges.php

@@ -2 +2 @@
 
 namespace CampTix\Badge_Generator\InDesign;
-use \CampTix\Badge_Generator;
-use \CampTix\Badge_Generator\HTML;
-use \WordCamp\Logger;
+use Exception;
+use CampTix_Plugin;
+use CampTix\Badge_Generator;
+use CampTix\Badge_Generator\HTML;
+use WordCamp\Logger;
 use WordCamp\Utilities;
 
-defined( 'WPINC' ) or die();
+defined( 'WPINC' ) || die();
 
 add_action( 'camptix_menu_tools_indesign_badges', __NAMESPACE__ . '\render_indesign_page' );
@@ -28 +30 @@
  *
  * @param array $options
+ *
+ * @throws Exception
  */
 function build_assets( $options ) {
@@ -53 +57 @@
                 create_zip_file( $zip_filename, $zip_local_folder, $csv_filename, $gravatar_folder );
         } finally {
-                // todo Delete contents of $assets_folder, then rmdir( $assets_folder );
+                // todo Delete contents of $assets_folder, then rmdir( $assets_folder );.
         }
 }
@@ -65 +69 @@
  * @param string $gravatar_folder
  *
- * @throws \Exception
+ * @throws Exception
  */
 function download_gravatars( $attendees, $gravatar_folder ) {
@@ -87 +91 @@
                 if ( ! $gravatar_file ) {
                         Logger\log( 'gravatar_open_failed', compact( 'attendee', 'gravatar_folder', 'filename' ) );
-                        throw new \Exception( __( "Couldn't save all Gravatars.", 'wordcamporg' ) );
+                        throw new Exception( __( "Couldn't save all Gravatars.", 'wordcamporg' ) );
                 }
 
@@ -112 +116 @@
  * @todo Update this to use wcorg_redundant_remote_get() instead, for DRYness
  *
- * @throws \Exception when the HTTP request fails
+ * @throws Exception when the HTTP request fails
  */
 function download_single_gravatar( $request_url ) {
@@ -124 +128 @@
                 $retry_after = min( $retry_after * $attempt_count, 30 );
 
-                // A 404 is expected when the attendee doesn't have a Gravatar setup, so don't retry them
+                // A 404 is expected when the attendee doesn't have a Gravatar setup, so don't retry them.
                 if ( 404 == $status_code ) {
                         return false;
@@ -134 +138 @@
 
                 if ( is_array( $response ) && isset( $response['body'] ) ) {
-                        $response['body'] = '[redacted]'; // Avoid cluttering the logs with a ton of binary data
+                        $response['body'] = '[redacted]'; // Avoid cluttering the logs with a ton of binary data.
                 }
 
@@ -142 +146 @@
                 } else {
                         Logger\log( 'request_failed_permenantly', compact( 'request_url', 'response' ) );
-                        throw new \Exception( __( "Couldn't download all Gravatars.", 'wordcamporg' ) );
+                        throw new Exception( __( "Couldn't download all Gravatars.", 'wordcamporg' ) );
                 }
 
@@ -170 +174 @@
  * Get the filename for the Zip file
  *
- * @param $assets_folder
+ * @param string $assets_folder
  *
  * @return string
@@ -197 +201 @@
  * @param string $gravatar_folder
  *
- * @throws \Exception
+ * @throws Exception
  */
 function generate_csv( $csv_filename, $zip_local_folder, $attendees, $gravatar_folder ) {
-        /** @var \CampTix_Plugin $camptix */
+        /** @var CampTix_Plugin $camptix */
         global $camptix;
 
@@ -211 +215 @@
         if ( ! $csv_handle ) {
                 Logger\log( 'open_csv_failed' );
-                throw new \Exception( __( "Couldn't open CSV file.", 'wordcamporg' ) );
+                throw new Exception( __( "Couldn't open CSV file.", 'wordcamporg' ) );
         }
 
@@ -235 +239 @@
  */
 function get_admin_flags() {
-        /** @var \CampTix_Plugin $camptix */
+        /** @var CampTix_Plugin $camptix */
         global $camptix;
 
@@ -280 +284 @@
         $row = array();
 
-        if ( 'unknown.attendee@example.org' == $attendee->tix_email ) {
+        if ( 'unknown.attendee@example.org' === $attendee->tix_email ) {
                 return $row;
         }
@@ -327 +331 @@
  */
 function get_twitter_username( $attendee ) {
-        /** @global \CampTix_Plugin $camptix */
+        /** @global CampTix_Plugin $camptix */
         global $camptix;
 
@@ -353 +357 @@
  * @param string $username
  * @param string $first_name
- * @param string $empty_mode 'replace' to replace empty usernames with first names
+ * @param string $empty_mode 'replace' to replace empty usernames with first names.
  *
  * @return string
  */
 function format_twitter_username( $username, $first_name, $empty_mode = '' ) {
-        if ( empty ( $username ) ) {
+        if ( empty( $username ) ) {
                 if ( 'replace' === $empty_mode ) {
                         $username = $first_name;
                 }
         } else {
-                // Strip out everything but the username, and prefix a @
+                // Strip out everything but the username, and prefix a `@` character.
                 $username = '@' . preg_replace(
                         '/
@@ -408 +412 @@
  * @param string $gravatar_folder
  *
- * @throws \Exception
+ * @throws Exception
  */
 function create_zip_file( $zip_filename, $zip_local_folder, $csv_filename, $gravatar_folder ) {
         if ( ! class_exists( 'ZipArchive') ) {
                 Logger\log( 'zip_ext_not_installed' );
-                throw new \Exception( __( 'The Zip extension for PHP is not installed.', 'wordcamporg' ) );
+                throw new Exception( __( 'The Zip extension for PHP is not installed.', 'wordcamporg' ) );
         }
 
@@ -421 +425 @@
         if ( true !== $open_status ) {
                 Logger\log( 'zip_open_failed', compact( 'zip_filename', 'open_status' ) );
-                throw new \Exception( __( 'The Zip file could not be created.', 'wordcamporg' ) );
+                throw new Exception( __( 'The Zip file could not be created.', 'wordcamporg' ) );
         }
 
@@ -453 +457 @@
  * @param string $filename
  *
- * @throws \Exception
+ * @throws Exception
  */
 function serve_zip_file( $filename ) {
         if ( ! current_user_can( Badge_Generator\REQUIRED_CAPABILITY ) ) {
                 Logger\log( 'access_denied' );
-                throw new \Exception( __( "You don't have authorization to perform this action.", 'wordcamporg' ) );
+                throw new Exception( __( "You don't have authorization to perform this action.", 'wordcamporg' ) );
         }