279 lines
7 KiB
PHP
279 lines
7 KiB
PHP
<?php
|
|
/**
|
|
* ActivityPub Transformer for the plugin Very Simple Event List.
|
|
*
|
|
* @package activity-event-transformers
|
|
* @license AGPL-3.0-or-later
|
|
*/
|
|
|
|
use Activitypub_Event_Extensions\Activitypub\Transformer\Event as Event_Transformer;
|
|
use EM_Event;
|
|
use Activitypub\Activity\Extended_Object\Event;
|
|
use Activitypub\Activity\Extended_Object\Place;
|
|
use function Activitypub\esc_hashtag;
|
|
|
|
if ( ! defined( 'ABSPATH' ) ) {
|
|
exit; // Exit if accessed directly.
|
|
}
|
|
|
|
/**
|
|
* ActivityPub Transformer for events from the WordPress plugin 'Events Manager'
|
|
*
|
|
* @see https://wordpress.org/plugins/events-manager/
|
|
*
|
|
* @since 1.0.0
|
|
*/
|
|
final class Events_Manager extends Event_Transformer {
|
|
|
|
/**
|
|
* Holds the EM_Event object.
|
|
*
|
|
* @var EM_Event
|
|
*/
|
|
protected $em_event;
|
|
|
|
/**
|
|
* Get transformer name.
|
|
*
|
|
* Retrieve the transformers name.
|
|
*
|
|
* @since 1.0.0
|
|
* @access public
|
|
* @return string Widget name.
|
|
*/
|
|
public function get_transformer_name() {
|
|
return 'activitypub-event-transformers/events-manager';
|
|
}
|
|
|
|
/**
|
|
* Get transformer title.
|
|
*
|
|
* Retrieve the transformers label.
|
|
*
|
|
* @since 1.0.0
|
|
* @access public
|
|
* @return string Widget title.
|
|
*/
|
|
public function get_transformer_label() {
|
|
return 'Events Manager';
|
|
}
|
|
|
|
/**
|
|
* Get supported post types.
|
|
*
|
|
* Retrieve the list of supported WordPress post types this transformer widget can handle.
|
|
*
|
|
* @since 1.0.0
|
|
* @access public
|
|
* @return array Widget categories.
|
|
*/
|
|
public static function get_supported_post_types() {
|
|
return array();
|
|
}
|
|
|
|
/**
|
|
* Returns the ActivityStreams 2.0 Object-Type for an Event.
|
|
*
|
|
* @see https://www.w3.org/TR/activitystreams-vocabulary/#dfn-event
|
|
* @since 1.0.0
|
|
* @return string The Event Object-Type.
|
|
*/
|
|
protected function get_type() {
|
|
return 'Event';
|
|
}
|
|
|
|
/**
|
|
* Returns whether the even is online
|
|
*
|
|
* @return bool
|
|
*/
|
|
protected function get_is_online() {
|
|
return 'url' === $this->em_event->event_location_type;
|
|
}
|
|
|
|
/**
|
|
* Get the event location.
|
|
*
|
|
* @return array The Place.
|
|
*/
|
|
public function get_location() {
|
|
if ( 'url' === $this->em_event->event_location_type ) {
|
|
return null;
|
|
}
|
|
|
|
$location = new Place();
|
|
$em_location = $this->em_event->get_location();
|
|
|
|
$location->set_name( $em_location->location_name );
|
|
|
|
$address = array(
|
|
'type' => 'PostalAddress',
|
|
'addressCountry' => $em_location->location_country,
|
|
'addressLocality' => $em_location->location_town,
|
|
'streetAddress' => $em_location->location_address,
|
|
'name' => $em_location->location_name,
|
|
);
|
|
if ( $em_location->location_state ) {
|
|
$address['addressRegion'] = $em_location->location_state;
|
|
}
|
|
if ( $em_location->location_postcode ) {
|
|
$address['postalCode'] = $em_location->location_postcode;
|
|
}
|
|
|
|
$location->set_address( $address );
|
|
return $location;
|
|
}
|
|
|
|
/**
|
|
* Get the end time from the events metadata.
|
|
*/
|
|
public function get_end_time() {
|
|
return null;
|
|
}
|
|
|
|
/**
|
|
* Get the end time from the events metadata.
|
|
*/
|
|
public function get_start_time() {
|
|
$date_string = $this->em_event->event_start_date;
|
|
$time_string = $this->em_event->event_start_time;
|
|
$timezone_string = $this->em_event->event_timezone;
|
|
|
|
// Create a DateTime object with the given date, time, and timezone.
|
|
$datetime = new DateTime( $date_string . ' ' . $time_string, new DateTimeZone( $timezone_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;
|
|
}
|
|
|
|
/**
|
|
* Returns the maximum attendee capacity.
|
|
*
|
|
* @return int
|
|
*/
|
|
public function get_maximum_attendee_capacity() {
|
|
return $this->em_event->event_spaces;
|
|
}
|
|
|
|
/**
|
|
* Return the remaining attendee capacity
|
|
*
|
|
* @todo decide whether to include pending bookings or not!
|
|
*/
|
|
public function get_remaining_attendee_capacity() {
|
|
$em_bookings = $this->em_event->get_bookings()->get_bookings();
|
|
$remaining_attendee_capacity = $this->em_event->event_spaces - count( $em_bookings->bookings );
|
|
return $remaining_attendee_capacity;
|
|
}
|
|
|
|
/**
|
|
* Returns the current participant count.
|
|
*
|
|
* @return int
|
|
*/
|
|
public function get_participant_count() {
|
|
$em_bookings = $this->em_event->get_bookings()->get_bookings();
|
|
return count( $em_bookings->bookings );
|
|
}
|
|
|
|
/**
|
|
* Hardcoded function for generating a summary.
|
|
*/
|
|
public function get_summary() {
|
|
if ( $this->em_event->post_excerpt ) {
|
|
$excerpt = $this->em_event->post_excerpt;
|
|
} else {
|
|
$excerpt = $this->get_content();
|
|
}
|
|
$address = $this->em_event->get_location()->location_name;
|
|
$start_time = strtotime( $this->get_start_time() );
|
|
$datetime_format = get_option( 'date_format' ) . ' ' . get_option( 'time_format' );
|
|
$start_time_string = wp_date( $datetime_format, $start_time );
|
|
$summary = "📍 {$address}\n📅 {$start_time_string}\n\n{$excerpt}";
|
|
return $summary;
|
|
}
|
|
|
|
/**
|
|
* Get the event link as an ActivityPub Link object, but as an associative array.
|
|
*
|
|
* @return array
|
|
*/
|
|
private function get_event_link_attachment(): array {
|
|
$event_link_url = $this->em_event->event_location->data['url'];
|
|
$event_link_text = $this->em_event->event_location->data['text'];
|
|
return array(
|
|
'type' => 'Link',
|
|
'name' => $event_link_text ? $event_link_text : 'Website',
|
|
'href' => \esc_url( $event_link_url ),
|
|
'mediaType' => 'text/html',
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Overrides/extends the get_attachments function to also add the event Link.
|
|
*/
|
|
protected function get_attachment() {
|
|
// Get attachments via parent function.
|
|
$attachments = parent::get_attachment();
|
|
|
|
// The first attachment is the featured image, make sure it is compatible with Mobilizon.
|
|
if ( count( $attachments ) ) {
|
|
$attachments[0]['type'] = 'Document';
|
|
$attachments[0]['name'] = 'Banner';
|
|
}
|
|
|
|
if ( 'url' === $this->em_event->event_location_type ) {
|
|
$attachments[] = $this->get_event_link_attachment();
|
|
}
|
|
return $attachments;
|
|
}
|
|
|
|
/**
|
|
* Compose the events tags.
|
|
*/
|
|
public function get_tag() {
|
|
// The parent tag function also fetches the mentions.
|
|
$tags = parent::get_tag();
|
|
|
|
$post_tags = \wp_get_post_terms( $this->wp_object->ID, 'event-tags' );
|
|
|
|
if ( $post_tags ) {
|
|
foreach ( $post_tags as $post_tag ) {
|
|
$tag = array(
|
|
'type' => 'Hashtag',
|
|
'href' => \esc_url( \get_tag_link( $post_tag->term_id ) ),
|
|
'name' => esc_hashtag( $post_tag->name ),
|
|
);
|
|
$tags[] = $tag;
|
|
}
|
|
}
|
|
return $tags;
|
|
}
|
|
|
|
/**
|
|
* Get the events title/name.
|
|
*/
|
|
protected function get_name() {
|
|
return $this->em_event->event_name;
|
|
}
|
|
|
|
/**
|
|
* Transform the WordPress Object into an ActivityPub Object.
|
|
*
|
|
* @return Activitypub\Activity\Event
|
|
*/
|
|
public function to_object() {
|
|
$this->em_event = new EM_Event( $this->wp_object->ID, 'post_id' );
|
|
$activitypub_object = new Event();
|
|
|
|
$activitypub_object = $this->transform_object_properties( $activitypub_object );
|
|
|
|
$activitypub_object->set_external_participation_url( $this->get_url() );
|
|
|
|
return $activitypub_object;
|
|
}
|
|
}
|