moonstonemedia / Simple-Calendar

includes/functions/shared.php

<?php
/**
 * Shared functions
 *
 * Functions shared by both back end and front end components.
 *
 * @package SimpleCalendar/Functions
 */

if ( ! defined( 'ABSPATH' ) ) {
	exit;
}

/**
 * Check if there is a calendar.
 *
 * @since  3.0.0
 *
 * @return bool
 */
function is_simple_calendar() {

	if ( is_singular() ) {

		global $post, $post_type;

Use of global functionality is not recommended; it makes your code harder to test, and less reusable.

		if ( 'calendar' == $post_type ) {
			return true;
		} else {
			if ( false !== get_post_meta( $post->ID, '_simcal_attach_calendar_id', true ) ) {
				return true;
			}
			if ( has_shortcode( $post->post_content, 'calendar' ) ) {
				return true;
			}
		}
	}

	return false;
}

/**
 * Get plugin URL.
 *
 * @param  string $url
 *
 * @return string
 */
function simcal_get_url( $url ) {
	return \SimpleCalendar\plugin()->get_url( $url );
}

/**
 * Get events feed types.
 *
 * @since  3.0.0
 *
 * @return array
 */
function simcal_get_feed_types() {
	$objects = \SimpleCalendar\plugin()->objects;
	return $objects instanceof \SimpleCalendar\Objects ? $objects->get_feed_types() : array();
}

/**
 * Get an events feed.
 *
 * @since  3.0.0
 *
 * @param  string|int|object $object
 *
 * @return null|\SimpleCalendar\Abstracts\Feed

Should the return type not be object|null?

 */
function simcal_get_feed( $object ) {
	$objects = \SimpleCalendar\plugin()->objects;
	return $objects instanceof \SimpleCalendar\Objects ? $objects->get_feed( $object ) : null;
}

/**
 * Get calendar types.
 *
 * @since  3.0.0
 *
 * @return array
 */
function simcal_get_calendar_types() {
	$objects = \SimpleCalendar\plugin()->objects;
	return $objects instanceof \SimpleCalendar\Objects ? $objects->get_calendar_types() : array();
}

/**
 * Get a calendar.
 *
 * @since  3.0.0
 *
 * @param  string|int|object|WP_Post $object
 *
 * @return null|\SimpleCalendar\Abstracts\Calendar

Should the return type not be object|null?

 */
function simcal_get_calendar( $object ) {
	$objects = \SimpleCalendar\plugin()->objects;
	return $objects instanceof \SimpleCalendar\Objects ? $objects->get_calendar( $object ) : null;
}

/**
 * Get a calendar view.
 *
 * @since  3.0.0
 *
 * @param  int    $id
 * @param  string $name
 *
 * @return mixed
 */
function simcal_get_calendar_view( $id = 0, $name = '' ) {
	$objects = \SimpleCalendar\plugin()->objects;
	return $objects instanceof \SimpleCalendar\Objects ? $objects->get_calendar_view( $id, $name ) : false;
}

/**
 * Print a calendar.
 *
 * @since  3.0.0
 *
 * @param  int|object|WP_Post $object
 *
 * @return void
 */
function simcal_print_calendar( $object ) {

	$calendar = simcal_get_calendar( $object );

	if ( $calendar instanceof \SimpleCalendar\Abstracts\Calendar ) {
		$calendar->html();
	}
}

/**
 * Common scripts variables.
 *
 * Variables to print in scripts localization
 *
 * @since  3.0.0
 *
 * @return array
 */
function simcal_common_scripts_variables() {

	$vars = array(
		'ajax_url'  => \SimpleCalendar\plugin()->ajax_url(),
		'nonce'     => wp_create_nonce( 'simcal' ),
		'locale'    => \SimpleCalendar\plugin()->locale,
		'text_dir'  => is_rtl() ? 'rtl' : 'ltr',
		'months'    => array(
			'full'  => simcal_get_calendar_names_i18n( 'month', 'full' ),
			'short' => simcal_get_calendar_names_i18n( 'month', 'short' ),
		),
		'days'      => array(
			'full'  => simcal_get_calendar_names_i18n( 'day', 'full' ),
			'short' => simcal_get_calendar_names_i18n( 'day', 'short' ),
		),
		'meridiem' => simcal_get_calendar_names_i18n( 'meridiem' ),
	);

	return array_merge( $vars, apply_filters( 'simcal_common_scripts_variables', array() ) );
}

