root/trunk/lib/model/Event.php

<?php
/**
 * Subclass for representing a row from the 'event' table.
 *
 * @package lib.model
 */
class Event extends BaseEvent 
{

  public
    $source_object = null,
    $target_object = null; 
  
  protected static $allowed_types = array(
    'addition',
    'connection', 
    'join',
    'recommendation_addition',
    'recommendation_update',
    'relation',
    'update',
    'update_profile'
  );
  
  /**
   * Exclude admin event type handling for this event types
   *
   * @var array
   */
  protected static $admin_notif_exclude_for_types = array(
    'addition', 
    'update_profile', 
    'relation', 
    'recommendation_addition', 
    'connection'
  );
  
  /**
   * Returns an array of allowed types
   *
   * @return array
   */
  public static function getAllowedTypes()
  {
    return self::$allowed_types;
  }
  
  /**
   * Retrieves related source object
   *
   * @return mixed
   */
  public function getSourceObject()
  {
    if (!$this->getSourceModel() or !$this->getSourceSlug())
    {
      $this->source_object = null;
    }
    else if (is_null($this->source_object))
    {
      $this->source_object = EventPeer::retrieveSourceObject($this->getSourceModel(), $this->getSourceSlug());
    }
    return $this->source_object;
  }
  
  /**
   * Retrieves related target object
   *
   * @return mixed
   */
  public function getTargetObject()
  {
    if (!$this->getTargetModel() or !$this->getTargetSlug())
    {
      $this->target_object = null;
    }
    else if (is_null($this->target_object))
    {
      $this->target_object = EventPeer::retrieveTargetObject($this->getTargetModel(), $this->getTargetSlug());
    }
    return $this->target_object;
  }
  
  /**
   * Checks if event has at least one duplicate entry in a given period of time
   *
   * @param  int      $period   Period, in seconds
   * @return boolean
   */
  public function hasRecentDuplicate($period = 300)
  {
    $c = new Criteria();
    $c->add(EventPeer::TYPE, $this->getType());
    $c->add(EventPeer::SOURCE_MODEL, $this->getSourceModel());
    $c->add(EventPeer::SOURCE_SLUG, $this->getSourceSlug());
    if (!is_null($this->getTargetModel()))
    {
      $c->add(EventPeer::TARGET_MODEL, $this->getTargetModel());
      $c->add(EventPeer::TARGET_SLUG, $this->getTargetSlug());
    }
    $c->add(EventPeer::OCCURED_AT, date('Y-m-d H:i:s', time() - $period), Criteria::GREATER_THAN);
    return (EventPeer::doCount($c) > 0);
  }
  
  /**
   * Sets the Event type
   *
   * @param string  $type
   */
  public function setType($type)
  {
    $type = trim(strtolower($type));
    if (!in_array($type, self::getAllowedTypes()))
    {
      throw new sfException(sprintf('"%s" is not a valid event type', $type));
    }
    parent::setType($type);
  }
  
  /**
   * Saved Event object
   * FIXME: I don't like having to deal with session in the model
   *
   * @param  Connection $con
   * @return int
   */
  public function save($con = null)
  {
    if (!$this->getType())
    {
      //sfContext::getInstance()->getLogger()->err('No type specified for event');
      return 0;
    }
    
    if ($this->hasRecentDuplicate(sfConfig::get('app_events_check_duplicates_period', 300)))
    {
      return 0;
    }
    
    $this->setOccuredAt(time());
    /*$context = @sfContext::getInstance();
    if (!is_null($context))
    {
      $session = @$context->getUser();
      $session_exists = !is_null($context->getStorage()) && !is_null($session);
      $no_admin_notification = in_array($this->getType(), self::$admin_notif_exclude_for_types); 
      if ($session_exists && $session->isAdmin())
      {
        if (!$no_admin_notification)
        {
          $this->setIsAdmin(true);
        }
      }
    }*/
    return parent::save($con);
  }
  
}