API Standardise OperationResolver::resolve() (#28)

API PaginatedQueryCreator is abstract PSR2 cleanup PHPDoc cleanup
silverstripe · Dec 20, 2016 · 467e2d7 · 467e2d7
1 parent 0cbffc9
commit 467e2d7
Show file tree

Hide file tree

Showing 17 changed files with 160 additions and 147 deletions.
diff --git a/README.md b/README.md
@@ -98,10 +98,11 @@ namespace MyProject\GraphQL;
 
 use GraphQL\Type\Definition\Type;
 use SilverStripe\GraphQL\QueryCreator;
+use SilverStripe\GraphQL\OperationResolver;
 use MyProject\MyDataObject;
 use SilverStripe\Security\Member;
 
-class ReadMembersQueryCreator extends QueryCreator
+class ReadMembersQueryCreator extends QueryCreator implements OperationResolver
 {
 
     public function attributes()
@@ -126,7 +127,7 @@ class ReadMembersQueryCreator extends QueryCreator
     }
 
 
-    public function resolve($args)
+    public function resolve($object, array $args, $context, $info)
     {
         $list = Member::get();
 
@@ -372,10 +373,10 @@ namespace MyProject\GraphQL;
 
 use GraphQL\Type\Definition\Type;
 use SilverStripe\GraphQL\MutationCreator;
+use SilverStripe\GraphQL\OperationResolver;
 use SilverStripe\Security\Member;
 
-
-class CreateMemberMutationCreator extends MutationCreator
+class CreateMemberMutationCreator extends MutationCreator implements OperationResolver
 {
 
    public function attributes()

diff --git a/src/Controller.php b/src/Controller.php
@@ -5,7 +5,6 @@
 use SilverStripe\Control\Controller as BaseController;
 use SilverStripe\Control\HTTPRequest;
 use SilverStripe\Control\HTTPResponse;
-use SilverStripe\Core\Injector\Injector;
 use SilverStripe\Core\Config\Config;
 use SilverStripe\Control\Director;
 use Exception;
@@ -37,7 +36,7 @@ public function index(HTTPRequest $request)
         $variables = isset($data['variables']) ? $data['variables'] : null;
 
         // Some clients (e.g. GraphiQL) double encode as string
-        if(is_string($variables)) {
+        if (is_string($variables)) {
             $variables = json_decode($variables, true);
         }
 
@@ -48,7 +47,7 @@ public function index(HTTPRequest $request)
         } catch (Exception $exception) {
             $error = ['message' => $exception->getMessage()];
 
-            if(Director::isDev()) {
+            if (Director::isDev()) {
                 $error['code'] = $exception->getCode();
                 $error['file'] = $exception->getFile();
                 $error['line'] = $exception->getLine();

diff --git a/src/DataObjectInterfaceTypeCreator.php b/src/DataObjectInterfaceTypeCreator.php
@@ -2,14 +2,13 @@
 
 namespace SilverStripe\GraphQL;
 
-use SilverStripe\GraphQL\Util\CaseInsensitiveFieldAccessor;
 use GraphQL\Type\Definition\Type;
 
 /**
  * Base interface for any {@link DataObject} passed back as a node.
- *
  */
-class DataObjectInterfaceTypeCreator extends InterfaceTypeCreator {
+class DataObjectInterfaceTypeCreator extends InterfaceTypeCreator
+{
 
     public function attributes()
     {
@@ -19,7 +18,8 @@ public function attributes()
         ];
     }
 
-    public function fields() {
+    public function fields()
+    {
         return [
             'id' => [
                 'type' => Type::nonNull(Type::int()),
@@ -37,15 +37,14 @@ public function resolveType($object)
     {
         $type = null;
 
-        if($fqnType = $this->manager->getType(get_class($object))) {
+        if ($fqnType = $this->manager->getType(get_class($object))) {
             $type = $fqnType;
         }
 
-        if($baseType = $this->manager->getType(get_class($object))) {
+        if ($baseType = $this->manager->getType(get_class($object))) {
             $type = $baseType;
         }
 
         return $type;
     }
-
 }
diff --git a/src/FieldCreator.php b/src/FieldCreator.php
@@ -4,8 +4,6 @@
 
 use SilverStripe\Core\Object;
 use GraphQL\Type\Definition\Type;
-use SilverStripe\GraphQL\Manager;
-use SilverStripe\ORM\Limitable;
 
 class FieldCreator extends Object
 {
@@ -97,10 +95,12 @@ public function __get($key)
 
         return isset($attributes[$key]) ? $attributes[$key] : null;
     }
+
     /**
      * Dynamically check if an attribute is set.
      *
      * @param string $key
+     * @return bool
      */
     public function __isset($key)
     {
@@ -114,7 +114,7 @@ public function __isset($key)
      */
     protected function getResolver()
     {
-        if (!method_exists($this, 'resolve')) {
+        if (! method_exists($this, 'resolve')) {
             return null;
         }
 

diff --git a/src/GraphiQLController.php b/src/GraphiQLController.php
@@ -5,45 +5,46 @@
 use SilverStripe\Control\Controller as BaseController;
 use SilverStripe\Control\Director;
 use SilverStripe\View\Requirements;
- 
-class GraphiQLController extends BaseController 
+
+class GraphiQLController extends BaseController
 {
-	/**
-	 * @var string
-	 */
-	protected $template = 'GraphiQL';
-
-	/**
-	 * Initialise the controller, sanity check, load javascript
-	 */
-	public function init()
-	{
-		parent::init();
-
-		if(!Director::isDev()) {
-			return $this->httpError(403, 'The GraphiQL tool is only available in dev mode');
-		}
-
-		$routes = Director::config()->get('rules');
-		$route = null;
-
-		foreach($routes as $pattern => $controllerInfo) {
-			if($controllerInfo == Controller::class || is_subclass_of($controllerInfo, Controller::class)) {
-				$route = $pattern;
-				break;
-			}
-		}
-
-		if(!$route) {
-			throw new \RuntimeException("There are no routes set up for a GraphQL server. You will need to add one to the SilverStripe\Control\Director.rules config setting.");
-		}
-
-		Requirements::customScript(
-<<<JS
+    /**
+     * @var string
+     */
+    protected $template = 'GraphiQL';
+
+    /**
+     * Initialise the controller, sanity check, load javascript
+     */
+    public function init()
+    {
+        parent::init();
+
+        if (!Director::isDev()) {
+            $this->httpError(403, 'The GraphiQL tool is only available in dev mode');
+            return;
+        }
+
+        $routes = Director::config()->get('rules');
+        $route = null;
+
+        foreach ($routes as $pattern => $controllerInfo) {
+            if ($controllerInfo == Controller::class || is_subclass_of($controllerInfo, Controller::class)) {
+                $route = $pattern;
+                break;
+            }
+        }
+
+        if (!$route) {
+            throw new \RuntimeException("There are no routes set up for a GraphQL server. You will need to add one to the SilverStripe\Control\Director.rules config setting.");
+        }
+
+        Requirements::customScript(
+            <<<JS
 var GRAPHQL_ROUTE = '{$route}';
 JS
-		);
+        );
 
-		Requirements::javascript(GRAPHQL_DIR.'/client/dist/graphiql.js');
-	}
-}
+        Requirements::javascript(GRAPHQL_DIR.'/client/dist/graphiql.js');
+    }
+}
diff --git a/src/InterfaceTypeCreator.php b/src/InterfaceTypeCreator.php
@@ -4,18 +4,17 @@
 
 use GraphQL\Type\Definition\InterfaceType as BaseInterfaceType;
 
-class InterfaceTypeCreator extends TypeCreator {
+class InterfaceTypeCreator extends TypeCreator
+{
 
     protected function getTypeResolver()
     {
-        if(!method_exists($this, 'resolveType'))
-        {
+        if (!method_exists($this, 'resolveType')) {
             return null;
         }
 
         $resolver = array($this, 'resolveType');
-        return function() use ($resolver)
-        {
+        return function () use ($resolver) {
             $args = func_get_args();
             return call_user_func_array($resolver, $args);
         };
@@ -31,8 +30,7 @@ public function getAttributes()
         $attributes = parent::getAttributes();
 
         $resolver = $this->getTypeResolver();
-        if(isset($resolver))
-        {
+        if (isset($resolver)) {
             $attributes['resolveType'] = $resolver;
         }
 
@@ -43,5 +41,4 @@ public function toType()
     {
         return new BaseInterfaceType($this->toArray());
     }
-
 }
diff --git a/src/Manager.php b/src/Manager.php
@@ -160,7 +160,7 @@ public function queryAndReturnResult($query, $params = [], $schema = null)
      */
     public function addType(Type $type, $name = '')
     {
-        if(!$name) {
+        if (!$name) {
             $name = (string)$type;
         }
 
@@ -174,7 +174,7 @@ public function addType(Type $type, $name = '')
      */
     public function getType($name)
     {
-        if(isset($this->types[$name])) {
+        if (isset($this->types[$name])) {
             return $this->types[$name];
         } else {
             throw new \InvalidArgumentException("Type '$name' is not a registered GraphQL type");

diff --git a/src/MutationCreator.php b/src/MutationCreator.php
@@ -7,7 +7,7 @@
  *
  * @todo Validation support
  */
-class MutationCreator extends FieldCreator
+abstract class MutationCreator extends FieldCreator
 {
 
 }
diff --git a/src/OperationResolver.php b/src/OperationResolver.php
@@ -0,0 +1,24 @@
+<?php
+
+namespace SilverStripe\GraphQL;
+
+use GraphQL\Type\Definition\ResolveInfo;
+use GraphQL\Executor\Executor;
+
+/**
+ * Standard resolve callback for Mutations or Queries
+ */
+interface OperationResolver
+{
+    /**
+     * Invoked by the Executor class to resolve this mutation / query
+     * @see Executor
+     *
+     * @param mixed $object
+     * @param array $args
+     * @param mixed $context
+     * @param ResolveInfo $info
+     * @return mixed
+     */
+    public function resolve($object, array $args, $context, ResolveInfo $info);
+}