Changeset 4315

Timestamp:

11/01/2016 08:58:38 PM (8 years ago)

Author:

iandunn

Message:

CampTix Badge Generator: Acesss post meta through WP_Post's magic getter

This is much cleaner and more readable than manually calling get_post_meta().

Location:

sites/trunk/wordcamp.org/public_html/wp-content/plugins/camptix-badge-generator

Files:

• TODO.md (modified) (2 diffs)
• includes/html-badges.php (modified) (5 diffs)
• javascript/html-badges-previewer.js (modified) (1 diff)
• views/html-badges/template-badges.php (modified) (1 diff)
• views/html-badges/template-part-badge-contents.php (modified) (2 diffs)

sites/trunk/wordcamp.org/public_html/wp-content/plugins/camptix-badge-generator/TODO.md

@@ -1 +1 @@
 ## HTML v2
- 
+
 * page-breaking issues in chrome/safari
     * lots of potential solutions on StackOverflow, but none worked so far.
@@ -18 +18 @@
 * add checkbox to include twitter, option to pick arbitrary image, option for name instead of image, etc
     * can use the [gear] icon like the Menus section does
-    
+
 * move documentation from make/comm/handbook to a `?` icon like menu/widget panels have.
     * might need custom section markup for that.

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

@@ -12 +12 @@
 add_action( 'wp_enqueue_scripts',    __NAMESPACE__ . '\enqueue_previewer_scripts',   999 );  // after remove_all_previewer_styles()
 add_filter( 'template_include',      __NAMESPACE__ . '\use_badges_template'              );
