WIP: mycalendar transformer closes #54 #57

Draft
ruru4143 wants to merge 5 commits from mycalendar-init into main
3 changed files with 187 additions and 0 deletions

View file

@ -0,0 +1,123 @@
<?php
/**
* ActivityPub Transformer for the plugin My Calendar.
*
* @package Activitypub_Event_Extensions
* @license AGPL-3.0-or-later
*/
namespace ActivityPub_Event_Bridge\Activitypub\Transformer;
// Exit if accessed directly.
defined( 'ABSPATH' ) || exit; // @codeCoverageIgnore
use Activitypub\Activity\Extended_Object\Event;
use Activitypub\Activity\Extended_Object\Place;
use ActivityPub_Event_Bridge\Activitypub\Transformer\Event as Event_Transformer;
use DateTime;
use DateTimeZone;
use EM_Event;
use function Activitypub\esc_hashtag;
/**
* ActivityPub Transformer for events from the WordPress plugin 'My Calendar'
*
* @see https://wordpress.org/plugins/my-calendar/
*
* @since 1.0.0
*/
final class My_Calendar extends Event_Transformer {
/**
* Holds the mycalendar post object.
*
* @var array
*/
protected $mc_event;
protected $mc_event_schema;
/**
* Extend the constructor, to also set the Eventsmanager objects.
*
* This is a special class object form The Events Calendar which
* has a lot of useful functions, we make use of our getter functions.
*
* @param WP_Post $wp_object The WordPress object.
* @param string $wp_taxonomy The taxonomy slug of the event post type.
*/
public function __construct( $wp_object, $wp_taxonomy ) {
parent::__construct( $wp_object, $wp_taxonomy );
$mc_event_id = get_post_meta( $this->wp_object->ID, '_mc_event_id', true );
$this->mc_event = mc_get_event( $mc_event_id );
$this->mc_event_schema = mc_event_schema( $this->mc_event );
}
/**
* Formats time from the plugin to the activitypub standard
*/
private function convert_time( $date_string, $time_string ): string {
// Create a DateTime object with the given date, time, and timezone.
$datetime = new DateTime( $date_string . ' ' . $time_string );
// Set the timezone for proper formatting.
$datetime->setTimezone( new DateTimeZone( 'UTC' ) );
// Format the DateTime object as 'Y-m-d\TH:i:s\Z'.
$formatted_date = $datetime->format( 'Y-m-d\TH:i:s\Z' );
return $formatted_date;
}
/**
* Get the start time from the events metadata.
*/
public function get_start_time(): string {
return $this->convert_time( $this->mc_event->event_begin, $this->mc_event->event_time);
}
/**
* Get the end time from the events metadata.
*/
public function get_end_time(): ?string {
return $this->convert_time( $this->mc_event->event_end, $this->mc_event->event_endtime);
}
/**
* Get the event location.
*
* @return Place|null The place/venue if one is set.
*/
public function get_location(): ?Place {
if ( array_key_exists('location', $this->mc_event_schema ) && $this->mc_event_schema['location']['@type'] == 'Place' ) {
$mc_place = $this->mc_event_schema['location'];
$place = new Place();
$place->set_name( $mc_place['name'] );
$place->set_url( $mc_place['url'] );
$place->set_address( $mc_place['address'] );
if ( ! empty( $mc_place['geo'] ) ) {
$place->set_latitude( $mc_place['geo']['latitude'] );
$place->set_longitude( $mc_place['geo']['longitude'] );
}
return $place;
}
return null;
}
/**
* Get status of the event
*
* @return string status of the event
*/
public function get_status(): ?string {
return 'CONFIRMED'; # my-calender doesn't implement canceled events.
}
public function to_object(): Event {
$activitypub_object = parent::to_object();
return $activitypub_object;
}
}

View file

@ -128,6 +128,7 @@ class Setup {
'\ActivityPub_Event_Bridge\Plugins\GatherPress',
'\ActivityPub_Event_Bridge\Plugins\The_Events_Calendar',
'\ActivityPub_Event_Bridge\Plugins\VS_Event_List',
'\ActivityPub_Event_Bridge\Plugins\My_Calendar',
);
/**

View file

@ -0,0 +1,63 @@
<?php
/**
* My Calendar.
*
* Defines all the necessary meta information for the WordPress event plugin
* "My Calendar".
*
* @link https://wordpress.org/plugins/my-calendar/
* @package Activitypub_Event_Extensions
* @since 1.0.0
*/
namespace ActivityPub_Event_Bridge\Plugins;
use Activitypub_Event_Extensions\Event_Plugins;
// Exit if accessed directly.
defined( 'ABSPATH' ) || exit; // @codeCoverageIgnore
/**
* Interface for a supported event plugin.
*
* This interface defines which information is necessary for a supported event plugin.
*
* @since 1.0.0
*/
final class My_Calendar extends Event_Plugin {
/**
* Returns the full plugin file.
*
* @return string
*/
public static function get_plugin_file(): string {
return 'my-calendar/my-calendar.php';
}
/**
* Returns the event post type of the plugin.
*
* @return string
*/
public static function get_post_type(): string {
return 'mc-events';
}
/**
* Returns the ID of the main settings page of the plugin.
*
* @return string The settings page url.
*/
public static function get_settings_page(): string {
return 'my-calendar-config';
}
/**
* Returns the taxonomy used for the plugin's event categories.
*
* @return string
*/
public static function get_event_category_taxonomy(): string {
return 'mc-event-category';
}
}