class.ChangeListener.php

Go to the documentation of this file.

<?php
/**
 * wCMF - wemove Content Management Framework
 * Copyright (C) 2005-2014 wemove digital solutions GmbH
 *
 * Licensed under the terms of any of the following licenses 
 * at your choice:
 *
 * - GNU Lesser General Public License (LGPL)
 *   http://www.gnu.org/licenses/lgpl.html
 * - Eclipse Public License (EPL)
 *   http://www.eclipse.org/org/documents/epl-v10.php
 *
 * See the license.txt file distributed with this work for 
 * additional information.
 *
 * $Id: class.ChangeListener.php 1462 2014-02-04 23:52:27Z iherwig $
 */

/**
 * @class ChangeListener
 * @ingroup Persistence
 * @brief ChangeListener defines an interface for classes that want to
 * be notified when a value of an persistent object changes.

 * @author      ingo herwig <ingo@wemove.com>
 */
class ChangeListener
{
  /**
   * Get a unique id for the listener.
   * @return The id
   */  
  function getId()
  {
    WCMFException::throwEx("getId() must be implemented by derived class: ".get_class($this), __FILE__, __LINE__);
  }
  /**
   * This method is called, when a named item has changed.
   * @param object A reference to the PersistentObject that holds the item
   * @param name The name of the item that has changed.
   * @param type The type of the item that has changed.
   * @param oldValue The old value of the item that has changed
   * @param newValue The new value of the item that has changed
   */  
  function valueChanged(&$object, $name, $type, $oldValue, $newValue)
  {
    WCMFException::throwEx("valueChanged() must be implemented by derived class: ".get_class($this), __FILE__, __LINE__);
  }
  /**
   * This method is called, when a property has changed.
   * @param object A reference to the PersistentObject that holds the property
   * @param name The name of the property that has changed.
   * @param oldValue The old value of the item that has changed
   * @param newValue The new value of the item that has changed
   */  
  function propertyChanged(&$object, $name, $oldValue, $newValue)
  {
    WCMFException::throwEx("propertyChanged() must be implemented by derived class: ".get_class($this), __FILE__, __LINE__);
  }
  /**
   * This method is called, when the state has changed.
   * @param object A reference to the PersistentObject that changed it's state
   * @param oldValue The old value of the state
   * @param newValue The new value of the state
   */  
  function stateChanged(&$object, $oldValue, $newValue)
  {
    WCMFException::throwEx("stateChanged() must be implemented by derived class: ".get_class($this), __FILE__, __LINE__);
  }
}
?>