Changeset 2784

Timestamp:

03/23/2016 10:04:20 PM (11 years ago)

Author:

iandunn

Message:

WordCamp Post Type: Log status changes and notes.

Location:

sites/branches/application-tracking/wordcamp.org/public_html/wp-content/plugins/wcpt

Files:

• wcpt-functions.php (modified) (1 diff)
• wcpt-wordcamp/wordcamp-admin.php (modified) (5 diffs)

sites/branches/application-tracking/wordcamp.org/public_html/wp-content/plugins/wcpt/wcpt-functions.php

@@ -86 +86 @@
 }
 
-?>
+/**
+ * Render the Log metabox
+ *
+ * @param WP_Post $post
+ */
+function wcpt_log_metabox( $post ) {
+        $entries = wcpt_get_log_entries( $post->ID );
+
+        require_once( __DIR__ . '/views/common/metabox-log.php' );
+}
+
+/**
+ * Get all the the entries
+ *
+ * @param int $wordcamp_id
+ *
+ * @return array
+ */
+function wcpt_get_log_entries( $wordcamp_id ) {
+        $entries        = array();
+        $notes          = get_post_meta( $wordcamp_id, '_note'          );  // todo better key name?
+        $status_changes = get_post_meta( $wordcamp_id, '_status_change' );  // todo better key name? if yes, update get_last_status_update_time_diff too
+
+        foreach ( array( 'note' => $notes, 'status_change' => $status_changes ) as $entry_type => $raw_entries ) {
+                foreach ( $raw_entries as $entry ) {
+                        $user = get_user_by( 'id', $entry['user_id'] );
+
+                        $entry['type']              = $entry_type;
+                        $entry['user_display_name'] = $user->display_name;
+
+                        $entries[] = $entry;
+                }
+        }
+
+        usort( $entries, 'wcpt_sort_log_entries' );
+
+        return $entries;
+}
+
+/**
+ * Sort the log entries in reverse-chronological order
+ *
+ * @param array $a
+ * @param array $b
+ *
+ * @return int
+ */
+function wcpt_sort_log_entries( $a, $b ) {
+        // If a status change and a note occur at the same time, show the change before the note
+        if ( $a['timestamp'] == $b['timestamp'] ) {
+                return ( '_status_change' == $a['type'] ) ? -1 : 1; // todo not consistent
+        }
+
+        return ( $a['timestamp'] > $b['timestamp'] ) ? -1 : 1;
+}
+
+/**
+ * Render the Notes metabox
+ *
+ * @param WP_Post $post
+ */
+function wcpt_add_note_metabox( $post ) {
+        wp_nonce_field( 'wcpt_notes', 'wcpt_notes_nonce' );
+
+        require_once( __DIR__ . '/views/common/metabox-notes.php' );
+}

sites/branches/application-tracking/wordcamp.org/public_html/wp-content/plugins/wcpt/wcpt-wordcamp/wordcamp-admin.php

@@ -43 +43 @@
                 // Post status transitions
                 add_action( 'transition_post_status',                         array( $this, 'trigger_schedule_actions' ), 10, 3 );
+                add_action( 'transition_post_status',                         array( $this, 'log_status_changes'       ), 10, 3 );
                 add_action( 'wcpt_added_to_planning_schedule',                array( $this, 'add_organizer_to_central' ), 10 );
                 add_action( 'wcpt_added_to_planning_schedule',                array( $this, 'mark_date_added_to_planning_schedule' ), 10 );
@@ -51 +52 @@
                 add_action( 'admin_notices',                                  array( $this, 'print_admin_notices' ) );
                 add_filter( 'redirect_post_location',                         array( $this, 'add_admin_notices_to_redirect_url' ), 10, 2 );
+        }
+
+        // todo phpdoc
+        public static function get_status_name( $status_slug ) {
+                // todo call get_custom_statuses and map ?
+
+                return '{status name}';
+        }
+
+        //todo phpdoc
+        public static function get_milestone_from_status( $status_slug ) {
+                // todo just have an array that maps them together?
+
+                return '{milestone name}';
         }
 
@@ -87 +102 @@
                         'high'
                 );
+                
+                add_meta_box(
+                        'wcpt_notes',
+                        __( 'Add a Note', 'wordcamporg' ),
+                        'wcpt_add_note_metabox',
+                        WCPT_POST_TYPE_ID,
+                        'side',
+                        'low'
+                );
+
+                add_meta_box(
+                        'wcpt_log',
+                        'Log',
+                        'wcpt_log_metabox',
+                        WCPT_POST_TYPE_ID,
+                        'advanced',
+                        'low'
+                );
         }
 
@@ -159 +192 @@
                         }
                 }
-        }
+
+                $this->validate_and_add_note( $post_id );
+        }
+
+        /**
+         * Validate and add a new note
+         *
+         * @param int $post_id
+         */
+        protected function validate_and_add_note( $post_id ) {
+                // todo make sure edit is actionable - done in caller, but test
+
+                check_admin_referer( 'wcpt_notes', 'wcpt_notes_nonce' );    // todo test working
+
+                $new_note_message = sanitize_text_field( wp_unslash( $_POST['wcpt_new_note'] ) );
+
+                if ( empty( $new_note_message ) ) {
+                        return;
+                }
+
+                add_post_meta( $post_id, '_note', array(
+                        'timestamp' => current_time( 'timestamp' ),
+                        'user_id'   => get_current_user_id(),
+                        'message'   => $new_note_message,
+                ) );
+        }
+
 
         /**
@@ -553 +612 @@
 
         /**
+         * Log when the post status changes
+         *
+         * @param string  $new_status
+         * @param string  $old_status
+         * @param WP_Post $post
+         */
+        public function log_status_changes( $new_status, $old_status, $post ) {
+                if ( $new_status === $old_status ) {
+                        return;
+                }
+
+                add_post_meta( $post->ID, '_status_change', array(
+                        'timestamp' => current_time( 'timestamp' ),
+                        'user_id'   => get_current_user_id(),
+                        'message'   => sprintf( '%s -> %s', $old_status, $new_status ), /// todo use get_status_name() when it's ready
+                ) );
+        }
+
+        /**
          * Add the lead organizer to Central when a WordCamp application is accepted.
          *