* Wrapper for Memcached_DataObject which knows its own schema definition.
* Builds its own damn settings from a schema definition.
*
- * @author brion
+ * @author Brion Vibber <brion@status.net>
*/
-class Managed_DataObject extends Memcached_DataObject
+abstract class Managed_DataObject extends Memcached_DataObject
{
/**
* The One True Thingy that must be defined and declared.
*/
- public static abstract function schemaDef();
+ public static function schemaDef()
+ {
+ throw new MethodNotImplementedException(__METHOD__);
+ }
+
+ /**
+ * Get an instance by key
+ *
+ * @param string $k Key to use to lookup (usually 'id' for this class)
+ * @param mixed $v Value to lookup
+ *
+ * @return get_called_class() object if found, or null for no hits
+ *
+ */
+ static function getKV($k,$v=NULL)
+ {
+ return parent::getClassKV(get_called_class(), $k, $v);
+ }
+
+ /**
+ * Get an instance by compound key
+ *
+ * This is a utility method to get a single instance with a given set of
+ * key-value pairs. Usually used for the primary key for a compound key; thus
+ * the name.
+ *
+ * @param array $kv array of key-value mappings
+ *
+ * @return get_called_class() object if found, or null for no hits
+ *
+ */
+ static function pkeyGet(array $kv)
+ {
+ return parent::pkeyGetClass(get_called_class(), $kv);
+ }
+
+ /**
+ * Get multiple items from the database by key
+ *
+ * @param string $keyCol name of column for key
+ * @param array $keyVals key values to fetch
+ * @param boolean $skipNulls return only non-null results?
+ *
+ * @return array Array of objects, in order
+ */
+ static function multiGet($keyCol, array $keyVals, $skipNulls=true)
+ {
+ return parent::multiGetClass(get_called_class(), $keyCol, $keyVals, $skipNulls);
+ }
+
+ /**
+ * Get multiple items from the database by key
+ *
+ * @param string $keyCol name of column for key
+ * @param array $keyVals key values to fetch
+ * @param array $otherCols Other columns to hold fixed
+ *
+ * @return array Array mapping $keyVals to objects, or null if not found
+ */
+ static function pivotGet($keyCol, array $keyVals, array $otherCols=array())
+ {
+ return parent::pivotGetClass(get_called_class(), $keyCol, $keyVals, $otherCols);
+ }
+
+ /**
+ * Get a multi-instance object
+ *
+ * This is a utility method to get multiple instances with a given set of
+ * values for a specific column.
+ *
+ * @param string $keyCol key column name
+ * @param array $keyVals array of key values
+ *
+ * @return get_called_class() object with multiple instances if found,
+ * Exception is thrown when no entries are found.
+ *
+ */
+ static function listFind($keyCol, array $keyVals)
+ {
+ return parent::listFindClass(get_called_class(), $keyCol, $keyVals);
+ }
+
+ /**
+ * Get a multi-instance object separated into an array
+ *
+ * This is a utility method to get multiple instances with a given set of
+ * values for a specific key column. Usually used for the primary key when
+ * multiple values are desired. Result is an array.
+ *
+ * @param string $keyCol key column name
+ * @param array $keyVals array of key values
+ *
+ * @return array with an get_called_class() object for each $keyVals entry
+ *
+ */
+ static function listGet($keyCol, array $keyVals)
+ {
+ return parent::listGetClass(get_called_class(), $keyCol, $keyVals);
+ }
/**
* get/set an associative array of table columns
*/
function table()
{
- $table = self::schemaDef();
+ $table = static::schemaDef();
return array_map(array($this, 'columnBitmap'), $table['fields']);
}
function sequenceKey()
{
- $table = self::schemaDef();
+ $table = call_user_func(array(get_class($this), 'schemaDef'));
foreach ($table['fields'] as $name => $column) {
if ($column['type'] == 'serial') {
// We have a serial/autoincrement column.
function keyTypes()
{
+ $table = call_user_func(array(get_class($this), 'schemaDef'));
$keys = array();
- $table = self::schemaDef();
if (!empty($table['unique keys'])) {
foreach ($table['unique keys'] as $idx => $fields) {
*/
function columnBitmap($column)
{
- $type = 0;
-
- switch ($column['type']) {
- case 'int':
- case 'serial':
- case 'numeric':
- // Doesn't need quoting.
- $type |= DB_DATAOBJECT_INT;
- break;
- default:
- // Value needs quoting in SQL literal statements.
- $type |= DB_DATAOBJECT_STR;
+ $type = $column['type'];
+
+ // For quoting style...
+ $intTypes = array('int',
+ 'integer',
+ 'float',
+ 'serial',
+ 'numeric');
+ if (in_array($type, $intTypes)) {
+ $style = DB_DATAOBJECT_INT;
+ } else {
+ $style = DB_DATAOBJECT_STR;
}
- switch ($column['type']) {
- case 'blob':
- $type |= DB_DATAOBJECT_BLOB;
- break;
- case 'text':
- $type |= DB_DATAOBJECT_TXT;
- break;
- case 'datetime':
- $type |= DB_DATAOBJECT_DATE;
- $type |= DB_DATAOBJECT_TIME;
- break;
- case 'timestamp':
- $type |= DB_DATAOBJECT_MYSQLTIMESTAMP;
- break;
+ // Data type formatting style...
+ $formatStyles = array('blob' => DB_DATAOBJECT_BLOB,
+ 'text' => DB_DATAOBJECT_TXT,
+ 'date' => DB_DATAOBJECT_DATE,
+ 'time' => DB_DATAOBJECT_TIME,
+ 'datetime' => DB_DATAOBJECT_DATE | DB_DATAOBJECT_TIME,
+ 'timestamp' => DB_DATAOBJECT_MYSQLTIMESTAMP);
+
+ if (isset($formatStyles[$type])) {
+ $style |= $formatStyles[$type];
}
+ // Nullable?
if (!empty($column['not null'])) {
- $type |= DB_DATAOBJECT_NOTNULL;
+ $style |= DB_DATAOBJECT_NOTNULL;
+ }
+
+ return $style;
+ }
+
+ function links()
+ {
+ $links = array();
+
+ $table = call_user_func(array(get_class($this), 'schemaDef'));
+
+ foreach ($table['foreign keys'] as $keyname => $keydef) {
+ if (count($keydef) == 2 && is_string($keydef[0]) && is_array($keydef[1]) && count($keydef[1]) == 1) {
+ if (isset($keydef[1][0])) {
+ $links[$keydef[1][0]] = $keydef[0].':'.$keydef[1][1];
+ }
+ }
+ }
+ return $links;
+ }
+
+ /**
+ * Return a list of all primary/unique keys / vals that will be used for
+ * caching. This will understand compound unique keys, which
+ * Memcached_DataObject doesn't have enough info to handle properly.
+ *
+ * @return array of strings
+ */
+ function _allCacheKeys()
+ {
+ $table = call_user_func(array(get_class($this), 'schemaDef'));
+ $ckeys = array();
+
+ if (!empty($table['unique keys'])) {
+ $keyNames = $table['unique keys'];
+ foreach ($keyNames as $idx => $fields) {
+ $val = array();
+ foreach ($fields as $name) {
+ $val[$name] = self::valueString($this->$name);
+ }
+ $ckeys[] = self::multicacheKey($this->tableName(), $val);
+ }
}
- return $type;
+ if (!empty($table['primary key'])) {
+ $fields = $table['primary key'];
+ $val = array();
+ foreach ($fields as $name) {
+ $val[$name] = self::valueString($this->$name);
+ }
+ $ckeys[] = self::multicacheKey($this->tableName(), $val);
+ }
+ return $ckeys;
}
-}
\ No newline at end of file
+}
projects / quix0rs-gnu-social.git / blobdiff