InterceptionEvent.php

<?php
/**
 * Copyright 2011 Benjamin Wöster. All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without modification, are
 * permitted provided that the following conditions are met:
 *
 *    1. Redistributions of source code must retain the above copyright notice, this list of
 *       conditions and the following disclaimer.
 *
 *    2. Redistributions in binary form must reproduce the above copyright notice, this list
 *       of conditions and the following disclaimer in the documentation and/or other materials
 *       provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY BENJAMIN WÖSTER ``AS IS'' AND ANY EXPRESS OR IMPLIED
 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
 * FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL BENJAMIN WÖSTER OR
 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
 * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
 * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 * The views and conclusions contained in the software and documentation are those of the
 * authors and should not be interpreted as representing official policies, either expressed
 * or implied, of Benjamin Wöster.
 */



/**
 * InterceptionEvent raised by EventInterceptor.
 * Provides convenience methods to access the intercepted event object as well
 * as the name of the intercepted event.
 *
 * @author Benjamin Wöster
 */
class InterceptionEvent extends CEvent
{
  const INTERCEPTED_EVENT_PARAM       = 'INTERCEPTED_EVENT_PARAM';
  const INTERCEPTED_EVENT_NAME_PARAM  = 'INTERCEPTED_EVENT_NAME_PARAM';

  /**
   * @return string
   */
  public function getInterceptedEventName()
  {
    return $this->params[ InterceptionEvent::INTERCEPTED_EVENT_NAME_PARAM ];
  }

  /**
   * @return CEvent
   */
  public function getInterceptedEvent()
  {
    return $this->params[ InterceptionEvent::INTERCEPTED_EVENT_PARAM ];
  }
}