/**
 * Get feed IDs and names.
 *
 * @since  3.0.0
 *
 * @param  string|int|array $exclude Id or array of ids to drop from results.
 * @param  bool $cached Use cached query.
 *
 * @return array Associative array with ids as keys and feed titles as values.
 */
function simcal_get_calendars( $exclude = '', $cached = true ) {

	$calendars = get_transient( '_simple-calendar_feed_ids' );

	if ( ! $calendars || $cached === false ) {

		$posts = get_posts( array(
			'post_type' => 'calendar',
			'nopaging'  => true,
		) );

		$calendars = array();
		foreach ( $posts as $post ) {
			$calendars[ $post->ID ] = $post->post_title;
		}
		asort( $calendars );

		set_transient( '_simple-calendar_feed_ids', $calendars, 604800 );
	}

	if ( ! empty( $exclude ) ) {
		if ( is_numeric( $exclude ) ) {
			unset( $calendars[ intval( $exclude ) ] );
		} elseif ( is_array( $exclude ) ) {
			array_diff_key( $calendars, array_map( 'intval', array_keys( $exclude ) ) );
		}
	}

	return $calendars;
}

/**
 * Get localized list of months or day names.
 *
 * Each day or month matches the array index (0-11 for months or 0-6 for days).
 *
 * @since  3.0.0
 *
 * @param  string $group Either 'month', 'day' or 'meridiem' names to localize.
 * @param  string $style Return names in 'short' or 'full' form (default full long form).
 *
 * @return array
 */
function simcal_get_calendar_names_i18n( $group, $style = 'full' ) {

	$names = array();

	if ( in_array( $group, array( 'month', 'day', 'meridiem' ) ) ) {

		$format = '';
		$length = 0;

		$date = \Carbon\Carbon::now();

		if ( 'month' == $group ) {
			$date->month( 0 )->startOfMonth();
			$format = 'short' == $style ? 'M' : 'F';
			$length = 11;
		} elseif ( 'day' == $group ) {
			$date->next( 6 );
			$format = 'short' == $style ? 'D' : 'l';
			$length = 6;
		} elseif ( 'meridiem' == $group ) {
			$date->startOfDay();
			$am = $date->addHour( 1 )->getTimestamp();
			$pm = $date->addHours( 13 )->getTimestamp();
			return array(
				'AM' => date_i18n( 'A', $am ),
				'am' => date_i18n( 'a', $am ),
				'PM' => date_i18n( 'A', $pm ),
				'pm' => date_i18n( 'a', $pm ),
			);
		}

		$i = 0;
		while ( $i <= $length ) {
			if ( 'month' == $group ) {
				$date->addMonths( 1 );
			} else {
				$date->addDays( 1 );
			}
			$names[ strval( $i ) ] = date_i18n( $format, $date->getTimestamp() );
			$i++;
		}

	}

	return $names;
}

/**
 * Default event template.
 *
 * @since  3.0.0
 *
 * @return string
 */
function simcal_default_event_template() {

	$content  = '<strong>' . '[title]' . '</strong>';
	$content .= "\n\n";
	$content .= '[when]' . "\n";
	$content .= '[location]';
	$content .= "\n";
	$content .= '<div>' . '[description]' . '</div>';
	$content .= "\n" . '[link newwindow="yes"]' . __( 'See more details', 'google-calendar-events' ) . '[/link]';

	return apply_filters( 'simcal_default_event_template', $content );
}

/**
 * Get day, month, year order in a datetime format string.
 *
 * Returns an array with d, m, y for keys and a order number.
 * If either d, m, y is not found in date format, order value is false.
 *
 * @since  3.0.0
 *
 * @param  string $date_format
 *
 * @return array
 */
function simcal_get_date_format_order( $date_format ) {

	$pos = array(
		'd' => strpos( $date_format, strpbrk( $date_format, 'Dj' ) ),
		'm' => strpos( $date_format, strpbrk( $date_format, 'FMmn' ) ),
		'y' => strpos( $date_format, strpbrk( $date_format, 'Yy' ) ),
	);

	// @TODO When one date piece is not found, perhaps fallback to ISO standard position.

	$order = array();
	foreach ( $pos as $k => $v ) {
		$order[ $k ] = $v;
	}
	ksort( $order );

	return $order;
}

