3 * A database wrapper for news classes
5 * @see DatabaseFrontendInterface - An interface for database frontends (front-end to the application)
6 * @author Roland Haeder <webmaster@ship-simu.org>
8 * @copyright Copyright(c) 2007, 2008 Roland Haeder, this is free software
9 * @license GNU GPL 3.0 or any newer version
10 * @link http://www.ship-simu.org
12 * This program is free software: you can redistribute it and/or modify
13 * it under the terms of the GNU General Public License as published by
14 * the Free Software Foundation, either version 3 of the License, or
15 * (at your option) any later version.
17 * This program is distributed in the hope that it will be useful,
18 * but WITHOUT ANY WARRANTY; without even the implied warranty of
19 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 * GNU General Public License for more details.
22 * You should have received a copy of the GNU General Public License
23 * along with this program. If not, see <http://www.gnu.org/licenses/>.
25 class NewsDatabaseWrapper extends BaseDatabaseWrapper {
29 private $cacheInstance = null;
31 // Constants for exceptions
32 const EXCEPTION_CLIENT_USERNAME_NOT_FOUND = 0x700;
34 // Constants for database columns
36 // Constants for database table names
37 const DB_TABLE_NEWS = "news";
40 * Protected constructor
44 protected function __construct() {
45 // Call parent constructor
46 parent::__construct(__CLASS__);
48 // Set part description
49 $this->setObjectDescription("Database wrapper for user objects");
51 // Create unique ID number
52 $this->generateUniqueId();
56 * Creates an instance of this database wrapper by a provided user class
58 * @return $wrapperInstance An instance of the created wrapper class
60 public final static function createNewsDatabaseWrapper () {
62 $wrapperInstance = new NewsDatabaseWrapper();
64 // Initialize the cache instance
65 $wrapperInstance->initCacheInstance();
67 // Return the instance
68 return $wrapperInstance;
72 * Initializes the cache instance with a new object
76 protected function initCacheInstance () {
77 // Set the new instance
78 $this->cacheInstance = CacheFactory::getFactory()->createConfiguredCache();
82 * Do a "select" query on the user table with the given search criteria and
83 * store it in cache for later usage
85 * @param $criteriaInstance An instance of a Criteria class
86 * @return $resultInstance An instance of a database result class
88 public function doSelectByCriteria (Criteria $criteriaInstance) {
89 // First get a key suitable for our cache and extend it with this class name
90 $cacheKey = sprintf("%s@%s",
92 $criteriaInstance->getCacheKey()
95 // Does this key exists in cache?
96 if ($this->cacheInstance->offsetExists($cacheKey)) {
97 // Then use this result
98 $result = $cacheInstance->offsetGet($cacheKey);
100 // Now it's time to ask the database layer for this select statement
101 $result = $this->getDatabaseInstance()->doSelectByTableCriteria(self::DB_TABLE_NEWS, $criteriaInstance);
103 // Cache the result if not null
104 if (!is_null($result)) {
105 // A valid result has returned from the database layer
106 $this->cacheInstance->offsetSet($cacheKey, $result);
108 // This invalid result must be wrapped
110 'status' => "invalid",
111 'exception' => $this->getDatabaseInstance()->getLastException()
116 // Create an instance of a DatabaseResult class with the given result
117 $resultInstance = DatabaseResult::createDatabaseResult($result);
119 // And return the instance
120 return $resultInstance;