wCMF  3.6
 All Classes Namespaces Files Functions Variables Groups Pages
class.Storable.php
Go to the documentation of this file.
1 <?php
2 /**
3  * wCMF - wemove Content Management Framework
4  * Copyright (C) 2005-2014 wemove digital solutions GmbH
5  *
6  * Licensed under the terms of any of the following licenses
7  * at your choice:
8  *
9  * - GNU Lesser General Public License (LGPL)
10  * http://www.gnu.org/licenses/lgpl.html
11  * - Eclipse Public License (EPL)
12  * http://www.eclipse.org/org/documents/epl-v10.php
13  *
14  * See the license.txt file distributed with this work for
15  * additional information.
16  *
17  * $Id: class.Storable.php 1462 2014-02-04 23:52:27Z iherwig $
18  */
19 
20 /**
21  * @class Storable
22  * @ingroup Util
23  * @brief This class defines the interface for classes that can be stored in the session.
24  *
25  * @author ingo herwig <ingo@wemove.com>
26  */
27 class Storable
28 {
29  /**
30  * Get the class definition files.
31  * @return An array holding the filenames
32  */
34  {
35  WCMFException::throwEx("getClassDefinitionFiles() must be implemented by derived class: ".get_class($this), __FILE__, __LINE__);
36  }
37 
38  /**
39  * Called when the object is retrieved from the session.
40  * @note Subclasses will override this to implement their special requirements. The default implementation does nothing.
41  */
42  function loadFromSession() {}
43 
44  /**
45  * Called when the object is stored in the session.
46  * @note Subclasses will override this to implement their special requirements. The default implementation does nothing.
47  */
48  function saveToSession() {}
49 }
throwEx($message, $file='', $line='')
getClassDefinitionFiles()
This class defines the interface for classes that can be stored in the session.