/**
 * Get WordPress timezone setting.
 *
 * Always returns a valid timezone string even when the setting is a GMT offset.
 *
 * @since  3.0.0
 *
 * @return null|string
 */
function simcal_get_wp_timezone() {

	$timezone = get_option( 'timezone_string' );

	if ( empty( $timezone ) ) {
		$gmt = get_option( 'gmt_offset' );
		$timezone = simcal_get_timezone_from_gmt_offset( $gmt );
	}

	return $timezone;
}

/**
 * Get a timezone from a GMT offset.
 *
 * Converts a numeric offset into a valid timezone string.
 *
 * @since  3.0.0
 *
 * @param  string|float $offset
 *
 * @return null|string
 */
function simcal_get_timezone_from_gmt_offset( $offset ) {

	if ( is_numeric( $offset ) ) {

		if ( 0 === intval( $offset ) ) {
			return 'UTC';
		} else {
			$offset = floatval( $offset ) * 3600;
		}

		$timezone = timezone_name_from_abbr( null, $offset, false );
		// This is buggy and might return false:
		// @see http://php.net/manual/en/function.timezone-name-from-abbr.php#86928
		// Therefore:
		if ( false == $timezone ) {

It seems like you are loosely comparing $timezone of type string to the boolean false. If you are specifically checking for an empty string, consider using the more explicit === '' instead.

			$list = timezone_abbreviations_list();
			foreach ( $list as $abbr ) {
				foreach ( $abbr as $city ) {
					if ( $offset == $city['offset'] ) {
						return $city['timezone_id'];
					}
				}
			}

		}

		return $timezone;
	}

	return null;
}

/**
 * Convert a timezone string to a numeric offset.
 *
 * @since  3.0.0
 *
 * @param  string $timezone
 *
 * @return int Unix time offset
 */
function simcal_get_timezone_offset( $timezone ) {
	return \Carbon\Carbon::now( $timezone )->offset;
}

/**
 * Escape timezone string.
 *
 * @since  3.0.0
 *
 * @param  string $tz
 * @param  mixed  $default
 *
 * @return mixed|string
 */
function simcal_esc_timezone( $tz, $default = 'UTC' ) {
	return in_array( $tz, timezone_identifiers_list() ) ? $tz : $default;
}

/**
 * Clear feed transients cache.
 *
 * @since  3.0.0
 *
 * @param  string|int|array|\WP_Post $id
 *
 * @return bool
 */
function simcal_delete_feed_transients( $id = '' ) {

	$grouped_ids = get_post_meta( $id, '_grouped_calendars_ids', true );

	// If there are group IDs we need to construct an array to pass along with the grouped IDs + the original $post_id
	if ( is_array( $grouped_ids ) ) {
		$temp_id = $id;
		$id = $grouped_ids;
		$id[] = $temp_id;
	}

	if ( is_numeric( $id ) ) {
		$id = intval( $id ) > 0 ? absint( $id ) : simcal_get_calendars();
	} elseif ( $id instanceof WP_Post ) {

The class WP_Post does not exist. Did you forget a USE statement, or did you not list all dependencies?

		$id = $id->ID;
	} elseif ( is_array( $id ) ) {
		$id = array_map( 'absint', $id );
	} else {
		$id = simcal_get_calendars( '', true );
	}

	$feed_types = simcal_get_feed_types();

	if ( is_array( $id ) ) {

		$posts = get_posts( array(
				'post_type' => 'calendar',
				'fields'    => 'ids',
				'post__in'  => $id,
				'nopaging'  => true,
		) );

		foreach ( $posts as $post ) {
			$calendar = simcal_get_calendar( $post );
			if ( $calendar instanceof \SimpleCalendar\Abstracts\Calendar ) {

This code seems to be duplicated across your project.

				foreach ( $feed_types as $feed_type ) {
					delete_transient( '_simple-calendar_feed_id_' . strval( $calendar->id ) . '_' . $feed_type );
				}
			}
		}

	} else {

		$post = get_post( $id );
		$calendar = simcal_get_calendar( $post );
		if ( $calendar instanceof \SimpleCalendar\Abstracts\Calendar ) {

This code seems to be duplicated across your project.

			foreach ( $feed_types as $feed_type ) {
				delete_transient( '_simple-calendar_feed_id_' . strval( $calendar->id ) . '_' . $feed_type );
			}
		}
	}

	return delete_transient( '_simple-calendar_feed_ids' );
}