FEATURE: DataObject scaffolding

_config/config.yml

@@ -0,0 +1,26 @@
+---
+Name: graphqlconfig
+---
+SilverStripe\GraphQL\Scaffolding\Scaffolders\DataObjectScaffolder:
+  default_fields:
+    ID: ID
+
+## Map DB fields to GraphQL types
+SilverStripe\ORM\FieldType\DBField:
+  # fallback
+  graphql_type: 'String'
+
+SilverStripe\ORM\FieldType\DBInt:
+  graphql_type: 'Int'
+
+SilverStripe\ORM\FieldType\DBBoolean:
+  graphql_type: 'Boolean'
+
+SilverStripe\ORM\FieldType\DBFloat:
+  graphql_type: 'Float'
+
+SilverStripe\ORM\FieldType\DBPrimaryKey:
+  graphql_type: 'ID'
+
+SilverStripe\ORM\FieldType\DBForeignKey:
+  graphql_type: 'ID'

examples/_config/config.yml

@@ -10,5 +10,48 @@ SilverStripe\GraphQL:
       createMember: 'MyProject\GraphQL\CreateMemberMutationCreator'
   # Enforce HTTP basic authentication for GraphQL requests
   authenticators:
-    - class: SilverStripe\GraphQL\Auth\BasicAuthAuthenticator
-      priority: 10
+    class: SilverStripe\GraphQL\Auth\BasicAuthAuthenticator
+    priority: 10
+    scaffolding_providers:
+      - My\Project\Post
+    scaffolding:
+      types:
+        My\Project\Post:
+          fields: [ID, Title, Content, Author, Date]
+          nestedQueries:
+            Comments:
+              args:
+                Today: Boolean
+              sortableFields: [Author]
+              resolver: My\Project\CommentsResolver
+            Files: true
+          operations:
+            create: true
+            read:
+              args:
+                StartingWith: String
+              resolver: My\Project\ReadResolver
+        SilverStripe\Security\Member:
+          fields: [Name, FirstName, Surname, Email]
+        SilverStripe\Assets\File:
+          fieldsExcept: [Content]
+          fields: [File]
+        My\Project\Comment:
+          fields: [Comment, Author]
+        SilverStripe\CMS\Model\RedirectorPage:
+          fields: [ExternalURL, Content]
+          operations:
+            read: true
+            create: true
+      mutations:
+        updatePostTitle:
+          type: My\Project\Post
+          args:
+            ID: ID!
+            NewTitle: String!
+          resolver: My\Project\UpdatePostResolver
+      queries:
+        latestPost:
+          type: My\Project\Post
+          paginate: false
+          resolver: My\Project\LatestPostResolver

examples/code/Comment.php

@@ -0,0 +1,23 @@
+<?php
+
+namespace MyProject;
+
+use SilverStripe\ORM\DataObject;
+
+class Comment extends DataObject
+{
+	private static $db = [
+		'Comment' => 'Text',
+		'Author' => 'Varchar'
+	];
+
+	private static $has_one = [
+		'Post' => Post::class
+	];
+
+	public function canView($member = null, $context = []) { return true; }
+	public function canEdit($member = null, $context = []) { return true; }
+	public function canCreate($member = null, $context = []) { return true; }
+	public function canDelete($member = null, $context = []) { return true; }
+
+}

examples/code/CommentsResolver.php

@@ -0,0 +1,20 @@
+<?php
+
+namespace MyProject;
+
+use SilverStripe\GraphQL\Scaffolding\Interfaces\ResolverInterface;
+
+class CommentsResolver implements ResolverInterface
+{
+    public function resolve($object, $args, $context, $info)
+    {
+		$comments = $object->Comments();
+
+		if(isset($args['Today']) && $args['Today']) {
+			$comments = $comments->where('DATE(Created) = DATE(NOW())');
+		}
+
+		return $comments;
+    }
+
+}

examples/code/LatestPostResolver.php

@@ -0,0 +1,13 @@
+<?php
+
+namespace MyProject;
+
+use SilverStripe\GraphQL\Scaffolding\Interfaces\ResolverInterface;
+
+class LatestPostResolver implements ResolverInterface
+{
+    public function resolve($object, $args, $context, $info)
+    {
+        return Post::get()->sort('Date', 'DESC')->first();
+    }
+}

examples/code/PaginatedReadMembersQueryCreator.php