+add_filter( 'get_post_metadata',     __NAMESPACE__ . '\add_dynamic_post_meta', 10, 3     );
 
 /**
@@ -176 +177 @@
  */
 function is_badges_preview() {
+    /** @global \WP_Customize_Manager $wp_customize */
     global $wp_customize;
 
@@ -204 +206 @@
  */
 function render_badges_template() {
-    /** @var $camptix \CampTix_Plugin */
+    /** @global \CampTix_Plugin $camptix */
     global $camptix;
-    
+
     $allowed_html = array(
         'span' => array(
@@ -212 +214 @@
         ),
     );
-    
+
     $attendees = get_posts( array(
         'post_type'      => 'tix_attendee',
@@ -223 +225 @@
 
 /**
- * Get all the data required to render an attendee badge
+ * Add dynamically-generated "post meta" to `\WP_Post` objects
+ *
+ * This makes it possible to access dynamic data related to a post object by simply referencing `$post->foo`.
+ * That keeps the calling code much cleaner than if it were to have to do something like
+ * `$foo = some_custom_logic( get_post_meta( $post->ID, 'bar', true ) ); echo esc_html( $foo )`.
+ *
+ * @param mixed  $value
+ * @param int    $post_id
+ * @param string $meta_key
+ *
+ * @return mixed
+ *      `null` to instruct `get_metadata()` to pull the value from the database
+ *      Any non-null value will be returned as if it were pulled from the database
+ */
+function add_dynamic_post_meta( $value, $post_id, $meta_key ) {
+    /** @global \CampTix_Plugin $camptix */
+    global $camptix;
+
+    $attendee = get_post( $post_id );
+
+    if ( 'tix_attendee' != $attendee->post_type ) {
+        return $value;
+    }
+
+    switch ( $meta_key ) {
+        case 'avatar_url':
+            $value = get_avatar_url( $attendee->tix_email, array( 'size' => 600 ) );
+            break;
+
+        case 'css_classes':
+            $value = get_css_classes( $attendee );
+            break;
+
+        case 'formatted_name':
+            $value = $camptix->format_name_string(
+                '<span class="first-name">%first%</span>
+                 <span class="last-name">%last%</span>',
+                $attendee->tix_first_name,
+                $attendee->tix_last_name
+            );
+            break;
+    }
+
+    return $value;
+}
+
+/**
+ * Get the CSS classes for an attendee element
  *
  * @param \WP_Post $attendee
  *
- * @return array
- */
-function get_attendee_data( $attendee ) {
-    /** @var $camptix \CampTix_Plugin */
-    global $camptix;
-    $css_classes = array( 'attendee-' . $attendee->post_name );
-
-    $first_name     = get_post_meta( $attendee->ID, 'tix_first_name', true );
-    $last_name      = get_post_meta( $attendee->ID, 'tix_last_name',  true );
-    $formatted_name = $camptix->format_name_string(
-        '<span class="first-name">%first%</span>
-         <span class="last-name">%last%</span>',
-        $first_name,
-        $last_name
-    );
-
-    $email_address = get_post_meta( $attendee->ID, 'tix_email', true );
-    $avatar_url    = get_avatar_url( $email_address, array( 'size' => 600 ) );
-
-    $ticket        = get_post( get_post_meta( $attendee->ID, 'tix_ticket_id', true ) );
-    $css_classes[] = 'ticket-' . $ticket->post_name;
-
-    $coupon_id = get_post_meta( $attendee->ID, 'tix_coupon_id', true );
-    if ( $coupon_id ) {
-        $coupon        = get_post( $coupon_id );
-        $css_classes[] = 'coupon-' . $coupon->post_name;
-    }
-
-    $css_classes = implode( ' ', $css_classes );
-
-    return compact( 'formatted_name', 'email_address', 'avatar_url', 'css_classes' );
+ * @return string
+ */
+function get_css_classes( $attendee ) {
+    // Name
+    $classes = array( 'attendee-' . $attendee->post_name );
+
+    // Ticket
+    $ticket    = get_post( $attendee->tix_ticket_id );
+    $classes[] = 'ticket-' . $ticket->post_name;
+
+    // Coupon
+    if ( $attendee->tix_coupon_id ) {
+        $coupon    = get_post( $attendee->tix_coupon_id );
+        $classes[] = 'coupon-' . $coupon->post_name;
+    }
+
+    return implode( ' ', $classes );
 }
 

sites/trunk/wordcamp.org/public_html/wp-content/plugins/camptix-badge-generator/javascript/html-badges-previewer.js

@@ -5 +5 @@
         removedCSS : false
     };
-    
+
     /**
      * Initialize

sites/trunk/wordcamp.org/public_html/wp-content/plugins/camptix-badge-generator/views/html-badges/template-badges.php

@@ -30 +30 @@
         else :
 
-            foreach ( $attendees as $attendee_id ) :
-                $attendee_data = get_attendee_data( $attendee_id );
-                
+            foreach ( $attendees as $attendee ) :
                 ?>
 
-                <article class="attendee <?php echo esc_attr( $attendee_data['css_classes'] ); ?>">
+                <article class="attendee <?php echo esc_attr( $attendee->css_classes ); ?>">
                     <section class="badge badge-back">
                         <?php require( __DIR__ . '/template-part-badge-contents.php' ); ?>

sites/trunk/wordcamp.org/public_html/wp-content/plugins/camptix-badge-generator/views/html-badges/template-part-badge-contents.php

@@ -3 +3 @@
 namespace CampTix\Badge_Generator\HTML;
 defined( 'WPINC' ) or die();
+
+/**
+ * @var \WP_Post $attendee
+ * @var array    $allowed_html
+ */
 
 ?>
@@ -21 +26 @@
     <img
         class="attendee-avatar"
-        src="<?php echo esc_url( $attendee_data['avatar_url'] ); ?>"
-        alt="<?php echo esc_attr( strip_tags( $attendee_data['formatted_name'] ) ); ?>"
+        src="<?php echo esc_url( $attendee->avatar_url ); ?>"
+        alt="<?php echo esc_attr( strip_tags( $attendee->formatted_name ) ); ?>"
     />
 
     <figcaption>
         <h1 class="attendee-name">
-            <?php echo wp_kses( $attendee_data['formatted_name'], $allowed_html ); ?>
+            <?php echo wp_kses( $attendee->formatted_name, $allowed_html ); ?>
         </h1>
     </figcaption>