class.Storable.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.Storable.php 1462 2014-02-04 23:52:27Z iherwig $
 */

/**
 * @class Storable
 * @ingroup Util
 * @brief This class defines the interface for classes that can be stored in the session.
 *
 * @author      ingo herwig <ingo@wemove.com>
 */
class Storable
{
  /**
   * Get the class definition files.
   * @return An array holding the filenames
   */  
  function getClassDefinitionFiles()
  {
    WCMFException::throwEx("getClassDefinitionFiles() must be implemented by derived class: ".get_class($this), __FILE__, __LINE__);
  }

  /**
   * Called when the object is retrieved from the session.
   * @note Subclasses will override this to implement their special requirements. The default implementation does nothing.
   */  
  function loadFromSession() {}

  /**
   * Called when the object is stored in the session.
   * @note Subclasses will override this to implement their special requirements. The default implementation does nothing.
   */  
  function saveToSession() {}
}