Tribe__Events__Aggregator__Tabs__New::get_result_messages( Tribe__Events__Aggregator__Record__Queue_Interface|WP_Error|Tribe__Events__Aggregator__Record__Activity $queue )

Parses the queue for errors and information.


Parameters

$queue

(Tribe__Events__Aggregator__Record__Queue_Interface|WP_Error|Tribe__Events__Aggregator__Record__Activity) (Required)


Top ↑

Return

(array)


Top ↑

Source

File: src/Tribe/Aggregator/Tabs/New.php

	public function get_result_messages( $queue ) {
		$messages = array();

		if ( is_wp_error( $queue ) ) {
			$messages[ 'error' ][] = $queue->get_error_message();

			tribe_notice( 'tribe-aggregator-import-failed', array( $this, 'render_notice_import_failed' ), 'type=error' );

			return $messages;
		}

		if (
			$queue instanceof Tribe__Events__Aggregator__Record__Queue_Interface
			&& $queue->has_errors()
		) {
			/** @var Tribe__Events__Aggregator__Record__Queue_Interface $queue */
			$messages['error'][] = $queue->get_error_message();

			tribe_notice( 'tribe-aggregator-import-failed', array( $this, 'render_notice_import_failed' ), 'type=error' );

			return $messages;
		}

		$is_queued = $queue->count();

		$content_post_type = empty( $queue->record->meta['content_type'] ) ? Tribe__Events__Main::POSTTYPE : $queue->record->meta['content_type'];
		$content_type = tribe_get_event_label_singular_lowercase();
		$content_type_plural = tribe_get_event_label_plural_lowercase();

		if ( 'csv' === $queue->record->meta['origin'] && 'tribe_events' !== $queue->record->meta['content_type'] ) {
			$content_type_object = get_post_type_object( $queue->record->meta['content_type'] );
			$content_type = empty( $content_type_object->labels->singular_name_lowercase ) ? $content_type_object->labels->singular_name : $content_type_object->labels->singular_name_lowercase;
			$content_type_plural = empty( $content_type_object->labels->plural_name_lowercase ) ? $content_type_object->labels->name : $content_type_object->labels->plural_name_lowercase;
			$content_post_type = $content_type_object->name;
		}

		if ( ! $is_queued ) {
			$item_created = $queue->activity->get( $content_post_type, 'created' );
			if ( ! empty( $item_created ) ) {
				$content_label = 1 === $queue->activity->count( $content_post_type, 'created' ) ? $content_type : $content_type_plural;

				$messages['success'][] = sprintf( // add created event count
					_n( '%1$d new %2$s was imported.', '%1$d new %2$s were imported.', $queue->activity->count( $content_post_type, 'created' ), 'the-events-calendar' ),
					$queue->activity->count( $content_post_type, 'created' ),
					$content_label
				);
			}

			$item_updated = $queue->activity->get( $content_post_type, 'updated' );
			if ( ! empty( $item_updated ) ) {
				$content_label = 1 === $queue->activity->count( $content_post_type, 'updated' ) ? $content_type : $content_type_plural;

				// @todo: include a part of sentence like: ", including %1$d %2$signored event%3$s.", <a href="/wp-admin/edit.php?post_status=tribe-ignored&post_type=tribe_events">, </a>
				$messages['success'][] = sprintf( // add updated event count
					_n( '%1$d existing %2$s was updated.', '%1$d existing %2$s were updated.', $queue->activity->count( $content_post_type, 'updated' ), 'the-events-calendar' ),
					$queue->activity->count( $content_post_type, 'updated' ),
					$content_label
				);
			}

			$item_skipped = $queue->activity->get( $content_post_type, 'skipped' );
			if ( ! empty( $item_skipped ) ) {
				$content_label = 1 === $queue->activity->count( $content_post_type, 'skipped' ) ? $content_type : $content_type_plural;

				$messages['success'][] = sprintf( // add skipped event count
					_n( '%1$d already-imported %2$s was skipped.', '%1$d already-imported %2$s were skipped.', $queue->activity->count( $content_post_type, 'skipped' ), 'the-events-calendar' ),
					$queue->activity->count( $content_post_type, 'skipped' ),
					$content_label
				);
			}

			$images_created = $queue->activity->get( 'images', 'created' );
			if ( ! empty( $images_created ) ) {
				$messages['success'][] = sprintf( // add image import count
					_n( '%1$d new image was imported.', '%1$d new images were imported.', $queue->activity->count( 'images', 'created' ), 'the-events-calendar' ),
					$queue->activity->count( 'images', 'created' )
				);
			}

			if ( $queue && ! $messages ) {
				$messages['success'][] = sprintf(
					__( 'No %1$s were imported or updated.', 'the-events-calendar' ),
					$content_type_plural
				);
			}

			if ( ! empty( $messages['success'] ) && ! empty( $content_type_object->show_ui ) ) {
				// append a URL to view all records for the given post type
				$url = admin_url( 'edit.php?post_type=' . $content_post_type );
				$link_text = sprintf( __( 'View all %s', 'the-events-calendar' ), $content_type_plural );
				$messages['success'][ count( $messages['success'] ) - 1 ] .= ' <a href="' . esc_url( $url ) . '" >' . esc_html( $link_text ) . '</a>';
			}

			// if not CSV, pull counts for venues and organizers that were auto-created
			if ( 'csv' !== $queue->record->meta['origin'] ) {
				$venue_created = $queue->activity->get( 'venue', 'created' );
				if ( ! empty( $venue_created ) ) {
					$messages['success'][] = '<br/>' .
					sprintf( // add activity count
						_n( '%1$d new venue was imported.', '%1$d new venues were imported.', $queue->activity->count( 'venue', 'created' ), 'the-events-calendar' ),
						$queue->activity->count( 'venue', 'created' )
					) .
					' <a href="' . admin_url( 'edit.php?post_type=tribe_venue' ) . '">' .
					__( 'View your event venues', 'the-events-calendar' ) .
					'</a>';
				}

				$organizer_created = $queue->activity->get( 'organizer', 'created' );
				if ( ! empty( $organizer_created ) ) {
					$messages['success'][] = '<br/>' .
					sprintf( // add organizer count
						_n( '%1$d new organizer was imported.', '%1$d new organizers were imported.', $queue->activity->count( 'organizer', 'created' ), 'the-events-calendar' ),
						$queue->activity->count( 'organizer', 'created' )
					) .
					' <a href="' . admin_url( 'edit.php?post_type=tribe_organizer' ) . '">' .
					__( 'View your event organizers', 'the-events-calendar' ) .
					'</a>';
				}
			}

			$category_created = $queue->activity->get( 'category', 'created' );
			if ( ! empty( $category_created ) ) {
				$messages['success'][] = '<br/>' .
					sprintf( // add category count
						_n( '%1$d new event category was created.', '%1$d new event categories were created.', $queue->activity->count( 'category', 'created' ), 'the-events-calendar' ),
						$queue->activity->count( 'category', 'created' )
					) .
					' <a href="' . esc_url( admin_url( 'edit-tags.php?taxonomy=tribe_events_cat&post_type=tribe_events' ) ) . '">' .
					__( 'View your event categories', 'the-events-calendar' ) .
					'</a>';
			}

			$tags_created = $queue->activity->get( 'tag', 'created' );
			if ( ! empty( $tags_created ) ) {
				$messages['success'][] = '<br/>' .
					 sprintf( // add category count
						 _n( '%1$d new event tag was created.', '%1$d new event tags were created.', $queue->activity->count( 'tag', 'created' ), 'the-events-calendar' ),
						 $queue->activity->count( 'tag', 'created' )
					 ) .
					 ' <a href="' . esc_url( admin_url( 'edit-tags.php?taxonomy=post_tag&post_type=tribe_events' ) ) . '">' .
					 __( 'View your event tags', 'the-events-calendar' ) .
					 '</a>';
			}
		}

		if (
			! empty( $messages['error'] )
			|| ! empty( $messages['success'] )
			|| ! empty( $messages['warning'] )
		) {
			if ( 'manual' == $queue->record->type ) {
				array_unshift( $messages['success'], __( 'Import complete!', 'the-events-calendar' ) . '<br/>' );
			} else {
				array_unshift( $messages['success'], __( 'Your scheduled import was saved and the first import is complete!', 'the-events-calendar' ) . '<br/>' );

				$scheduled_time = strtotime( $queue->record->post->post_modified ) + $queue->record->frequency->interval;
				$scheduled_time_string = date( get_option( 'date_format' ), $scheduled_time ) .
										 _x( ' at ', 'separator between date and time', 'the-events-calendar' ) .
										 date( get_option( 'time_format' ), $scheduled_time );

                if ( 'on_demand' !== $queue->record->frequency->id ) {

                    $messages['success'][] = '<br/>' .
                                             sprintf( // add in timing
                                                 __( 'The next import is scheduled for %1$s.', 'the-events-calendar' ),
                                                 esc_html( $scheduled_time_string )
                                             ) .
                                             ' <a href="' . admin_url( 'edit.php?page=aggregator&post_type=tribe_events&tab=scheduled' ) . '">' .
                                             __( 'View your scheduled imports.', 'the-events-calendar' ) .
                                             '</a>';
                }
			}
		}

		return $messages;
	}