3 * StatusNet - the distributed open-source microblogging tool
4 * Copyright (C) 2010, StatusNet, Inc.
6 * This program is free software: you can redistribute it and/or modify
7 * it under the terms of the GNU Affero General Public License as published by
8 * the Free Software Foundation, either version 3 of the License, or
9 * (at your option) any later version.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU Affero General Public License for more details.
16 * You should have received a copy of the GNU Affero General Public License
17 * along with this program. If not, see <http://www.gnu.org/licenses/>.
21 * Wrapper for Memcached_DataObject which knows its own schema definition.
22 * Builds its own damn settings from a schema definition.
24 * @author Brion Vibber <brion@status.net>
26 abstract class Managed_DataObject extends Memcached_DataObject
29 * The One True Thingy that must be defined and declared.
31 public static abstract function schemaDef();
34 * get/set an associative array of table columns
37 * @return array (associative)
41 $table = self::schemaDef();
42 return array_map(array($this, 'columnBitmap'), $table['fields']);
46 * get/set an array of table primary keys
48 * Key info is pulled from the table definition array.
55 return array_keys($this->keyTypes());
61 * Returns the first serial column defined in the table, if any.
64 * @return array (column,use_native,sequence_name)
67 function sequenceKey()
69 $table = self::schemaDef();
70 foreach ($table['fields'] as $name => $column) {
71 if ($column['type'] == 'serial') {
72 // We have a serial/autoincrement column.
73 // Declare it to be a native sequence!
74 return array($name, true, false);
78 // No sequence key on this table.
79 return array(false, false, false);
83 * Return key definitions for DB_DataObject and Memcache_DataObject.
85 * DB_DataObject needs to know about keys that the table has; this function
88 * @return array key definitions
94 $table = self::schemaDef();
96 if (!empty($table['unique keys'])) {
97 foreach ($table['unique keys'] as $idx => $fields) {
98 foreach ($fields as $name) {
104 if (!empty($table['primary key'])) {
105 foreach ($table['primary key'] as $name) {
113 * Build the appropriate DB_DataObject bitfield map for this field.
115 * @param array $column
118 function columnBitmap($column)
120 $type = $column['type'];
122 // For quoting style...
123 $intTypes = array('int',
128 if (in_array($type, $intTypes)) {
129 $style = DB_DATAOBJECT_INT;
131 $style = DB_DATAOBJECT_STR;
134 // Data type formatting style...
135 $formatStyles = array('blob' => DB_DATAOBJECT_BLOB,
136 'text' => DB_DATAOBJECT_TXT,
137 'date' => DB_DATAOBJECT_DATE,
138 'time' => DB_DATAOBJECT_TIME,
139 'datetime' => DB_DATAOBJECT_DATE | DB_DATAOBJECT_TIME,
140 'timestamp' => DB_DATAOBJECT_MYSQLTIMESTAMP);
142 if (isset($formatStyles[$type])) {
143 $style |= $formatStyles[$type];
147 if (!empty($column['not null'])) {
148 $style |= DB_DATAOBJECT_NOTNULL;