id ) { throw new MWException( "Unable to serialize an uninitialized EchoEvent" ); } return array( 'id' ); } function __wakeup() { $this->loadFromID( $this->id ); } function __toString() { return "EchoEvent(id={$this->id}; type={$this->type})"; } /** * Creates an EchoEvent object * @param $info array Named arguments: * type (required): The event type; * variant: A variant of the type; * agent: The user who caused the event; * title: The page on which the event was triggered; * extra: Event-specific extra information (e.g. post content) * * @throws MWException * @return EchoEvent */ public static function create( $info = array() ) { global $wgEchoNotifications; $obj = new EchoEvent; static $validFields = array( 'type', 'variant', 'agent', 'title', 'extra' ); if ( empty( $info['type'] ) ) { throw new MWException( "'type' parameter is mandatory" ); } if ( !isset( $wgEchoNotifications[$info['type']] ) ) { return false; } $obj->id = false; $obj->timestamp = wfTimestampNow(); foreach ( $validFields as $field ) { if ( isset( $info[$field] ) ) { $obj->$field = $info[$field]; } } if ( $obj->title && !$obj->title instanceof Title ) { throw new MWException( "Invalid title parameter" ); } if ( $obj->agent && ! ( $obj->agent instanceof User || $obj->agent instanceof StubObject ) ) { throw new MWException( "Invalid user parameter" ); } $obj->insert(); global $wgEchoUseJobQueue; EchoNotificationController::notify( $obj, $wgEchoUseJobQueue ); return $obj; } /** * Check whether the echo event is an enabled event * @return bool */ public function isEnabledEvent() { global $wgEchoNotifications; if ( isset( $wgEchoNotifications[$this->getType()] ) ) { return true; } else { return false; } } /** * Inserts the object into the database. */ protected function insert() { global $wgEchoBackend; if ( $this->id ) { throw new MWException( "Attempt to insert() an existing event" ); } $row = array( 'event_id' => $this->id, 'event_timestamp' => $this->timestamp, 'event_type' => $this->type, 'event_variant' => $this->variant, ); $row['event_extra'] = $this->serializeExtra(); if ( $this->agent ) { if ( $this->agent->isAnon() ) { $row['event_agent_ip'] = $this->agent->getName(); } else { $row['event_agent_id'] = $this->agent->getId(); } } if ( $this->title ) { $row['event_page_namespace'] = $this->title->getNamespace(); $row['event_page_title'] = $this->title->getDBkey(); } $this->id = $wgEchoBackend->createEvent( $row ); } /** * Loads data from the provided $row into this object. * * @param $row Database row object from echo_event */ public function loadFromRow( $row ) { $this->id = $row->event_id; $this->timestamp = $row->event_timestamp; $this->type = $row->event_type; $this->variant = $row->event_variant; $this->extra = $row->event_extra ? unserialize( $row->event_extra ) : null; if ( $row->event_agent_id ) { $this->agent = User::newFromID( $row->event_agent_id ); } elseif ( $row->event_agent_ip ) { $this->agent = User::newFromName( $row->event_agent_ip, false ); } if ( $row->event_page_title !== null ) { $this->title = Title::makeTitleSafe( $row->event_page_namespace, $row->event_page_title ); } } /** * Loads data from the database into this object, given the event ID. * @param $id int Event ID * @param $fromMaster bool */ public function loadFromID( $id, $fromMaster = false ) { global $wgEchoBackend; $this->loadFromRow( $wgEchoBackend->loadEvent( $id, $fromMaster ) ); } /** * Creates an EchoEvent from a row object * * @param $row Database row object from echo_event * @return EchoEvent object. */ public static function newFromRow( $row ) { $obj = new EchoEvent(); $obj->loadFromRow( $row ); return $obj; } /** * Creates an EchoEvent from the database by ID * * @param $id int Event ID * @return EchoEvent */ public static function newFromID( $id ) { $obj = new EchoEvent(); $obj->loadFromID( $id ); return $obj; } /** * Update extra data */ public function updateExtra( $extra ) { global $wgEchoBackend; $this->extra = $extra; if ( $this->id && $this->extra ) { $wgEchoBackend->updateEventExtra( $this ); } } /** * Serialize the extra data for event * @return string */ public function serializeExtra() { if ( is_array( $this->extra ) || is_object( $this->extra ) ) { $extra = serialize( $this->extra ); } elseif ( is_null( $this->extra ) ) { $extra = null; } else { $extra = serialize( array( $this->extra ) ); } return $extra; } ## Accessors public function getId() { return $this->id; } public function getTimestamp() { return $this->timestamp; } public function getType() { return $this->type; } public function getVariant() { return $this->variant; } public function getExtra() { return $this->extra; } public function getAgent() { return $this->agent; } /** * @return Title|null */ public function getTitle() { return $this->title; } }