tonyair/silverstripe-framework
1
0
Fork 0
mirror of https://github.com/silverstripe/silverstripe-framework synced 2024-10-02 14:18:46 +02:00
Code Issues Projects Releases Wiki Activity

Merge pull request #10460 from creative-commoners/pulls/5/rescue-master-dataobject-get-any-one

Browse Source 
API Rescue Master Branch PR: Allow dataobject get_one without passing a class
This commit is contained in:
Steve Boyd 2022-08-24 15:25:13 +12:00 committed by GitHub
commit f5d72e998c
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 21 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
src/ORM/DataObject.php
View File

@ -3399,24 +3399,34 @@ class DataObject extends ViewableData implements DataObjectInterface, i18nEntity
* $member = DataObject::get_one('Member', [ '"FirstName"' => 'John' ]); * $member = DataObject::get_one('Member', [ '"FirstName"' => 'John' ]);
* </code> * </code>
* *
* @param string $callerClass The class of objects to be returned * @param string|null $callerClass The class of objects to be returned. Defaults to the class that calls the method
* e.g. MyObject::get_one() will return a MyObject
* @param string|array $filter A filter to be inserted into the WHERE clause. * @param string|array $filter A filter to be inserted into the WHERE clause.
* @param boolean $cache Use caching * @param boolean $cache Use caching
* @param string $orderby A sort expression to be inserted into the ORDER BY clause. * @param string $orderBy A sort expression to be inserted into the ORDER BY clause.
* *
* @return DataObject|null The first item matching the query * @return DataObject|null The first item matching the query
*/ */
public static function get_one($callerClass, $filter = "", $cache = true, $orderby = "") public static function get_one($callerClass = null, $filter = "", $cache = true, $orderBy = "")
{ {
if ($callerClass === null) {
$callerClass = static::class;
}
// Validate class
if ($callerClass === self::class) {
throw new InvalidArgumentException('DataObject::get_one() cannot query non-subclass DataObject directly');
}
/** @var DataObject $singleton */ /** @var DataObject $singleton */
$singleton = singleton($callerClass); $singleton = singleton($callerClass);
$cacheComponents = [$filter, $orderby, $singleton->getUniqueKeyComponents()]; $cacheComponents = [$filter, $orderBy, $singleton->getUniqueKeyComponents()];
$cacheKey = md5(serialize($cacheComponents)); $cacheKey = md5(serialize($cacheComponents));
$item = null; $item = null;
if (!$cache || !isset(self::$_cache_get_one[$callerClass][$cacheKey])) { if (!$cache || !isset(self::$_cache_get_one[$callerClass][$cacheKey])) {
$dl = DataObject::get($callerClass)->where($filter)->sort($orderby); $dl = DataObject::get($callerClass)->where($filter)->sort($orderBy);
$item = $dl->first(); $item = $dl->first();
if ($cache) { if ($cache) {

6
tests/php/ORM/DataObjectTest.php
View File

@ -436,6 +436,12 @@ class DataObjectTest extends SapphireTest
$this->assertEquals('Bob', $comment->Name); $this->assertEquals('Bob', $comment->Name);
$comment = DataObject::get_one(DataObjectTest\TeamComment::class, '', true, '"Name" DESC'); $comment = DataObject::get_one(DataObjectTest\TeamComment::class, '', true, '"Name" DESC');
$this->assertEquals('Phil', $comment->Name); $this->assertEquals('Phil', $comment->Name);
// Test get_one() without passing classname
$this->assertEquals(
DataObjectTest\TeamComment::get_one(),
DataObject::get_one(DataObjectTest\TeamComment::class)
);
} }
public function testGetByIDCallerClass() public function testGetByIDCallerClass()