galahad/graphoquent

Expose your eloquent models as GraphQL queries and mutations

dev-master 2017-08-18 03:31 UTC

This package is auto-updated.

Last update: 2021-03-29 00:23:34 UTC


README

Graphoquent is a Laravel packages that turns Eloquent models into queryable GraphQL objects.

Automatic Type Inference

By default, Graphoquent tries to infer your model's type from three places:

  1. The model's $casts array
  2. The model's $dates array
  3. The model's @property and @property-read DocBlock annotations

Given the following model:

/**
 * @property int $count
 */
class Foo extends Model
{
  use \Galahad\Graphoquent\Queryable;
  
  protected $casts = [
    'stars' => 'float',
  ];
  
  protected $dates = [
    'created_at',
  ];
}

Graphoquent will build the following GraphQL Type:

type Foo {
  count: Int
  stars: Float
  created_at: String
}

Authorization

Gates & Policies

Graphoquent uses Laravel Gates for default authorization:

  • expose: Can this user (or null if not logged in) use introspection to lear about this Type?

Custom

You may provide custom authorization for any Model by defining an authorizeGraphQL method on the model:

public function authorizeGraphQL($actor, $ability)
{
	if ('expose' === $ability) {
		return true;
	}
	
	return $actor && $actor->id === $this->owner_id;
}