tonyair
/
silverstripe-restfulserver
mirror of https://github.com/silverstripe/silverstripe-restfulserver
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

FIX Replace deprecated Config stat() calls with get()

This commit is contained in:
Raissa North 2017-12-06 16:18:14 +13:00
parent 852ca334b8
commit 334553c779
5 changed files with 37 additions and 35 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
src/BasicRestfulAuthenticator.php
View File

@ -4,7 +4,6 @@ namespace SilverStripe\RestfulServer;
use SilverStripe\Security\Authenticator; use SilverStripe\Security\Authenticator;
use SilverStripe\Control\Controller; use SilverStripe\Control\Controller;
use SilverStripe\Core\Injector\Injector;
use SilverStripe\Security\Security; use SilverStripe\Security\Security;
/** /**

13
src/DataFormatter.php
View File

@ -3,6 +3,7 @@
namespace SilverStripe\RestfulServer; namespace SilverStripe\RestfulServer;
use SilverStripe\Core\ClassInfo; use SilverStripe\Core\ClassInfo;
use SilverStripe\Core\Config\Config;
use SilverStripe\Core\Config\Configurable; use SilverStripe\Core\Config\Configurable;
use SilverStripe\ORM\DataObject; use SilverStripe\ORM\DataObject;
use SilverStripe\ORM\DataObjectInterface; use SilverStripe\ORM\DataObjectInterface;
@ -115,9 +116,9 @@ abstract class DataFormatter
{ {
$classes = ClassInfo::subclassesFor(DataFormatter::class); $classes = ClassInfo::subclassesFor(DataFormatter::class);
array_shift($classes); array_shift($classes);
$sortedClasses = array(); $sortedClasses = [];
foreach ($classes as $class) { foreach ($classes as $class) {
$sortedClasses[$class] = singleton($class)->stat('priority'); $sortedClasses[$class] = Config::inst()->get($class, 'priority');
} }
arsort($sortedClasses); arsort($sortedClasses);
foreach ($sortedClasses as $className => $priority) { foreach ($sortedClasses as $className => $priority) {
@ -155,9 +156,9 @@ abstract class DataFormatter
{ {
$classes = ClassInfo::subclassesFor(DataFormatter::class); $classes = ClassInfo::subclassesFor(DataFormatter::class);
array_shift($classes); array_shift($classes);
$sortedClasses = array(); $sortedClasses = [];
foreach ($classes as $class) { foreach ($classes as $class) {
$sortedClasses[$class] = singleton($class)->stat('priority'); $sortedClasses[$class] = Config::inst()->get($class, 'priority');
} }
arsort($sortedClasses); arsort($sortedClasses);
foreach ($sortedClasses as $className => $priority) { foreach ($sortedClasses as $className => $priority) {
@ -294,7 +295,7 @@ abstract class DataFormatter
*/ */
protected function getFieldsForObj($obj) protected function getFieldsForObj($obj)
{ {
$dbFields = array(); $dbFields = [];
// if custom fields are specified, only select these // if custom fields are specified, only select these
if (is_array($this->customFields)) { if (is_array($this->customFields)) {
@ -320,7 +321,7 @@ abstract class DataFormatter
} }
// add default required fields // add default required fields
$dbFields = array_merge($dbFields, array('ID'=>'Int')); $dbFields = array_merge($dbFields, ['ID' => 'Int']);
if (is_array($this->removeFields)) { if (is_array($this->removeFields)) {
$dbFields = array_diff_key($dbFields, array_combine($this->removeFields, $this->removeFields)); $dbFields = array_diff_key($dbFields, array_combine($this->removeFields, $this->removeFields));

4
src/DataFormatter/JSONDataFormatter.php
View File

@ -2,10 +2,10 @@
namespace SilverStripe\RestfulServer\DataFormatter; namespace SilverStripe\RestfulServer\DataFormatter;
use SilverStripe\View\ArrayData;
use SilverStripe\Core\Convert;
use SilverStripe\RestfulServer\DataFormatter; use SilverStripe\RestfulServer\DataFormatter;
use SilverStripe\ORM\DataObjectInterface; use SilverStripe\ORM\DataObjectInterface;
use SilverStripe\Core\Convert;
use SilverStripe\View\ArrayData;
use SilverStripe\Control\Director; use SilverStripe\Control\Director;
use SilverStripe\ORM\SS_List; use SilverStripe\ORM\SS_List;

8
src/DataFormatter/XMLDataFormatter.php
View File

@ -2,12 +2,12 @@
namespace SilverStripe\RestfulServer\DataFormatter; namespace SilverStripe\RestfulServer\DataFormatter;
use SilverStripe\RestfulServer\DataFormatter;
use SilverStripe\ORM\DataObjectInterface;
use SilverStripe\Control\Controller; use SilverStripe\Control\Controller;
use SilverStripe\ORM\DataObject;
use SilverStripe\Control\Director;
use SilverStripe\Core\Convert; use SilverStripe\Core\Convert;
use SilverStripe\RestfulServer\DataFormatter;
use SilverStripe\ORM\DataObject;
use SilverStripe\ORM\DataObjectInterface;
use SilverStripe\Control\Director;
use SilverStripe\ORM\SS_List; use SilverStripe\ORM\SS_List;
/** /**

46
src/RestfulServer.php
View File

@ -2,18 +2,17 @@
namespace SilverStripe\RestfulServer; namespace SilverStripe\RestfulServer;
use SilverStripe\RestfulServer\BasicRestfulAuthenticator;
use SilverStripe\CMS\Model\SiteTree;
use SilverStripe\ORM\SS_List;
use SilverStripe\ORM\ArrayList; use SilverStripe\ORM\ArrayList;
use SilverStripe\Core\Config\Config;
use SilverStripe\Control\Controller;
use SilverStripe\ORM\DataList;
use SilverStripe\ORM\DataObject; use SilverStripe\ORM\DataObject;
use SilverStripe\Control\Director; use SilverStripe\Control\Director;
use SilverStripe\ORM\DataList; use SilverStripe\Control\HTTPRequest;
use SilverStripe\ORM\SS_List;
use SilverStripe\Security\Member; use SilverStripe\Security\Member;
use SilverStripe\Security\Security; use SilverStripe\Security\Security;
use SilverStripe\Control\Controller; use SilverStripe\CMS\Model\SiteTree;
use SilverStripe\RestfulServer\DataFormatter;
use SilverStripe\Control\HTTPRequest;
/** /**
* Generic RESTful server, which handles webservice access to arbitrary DataObjects. * Generic RESTful server, which handles webservice access to arbitrary DataObjects.
@ -140,12 +139,12 @@ class RestfulServer extends Controller
} }
if ($relation if ($relation
&& !preg_match('/^[a-zA-Z_\x7f-\xff][a-zA-Z0-9_\x7f-\xff]*$/', $relation) && !preg_match('/^[a-zA-Z_\x7f-\xff][a-zA-Z0-9_\x7f-\xff]*$/', $relation)
) { ) {
return $this->notFound(); return $this->notFound();
} }
// if api access is disabled, don't proceed // if api access is disabled, don't proceed
$apiAccess = singleton($className)->stat('api_access'); $apiAccess = Config::inst()->get($className, 'api_access');
if (!$apiAccess) { if (!$apiAccess) {
return $this->permissionFailure(); return $this->permissionFailure();
} }
@ -202,10 +201,10 @@ class RestfulServer extends Controller
* *
* @todo Access checking * @todo Access checking
* *
* @param String $className * @param string $className
* @param Int $id * @param Int $id
* @param String $relation * @param string $relation
* @return String The serialized representation of the requested object(s) - usually XML or JSON. * @return string The serialized representation of the requested object(s) - usually XML or JSON.
*/ */
protected function getHandler($className, $id, $relationName) protected function getHandler($className, $id, $relationName)
{ {
@ -311,7 +310,7 @@ class RestfulServer extends Controller
* extension or mimetype. Falls back to {@link self::$default_extension}. * extension or mimetype. Falls back to {@link self::$default_extension}.
* *
* @param boolean $includeAcceptHeader Determines wether to inspect and prioritize any HTTP Accept headers * @param boolean $includeAcceptHeader Determines wether to inspect and prioritize any HTTP Accept headers
* @param String Classname of a DataObject * @param string Classname of a DataObject
* @return DataFormatter * @return DataFormatter
*/ */
protected function getDataFormatter($includeAcceptHeader = false, $className = null) protected function getDataFormatter($includeAcceptHeader = false, $className = null)
@ -353,7 +352,7 @@ class RestfulServer extends Controller
} }
$formatter->setCustomRelations($this->getAllowedRelations($className)); $formatter->setCustomRelations($this->getAllowedRelations($className));
$apiAccess = singleton($className)->stat('api_access'); $apiAccess = Config::inst()->get($className, 'api_access');
if (is_array($apiAccess)) { if (is_array($apiAccess)) {
$formatter->setCustomAddFields( $formatter->setCustomAddFields(
array_intersect((array)$formatter->getCustomAddFields(), (array)$apiAccess['view']) array_intersect((array)$formatter->getCustomAddFields(), (array)$apiAccess['view'])
@ -384,7 +383,7 @@ class RestfulServer extends Controller
} }
/** /**
* @param String Classname of a DataObject * @param string Classname of a DataObject
* @return DataFormatter * @return DataFormatter
*/ */
protected function getRequestDataFormatter($className = null) protected function getRequestDataFormatter($className = null)
@ -393,7 +392,7 @@ class RestfulServer extends Controller
} }
/** /**
* @param String Classname of a DataObject * @param string Classname of a DataObject
* @return DataFormatter * @return DataFormatter
*/ */
protected function getResponseDataFormatter($className = null) protected function getResponseDataFormatter($className = null)
@ -493,7 +492,8 @@ class RestfulServer extends Controller
return $this->notFound(); return $this->notFound();
} }
if (!$obj->stat('allowed_actions') || !in_array($relation, $obj->stat('allowed_actions'))) { if (!Config::inst()->get($className, 'allowed_actions') ||
!in_array($relation, Config::inst()->get($className, 'allowed_actions'))) {
return $this->permissionFailure(); return $this->permissionFailure();
} }
@ -568,7 +568,7 @@ class RestfulServer extends Controller
} }
// @todo Disallow editing of certain keys in database // @todo Disallow editing of certain keys in database
$data = array_diff_key($data, array('ID', 'Created')); $data = array_diff_key($data, ['ID', 'Created']);
$className = $this->unsanitiseClassName($this->request->param('ClassName')); $className = $this->unsanitiseClassName($this->request->param('ClassName'));
$apiAccess = singleton($className)->config()->api_access; $apiAccess = singleton($className)->config()->api_access;
@ -593,7 +593,7 @@ class RestfulServer extends Controller
*/ */
protected function getObjectQuery($className, $id, $params) protected function getObjectQuery($className, $id, $params)
{ {
return DataList::create($className)->byIDs(array($id)); return DataList::create($className)->byIDs([$id]);
} }
/** /**
@ -632,7 +632,9 @@ class RestfulServer extends Controller
$list = $obj->$relationName(); $list = $obj->$relationName();
} }
$apiAccess = singleton($list->dataClass())->stat('api_access'); $apiAccess = Config::inst()->get($list->dataClass(), 'api_access');
if (!$apiAccess) { if (!$apiAccess) {
return false; return false;
} }
@ -695,7 +697,7 @@ class RestfulServer extends Controller
*/ */
protected function getAllowedRelations($class, $member = null) protected function getAllowedRelations($class, $member = null)
{ {
$allowedRelations = array(); $allowedRelations = [];
$obj = singleton($class); $obj = singleton($class);
$relations = (array)$obj->hasOne() + (array)$obj->hasMany() + (array)$obj->manyMany(); $relations = (array)$obj->hasOne() + (array)$obj->hasMany() + (array)$obj->manyMany();
if ($relations) { if ($relations) {
@ -703,7 +705,7 @@ class RestfulServer extends Controller
//remove dot notation from relation names //remove dot notation from relation names
$parts = explode('.', $relClass); $parts = explode('.', $relClass);
$relClass = array_shift($parts); $relClass = array_shift($parts);
if (singleton($relClass)->stat('api_access')) { if (Config::inst()->get($relClass, 'api_access')) {
$allowedRelations[] = $relName; $allowedRelations[] = $relName;
} }
} }