aboutsummaryrefslogtreecommitdiffhomepage
path: root/crates/shirabe/src/event_dispatcher/event_subscriber_interface.rs
diff options
context:
space:
mode:
Diffstat (limited to 'crates/shirabe/src/event_dispatcher/event_subscriber_interface.rs')
-rw-r--r--crates/shirabe/src/event_dispatcher/event_subscriber_interface.rs13
1 files changed, 12 insertions, 1 deletions
diff --git a/crates/shirabe/src/event_dispatcher/event_subscriber_interface.rs b/crates/shirabe/src/event_dispatcher/event_subscriber_interface.rs
index 41d723dc..0a5d88d5 100644
--- a/crates/shirabe/src/event_dispatcher/event_subscriber_interface.rs
+++ b/crates/shirabe/src/event_dispatcher/event_subscriber_interface.rs
@@ -1,15 +1,26 @@
//! ref: composer/src/Composer/EventDispatcher/EventSubscriberInterface.php
use indexmap::IndexMap;
+use shirabe_php_rpc::PhpObjHandle;
/// Represents one event's subscriber info: method name only, method+priority, or multiple handlers.
+#[derive(Debug)]
pub enum SubscribedEventEntry {
Method(String),
MethodWithPriority(String, Option<i64>),
Methods(Vec<(String, Option<i64>)>),
}
+// The sole implementor is the PHP plugin proxy (plugins are the only subscribers in Composer
+// itself), so the trait deviates from the PHP shape in two deliberate ways: the PHP-side static
+// `getSubscribedEvents()` takes `&self` here (the receiver carries which PHP class to call, and
+// an associated function would not be dyn-compatible), and it is fallible because the answer
+// crosses the RPC boundary.
pub trait EventSubscriberInterface {
/// Returns an array of event names this subscriber wants to listen to.
- fn get_subscribed_events() -> IndexMap<String, SubscribedEventEntry>;
+ fn get_subscribed_events(&self) -> anyhow::Result<IndexMap<String, SubscribedEventEntry>>;
+
+ /// The subscriber as it crosses the wire: PHP's `[$subscriber, $method]` array callables
+ /// capture the subscriber object itself, represented here by its P-table handle.
+ fn subscriber_handle(&self) -> PhpObjHandle;
}