@@ -8,7 +8,7 @@
 
 class PaginatedReadMembersQueryCreator extends PaginatedQueryCreator
 {
-    public function connection()
+    public function createConnection()
     {
         return Connection::create('paginatedReadMembers')
             ->setConnectionType(function () {

examples/code/Post.php

@@ -0,0 +1,141 @@
+<?php
+
+namespace MyProject;
+
+use SilverStripe\ORM\DataObject;
+use SilverStripe\GraphQL\Scaffolding\Interfaces\ScaffoldingProvider;
+use SilverStripe\GraphQL\Scaffolding\Scaffolders\SchemaScaffolder;
+use SilverStripe\Security\Member;
+use SilverStripe\Assets\File;
+
+class Post extends DataObject implements ScaffoldingProvider
+{
+
+	private static $db = [
+		'Title' => 'Varchar',
+		'Content' => 'HTMLText',
+		'Date' => 'Datetime'
+	];
+
+	private static $has_one = [
+		'Author' => Member::class
+	];
+
+	private static $many_many = [
+		'Files' => File::class
+	];
+
+	private static $has_many = [
+		'Comments' => Comment::class
+	];
+
+	public function provideGraphQLScaffolding(SchemaScaffolder $scaffolder)
+	{
+		$scaffolder
+			->type(Post::class)
+			->addFields(['ID', 'Title', 'Content', 'Author', 'Date'])
+			// basic many_many nested query, no options
+			->nestedQuery('Files')
+			->end()
+			// more complex nested query
+			->nestedQuery('Comments')
+			->addArgs([
+				'Today' => 'Boolean'
+			])
+			->addSortableFields(['Author'])
+			->setResolver(function ($obj, $args, $context) {
+				$comments = $obj->Comments();
+				if (isset($args['Today']) && $args['Today']) {
+					$comments = $comments->where('DATE(Created) = DATE(NOW())');
+				}
+
+				return $comments;
+			})
+			->end()
+			// basic crud operation, no options
+			->operation(SchemaScaffolder::CREATE)
+			->end()
+			// complex crud operation, with custom args
+			->operation(SchemaScaffolder::READ)
+			->addArgs([
+				'StartingWith' => 'String'
+			])
+			->setResolver(function ($obj, $args) {
+				$list = Post::get();
+				if (isset($args['StartingWith'])) {
+					$list = $list->filter('Title:StartsWith', $args['StartingWith']);
+				}
+
+				return $list;
+			})
+			->end()
+			->end()
+			// these types were all created implicitly above. Add some fields to them.
+			->type(Member::class)
+			->addFields(['Name', 'FirstName', 'Surname', 'Email'])
+			->end()
+			->type(File::class)
+			->addAllFieldsExcept(['Content'])
+			->addFields(['File'])
+			->end()
+			->type(Comment::class)
+			->addFields(['Comment', 'Author'])
+			->end()
+			// Arbitrary mutation
+			->mutation('updatePostTitle', Post::class)
+			->addArgs([
+				'ID' => 'ID!',
+				'NewTitle' => 'String!'
+			])
+			->setResolver(function ($obj, $args) {
+				$post = Post::get()->byID($args['ID']);
+				if ($post->canEdit()) {
+					$post->Title = $args['NewTitle'];
+					$post->write();
+				}
+
+				return $post;
+			})
+			->end()
+			// Arbitrary query
+			->query('latestPost', Post::class)
+			->setUsePagination(false)
+			->setResolver(function ($obj, $args) {
+				return Post::get()->sort('Date', 'DESC')->first();
+			})
+			->end()
+			->type('SilverStripe\CMS\Model\RedirectorPage')
+			->addFields(['ExternalURL', 'Content'])
+			->operation(SchemaScaffolder::READ)
+			->end()
+			->operation(SchemaScaffolder::CREATE)
+			->end()
+			->end()
+			->type('Page')
+			->addFields(['BackwardsTitle'])
+			->end();
+
+
+		return $scaffolder;
+	}
+
+	public function canView($member = null, $context = [])
+	{
+		return true;
+	}
+
+	public function canEdit($member = null, $context = [])
+	{
+		return true;
+	}
+
+	public function canCreate($member = null, $context = [])
+	{
+		return true;
+	}
+
+	public function canDelete($member = null, $context = [])
+	{
+		return true;
+	}
+}

examples/code/ReadResolver.php

@@ -0,0 +1,20 @@
+<?php
+
+namespace MyProject;
+
+use SilverStripe\GraphQL\Scaffolding\Interfaces\ResolverInterface;
+
+class ReadResolver implements ResolverInterface
+{
+    public function resolve($object, $args, $context, $info)
+    {
+		$list = Post::get();
+
+		if(isset($args['Title'])) {
+			$list = $list->filter('Title:PartialMatch', $args['Title']);
+		}
+
+		return $list;
+    }
+
+}

examples/code/UpdatePostResolver.php

@@ -0,0 +1,21 @@
+<?php
+
+namespace MyProject;
+
+use SilverStripe\GraphQL\Scaffolding\Interfaces\ResolverInterface;
+
+class UpdatePostResolver implements ResolverInterface
+{
+    public function resolve($object, $args, $context, $info)
+    {
+		$post = Post::get()->byID($args['ID']);
+
+		if($post->canEdit()) {
+			$post->Title = $args['NewTitle'];
+			$post->write();
+		}
+
+		return $post;
+    }
+
+}

src/Controller.php

@@ -38,7 +38,7 @@ public function index(HTTPRequest $request)
         }
         $contentType = $request->getHeader('Content-Type') ?: $request->getHeader('content-type');
         $isJson = preg_match('#^application/json\b#', $contentType);
-        if ($isJson) {        	
+        if ($isJson) {
             $rawBody = $request->getBody();
             $data = json_decode($rawBody ?: '', true);
             $query = isset($data['query']) ? $data['query'] : null;