Merge pull request #46 from creative-commoners/pulls/4.0/replace-conf…

…ig-stat-with-get FIX Replace deprecated Config stat() calls with get()
silverstripe · Dec 7, 2017 · 9e4b2ff · 9e4b2ff
2 parents 852ca33 + 334553c
commit 9e4b2ff
Show file tree

Hide file tree

Showing 5 changed files with 36 additions and 34 deletions.
diff --git a/src/BasicRestfulAuthenticator.php b/src/BasicRestfulAuthenticator.php
@@ -4,7 +4,6 @@
 
 use SilverStripe\Security\Authenticator;
 use SilverStripe\Control\Controller;
-use SilverStripe\Core\Injector\Injector;
 use SilverStripe\Security\Security;
 
 /**

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

diff --git a/src/DataFormatter/JSONDataFormatter.php b/src/DataFormatter/JSONDataFormatter.php
@@ -2,10 +2,10 @@
 
 namespace SilverStripe\RestfulServer\DataFormatter;
 
+use SilverStripe\View\ArrayData;
+use SilverStripe\Core\Convert;
 use SilverStripe\RestfulServer\DataFormatter;
 use SilverStripe\ORM\DataObjectInterface;
-use SilverStripe\Core\Convert;
-use SilverStripe\View\ArrayData;
 use SilverStripe\Control\Director;
 use SilverStripe\ORM\SS_List;
 

diff --git a/src/DataFormatter/XMLDataFormatter.php b/src/DataFormatter/XMLDataFormatter.php
@@ -2,12 +2,12 @@
 
 namespace SilverStripe\RestfulServer\DataFormatter;
 
-use SilverStripe\RestfulServer\DataFormatter;
-use SilverStripe\ORM\DataObjectInterface;
 use SilverStripe\Control\Controller;
+use SilverStripe\Core\Convert;
+use SilverStripe\RestfulServer\DataFormatter;
 use SilverStripe\ORM\DataObject;
+use SilverStripe\ORM\DataObjectInterface;
 use SilverStripe\Control\Director;
-use SilverStripe\Core\Convert;
 use SilverStripe\ORM\SS_List;
 
 /**

diff --git a/src/RestfulServer.php b/src/RestfulServer.php
@@ -2,18 +2,17 @@
 
 namespace SilverStripe\RestfulServer;
 
-use SilverStripe\RestfulServer\BasicRestfulAuthenticator;
-use SilverStripe\CMS\Model\SiteTree;
-use SilverStripe\ORM\SS_List;
 use SilverStripe\ORM\ArrayList;
+use SilverStripe\Core\Config\Config;
+use SilverStripe\Control\Controller;
+use SilverStripe\ORM\DataList;
 use SilverStripe\ORM\DataObject;
 use SilverStripe\Control\Director;
-use SilverStripe\ORM\DataList;
+use SilverStripe\Control\HTTPRequest;
+use SilverStripe\ORM\SS_List;
 use SilverStripe\Security\Member;
 use SilverStripe\Security\Security;
-use SilverStripe\Control\Controller;
-use SilverStripe\RestfulServer\DataFormatter;
-use SilverStripe\Control\HTTPRequest;
+use SilverStripe\CMS\Model\SiteTree;
 
 /**
  * Generic RESTful server, which handles webservice access to arbitrary DataObjects.
@@ -140,12 +139,12 @@ public function index(HTTPRequest $request)
         }
         if ($relation
             && !preg_match('/^[a-zA-Z_\x7f-\xff][a-zA-Z0-9_\x7f-\xff]*$/', $relation)
-            ) {
+        ) {
             return $this->notFound();
         }
 
         // if api access is disabled, don't proceed
-        $apiAccess = singleton($className)->stat('api_access');
+        $apiAccess = Config::inst()->get($className, 'api_access');
         if (!$apiAccess) {
             return $this->permissionFailure();
         }
@@ -202,10 +201,10 @@ public function index(HTTPRequest $request)
      *
      * @todo Access checking
      *
-     * @param String $className
+     * @param string $className
      * @param Int $id
-     * @param String $relation
-     * @return String The serialized representation of the requested object(s) - usually XML or JSON.
+     * @param string $relation
+     * @return string The serialized representation of the requested object(s) - usually XML or JSON.
      */
     protected function getHandler($className, $id, $relationName)
     {
@@ -311,7 +310,7 @@ protected function getSearchQuery(
      * extension or mimetype. Falls back to {@link self::$default_extension}.
      *
      * @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
      */
     protected function getDataFormatter($includeAcceptHeader = false, $className = null)
@@ -353,7 +352,7 @@ protected function getDataFormatter($includeAcceptHeader = false, $className = n
         }
         $formatter->setCustomRelations($this->getAllowedRelations($className));
 
-        $apiAccess = singleton($className)->stat('api_access');
+        $apiAccess = Config::inst()->get($className, 'api_access');
         if (is_array($apiAccess)) {
             $formatter->setCustomAddFields(
                 array_intersect((array)$formatter->getCustomAddFields(), (array)$apiAccess['view'])
@@ -384,7 +383,7 @@ protected function getDataFormatter($includeAcceptHeader = false, $className = n
     }
 
     /**
-     * @param String Classname of a DataObject
+     * @param string Classname of a DataObject
      * @return DataFormatter
      */
     protected function getRequestDataFormatter($className = null)
@@ -393,7 +392,7 @@ protected function getRequestDataFormatter($className = null)
     }
 
     /**
-     * @param String Classname of a DataObject
+     * @param string Classname of a DataObject
      * @return DataFormatter
      */
     protected function getResponseDataFormatter($className = null)
@@ -493,7 +492,8 @@ protected function postHandler($className, $id, $relation)
                 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();
             }
 
@@ -568,7 +568,7 @@ protected function updateDataObject($obj, $formatter)
         }
 
         // @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'));
         $apiAccess = singleton($className)->config()->api_access;
@@ -593,7 +593,7 @@ protected function updateDataObject($obj, $formatter)
      */
     protected function getObjectQuery($className, $id, $params)
     {
-        return DataList::create($className)->byIDs(array($id));
+        return DataList::create($className)->byIDs([$id]);
     }
 
     /**
@@ -632,7 +632,9 @@ protected function getObjectRelationQuery($obj, $params, $sort, $limit, $relatio
                 $list = $obj->$relationName();
             }
 
-            $apiAccess = singleton($list->dataClass())->stat('api_access');
+            $apiAccess = Config::inst()->get($list->dataClass(), 'api_access');
+
+
             if (!$apiAccess) {
                 return false;
             }
@@ -695,15 +697,15 @@ protected function authenticate()
      */
     protected function getAllowedRelations($class, $member = null)
     {
-        $allowedRelations = array();
+        $allowedRelations = [];
         $obj = singleton($class);
         $relations = (array)$obj->hasOne() + (array)$obj->hasMany() + (array)$obj->manyMany();
         if ($relations) {
             foreach ($relations as $relName => $relClass) {
                 //remove dot notation from relation names
                 $parts = explode('.', $relClass);
                 $relClass = array_shift($parts);
-                if (singleton($relClass)->stat('api_access')) {
+                if (Config::inst()->get($relClass, 'api_access')) {
                     $allowedRelations[] = $relName;
                 }
             }