emfu-functions.php

<?php

// TODO: make these field numbers flexible, depending the received columns
define('emfu_field_nr_event_start_date', 1);
define('emfu_field_nr_event_start_time', 2);
define('emfu_field_nr_event_end_date',   3);
define('emfu_field_nr_event_end_time',   4);
define('emfu_field_nr_event_name',       5);
define('emfu_field_nr_post_excerpt',     6);
define('emfu_field_nr_post_content',     7);
define('emfu_field_nr_location_slug',    8);
define('emfu_field_nr_category_slug',    9);

/**
 * Create a EM_Event object from the input row with fields
 * @param array $event_row
 *
 * @return EM_Event
 * @throws Exception
 */
function emfu_create_EM_Event_from_row(array $event_row ){

	$event = new EM_Event();

	/*
	 * hard coded values
	 */
	$event->post_type      = 'event';
	$event->post_status    = 'publish';
	$event->comment_status = 'open';
	$event->ping_status    = 'closed';
	$event->event_private  = 0;
	$event->event_status   = 1;

	/*
	 * Name, title are mandatory
	 */
	$event->event_name   = emfu_not_empty($event_row[ emfu_field_nr_event_name ], "event_name");
	$event->post_title   = emfu_not_empty($event_row[ emfu_field_nr_event_name ], "event_name");

	/*
	 * excerpt and content are optional
	 */
	$event->post_excerpt = $event_row[ emfu_field_nr_post_excerpt ];
	$event->post_content = $event_row[ emfu_field_nr_post_content ];

	/*
	 * start date and time
	 */
	$event_start_date        = emfu_get_valid_date_string($event_row[ emfu_field_nr_event_start_date ], "start_date");
	$event_start_time        = emfu_get_valid_time_string($event_row[ emfu_field_nr_event_start_time ], "start_time");

	$event->event_start_date = $event_start_date;
	$event->event_start_time = $event_start_time;
	$event->event_start      = $event_start_date . ' ' . $event_start_time;

	/*
	 * end data and time
	 */
	$event_end_date = $event_row[ emfu_field_nr_event_end_date ];
	$event_end_time = $event_row[ emfu_field_nr_event_end_time ];

	// if end date is empty, the start date is taken
	if (empty($event_end_date) )
		$event_end_date = $event_start_date;
	// if end time is empty, the start time is taken
	if (empty($event_end_time))
		$event_end_time   = $event_start_time;

	$event->event_end_date = emfu_get_valid_date_string($event_end_date, "end_date");
	$event->event_end_time = emfu_get_valid_time_string($event_end_time, "end_time");

	/*
	 * Location
	 */
	$location_id        = emfu_get_location_id( $event_row[ emfu_field_nr_location_slug ] );
	$event->location_id = $location_id;

	/*
	 * Set the Category according to the category slug
	 */
	$category_id       = emfu_get_category_id( $event_row[ emfu_field_nr_category_slug ] );
	$category          = array( $category_id );
	$event->categories = new EM_Categories( $category );

	return $event;

}

/**
 * Check on being not empty.
 * When empty, an Exception is thrown with error message.
 * When not empty, the value is returned.
 * @param string $value
 * @param string $name
 *
 * @return string $value when not empty
 * @throws Exception
 */
function emfu_not_empty(string $value, string $name): string {
	if (empty($value))
		throw new Exception("{$name} has no value" );
	return $value;
}

/**
 * Check if a event already exists with event_status = 1 and the same:
 * - location
 * - name
 * - start date
 * - start time
 *  *
 * @param EM_Event $event
 *
 * @return bool
 * @throws Exception
 */
function emfu_event_exists(EM_Event $event): bool
{

	global $wpdb;
	if (empty($event))
		throw new Exception("Event is empty.", "function event_exists()");

	$location_id = $event->location_id;
	$event_name  = $event->event_name;
	$event_start_date = $event->event_start_date;
	$event_start_time = $event->event_start_time;

	$query_string = $wpdb->prepare( "SELECT count(*) FROM " . EM_EVENTS_TABLE .
									" where event_status = 1 " . 
									   "and location_id = %d " . 
									   "and event_name = %s " . 
									   "and event_start_date = %s " . 
									   "and event_start_time = %s",
		array($location_id, $event_name, $event_start_date, $event_start_time)
	);
	$count = (int) $wpdb->get_var($query_string);
	return ($count > 0);
}

/**
 * Get the id of the Category with category_slug = $category_slug
 * @param string $category_slug
 * @return int term_id, being the category id
 * @throws Exception when $category_slug is empty or no category can be found with that slug
 */
function emfu_get_category_id(string $category_slug): int
{
	if (empty($category_slug))
		throw new Exception("Category-slug is empty.");
	$term              = get_term_by( 'slug', $category_slug, 'event-categories' );
	if (empty($term))
		throw new Exception("Unknown category-slug '" . $category_slug . "'.");

	return $term->term_id;
}

/**
 * Get the id of the EM_location with location_slug = $location_slug
 * @param string $location_slug
 * @return int location_id
 * @throws Exception when no location can be found or $location_slug was empty
 */
function emfu_get_location_id(string $location_slug): int
{
	global $wpdb;
	if (empty($location_slug))
		throw new Exception("Location-slug is empty.");
	$query_string = $wpdb->prepare( "SELECT location_id " . 
	                                 "FROM " . EM_LOCATIONS_TABLE . 
	                                " WHERE location_slug =  %s",
		array( $location_slug));
	$location_id  = $wpdb->get_var($query_string);
	if (is_null($location_id))
		throw new Exception("Unknown location-slug '" . $location_slug . "'.");
	return $location_id;
}

/**
 * Checks if $date contains a valid date string YYYY-MM-DD.
 * When not valid, an exception is thrown.
 * When valid, $date is returned.
 * @param string $date
 * @param string $name
 *
 * @return string
 * @throws Exception
 */
function emfu_get_valid_date_string(string $date, string $name): string
{
	// first check on non empty, for a nice error message
	emfu_not_empty($date, $name);

	// then check the date
	$d = DateTime::createFromFormat("Y-m-d", $date);
	// The Y ( 4 digits year ) returns TRUE for any integer with any number of digits 
	// so changing the comparison from == to === fixes the issue.
	if ( $d && $d->format("Y-m-d") === $date)
		return $date;
	else
		throw new Exception($name . " is not valid: " . $date);

}

/**
 * Checks if $time contains a valid timestring HH:mm:ss.
 * When not valid, an exception is thrown.
 * When valid, $time is returned.

 * @param string $time
 * @param string $name
 *
 * @return string
 * @throws Exception
 */
function emfu_get_valid_time_string(string $time, string $name): string
{
	// first check on non empty, for a nice error message
	emfu_not_empty($time, $name);
	if (strlen($time) != 8)
		throw new Exception($name . " is not valid time (hh:mm:ss): " . $time);

	// then check the date
	$t = strtotime($time);

	if ( $t )
		return $time;
	else
		throw new Exception($name . " is not valid: " . $time);

}