Add translator documentation.

Fix incorrect i18n.
Whitespace updates.
This commit is contained in:
Siebrand Mazeland 2011-08-19 17:38:43 +02:00
parent 083e9773f2
commit 73806460ce

View File

@ -63,156 +63,158 @@ class Memcached_DataObject extends Safe_DataObject
} }
return $i; return $i;
} }
/** /**
* Get multiple items from the database by key * Get multiple items from the database by key
* *
* @param string $cls Class to fetch * @param string $cls Class to fetch
* @param string $keyCol name of column for key * @param string $keyCol name of column for key
* @param array $keyVals key values to fetch * @param array $keyVals key values to fetch
* @param boolean $skipNulls return only non-null results? * @param boolean $skipNulls return only non-null results?
* *
* @return array Array of objects, in order * @return array Array of objects, in order
*/ */
function multiGet($cls, $keyCol, $keyVals, $skipNulls=true) function multiGet($cls, $keyCol, $keyVals, $skipNulls=true)
{ {
$result = self::pivotGet($cls, $keyCol, $keyVals); $result = self::pivotGet($cls, $keyCol, $keyVals);
$values = array_values($result); $values = array_values($result);
if ($skipNulls) { if ($skipNulls) {
$tmp = array(); $tmp = array();
foreach ($values as $value) { foreach ($values as $value) {
if (!empty($value)) { if (!empty($value)) {
$tmp[] = $value; $tmp[] = $value;
} }
} }
$values = $tmp; $values = $tmp;
} }
return new ArrayWrapper($values); return new ArrayWrapper($values);
} }
/** /**
* Get multiple items from the database by key * Get multiple items from the database by key
* *
* @param string $cls Class to fetch * @param string $cls Class to fetch
* @param string $keyCol name of column for key * @param string $keyCol name of column for key
* @param array $keyVals key values to fetch * @param array $keyVals key values to fetch
* @param boolean $otherCols Other columns to hold fixed * @param boolean $otherCols Other columns to hold fixed
* *
* @return array Array mapping $keyVals to objects, or null if not found * @return array Array mapping $keyVals to objects, or null if not found
*/ */
static function pivotGet($cls, $keyCol, $keyVals, $otherCols = array()) static function pivotGet($cls, $keyCol, $keyVals, $otherCols = array())
{ {
$result = array_fill_keys($keyVals, null); $result = array_fill_keys($keyVals, null);
$toFetch = array(); $toFetch = array();
foreach ($keyVals as $keyVal) { foreach ($keyVals as $keyVal) {
$kv = array_merge($otherCols, array($keyCol => $keyVal)); $kv = array_merge($otherCols, array($keyCol => $keyVal));
$i = self::multicache($cls, $kv); $i = self::multicache($cls, $kv);
if ($i !== false) { if ($i !== false) {
$result[$keyVal] = $i; $result[$keyVal] = $i;
} else if (!empty($keyVal)) { } else if (!empty($keyVal)) {
$toFetch[] = $keyVal; $toFetch[] = $keyVal;
} }
} }
if (count($toFetch) > 0) { if (count($toFetch) > 0) {
$i = DB_DataObject::factory($cls); $i = DB_DataObject::factory($cls);
if (empty($i)) { if (empty($i)) {
throw new Exception(_('Cannot instantiate class ' . $cls)); // TRANS: Exception thrown when a class (%s) could not be instantiated.
throw new Exception(sprintf(_('Cannot instantiate class %s.'),$cls));
} }
foreach ($otherCols as $otherKeyCol => $otherKeyVal) { foreach ($otherCols as $otherKeyCol => $otherKeyVal) {
$i->$otherKeyCol = $otherKeyVal; $i->$otherKeyCol = $otherKeyVal;
} }
$i->whereAddIn($keyCol, $toFetch, $i->columnType($keyCol)); $i->whereAddIn($keyCol, $toFetch, $i->columnType($keyCol));
if ($i->find()) { if ($i->find()) {
while ($i->fetch()) { while ($i->fetch()) {
$copy = clone($i); $copy = clone($i);
$copy->encache(); $copy->encache();
$result[$i->$keyCol] = $copy; $result[$i->$keyCol] = $copy;
} }
} }
// Save state of DB misses // Save state of DB misses
foreach ($toFetch as $keyVal) { foreach ($toFetch as $keyVal) {
if (empty($result[$keyVal])) { if (empty($result[$keyVal])) {
$kv = array_merge($otherCols, array($keyCol => $keyVal)); $kv = array_merge($otherCols, array($keyCol => $keyVal));
// save the fact that no such row exists // save the fact that no such row exists
$c = self::memcache(); $c = self::memcache();
if (!empty($c)) { if (!empty($c)) {
$ck = self::multicacheKey($cls, $kv); $ck = self::multicacheKey($cls, $kv);
$c->set($ck, null); $c->set($ck, null);
} }
} }
} }
} }
return $result; return $result;
} }
function listGet($cls, $keyCol, $keyVals) function listGet($cls, $keyCol, $keyVals)
{ {
$result = array_fill_keys($keyVals, array()); $result = array_fill_keys($keyVals, array());
$toFetch = array(); $toFetch = array();
foreach ($keyVals as $keyVal) { foreach ($keyVals as $keyVal) {
$l = self::cacheGet(sprintf("%s:list:%s:%s", $cls, $keyCol, $keyVal)); $l = self::cacheGet(sprintf("%s:list:%s:%s", $cls, $keyCol, $keyVal));
if ($l !== false) { if ($l !== false) {
$result[$keyVal] = $l; $result[$keyVal] = $l;
} else { } else {
$toFetch[] = $keyVal; $toFetch[] = $keyVal;
} }
} }
if (count($toFetch) > 0) { if (count($toFetch) > 0) {
$i = DB_DataObject::factory($cls); $i = DB_DataObject::factory($cls);
if (empty($i)) { if (empty($i)) {
throw new Exception(_('Cannot instantiate class ' . $cls)); // TRANS: Exception thrown when a class (%s) could not be instantiated.
} throw new Exception(sprintf(_('Cannot instantiate class %s.'),$cls));
$i->whereAddIn($keyCol, $toFetch, $i->columnType($keyCol)); }
if ($i->find()) { $i->whereAddIn($keyCol, $toFetch, $i->columnType($keyCol));
while ($i->fetch()) { if ($i->find()) {
$copy = clone($i); while ($i->fetch()) {
$copy->encache(); $copy = clone($i);
$result[$i->$keyCol][] = $copy; $copy->encache();
} $result[$i->$keyCol][] = $copy;
} }
foreach ($toFetch as $keyVal) }
{ foreach ($toFetch as $keyVal)
self::cacheSet(sprintf("%s:list:%s:%s", $cls, $keyCol, $keyVal), {
$result[$keyVal]); self::cacheSet(sprintf("%s:list:%s:%s", $cls, $keyCol, $keyVal),
} $result[$keyVal]);
}
}
return $result;
}
function columnType($columnName)
{
$keys = $this->table();
if (!array_key_exists($columnName, $keys)) {
throw new Exception('Unknown key column ' . $columnName . ' in ' . join(',', array_keys($keys)));
}
$def = $keys[$columnName];
if ($def & DB_DATAOBJECT_INT) {
return 'integer';
} else {
return 'string';
} }
return $result;
} }
function columnType($columnName)
{
$keys = $this->table();
if (!array_key_exists($columnName, $keys)) {
throw new Exception('Unknown key column ' . $columnName . ' in ' . join(',', array_keys($keys)));
}
$def = $keys[$columnName];
if ($def & DB_DATAOBJECT_INT) {
return 'integer';
} else {
return 'string';
}
}
/** /**
* @fixme Should this return false on lookup fail to match staticGet? * @todo FIXME: Should this return false on lookup fail to match staticGet?
*/ */
function pkeyGet($cls, $kv) function pkeyGet($cls, $kv)
{ {
@ -225,13 +227,13 @@ class Memcached_DataObject extends Safe_DataObject
return false; return false;
} }
foreach ($kv as $k => $v) { foreach ($kv as $k => $v) {
if (is_null($v)) { if (is_null($v)) {
// XXX: possible SQL injection...? Don't // XXX: possible SQL injection...? Don't
// pass keys from the browser, eh. // pass keys from the browser, eh.
$i->whereAdd("$k is null"); $i->whereAdd("$k is null");
} else { } else {
$i->$k = $v; $i->$k = $v;
} }
} }
if ($i->find(true)) { if ($i->find(true)) {
$i->encache(); $i->encache();
@ -562,7 +564,7 @@ class Memcached_DataObject extends Safe_DataObject
continue; continue;
} }
if (in_array($func, $ignoreStatic)) { if (in_array($func, $ignoreStatic)) {
continue; // @fixme this shouldn't be needed? continue; // @todo FIXME: This shouldn't be needed?
} }
$here = get_class($frame['object']) . '->' . $func; $here = get_class($frame['object']) . '->' . $func;
break; break;
@ -705,7 +707,7 @@ class Memcached_DataObject extends Safe_DataObject
if (!$dsn) { if (!$dsn) {
// TRANS: Exception thrown when database name or Data Source Name could not be found. // TRANS: Exception thrown when database name or Data Source Name could not be found.
throw new Exception(_("No database name or DSN found anywhere.")); throw new Exception(_('No database name or DSN found anywhere.'));
} }
return $dsn; return $dsn;