Remove Settings class in favor of Utils & Config.

Author: dadish

ProcessGraphQLConfig.php

@@ -1,8 +1,8 @@
 <?php namespace ProcessWire;
 
-use \ProcessWire\GraphQL\Type\InterfaceType\PageInterfaceType;
-use \ProcessWire\GraphQL\Type\InterfaceType\PageFileInterfaceType;
-use \ProcessWire\GraphQL\Settings;
+use ProcessWire\GraphQL\Type\InterfaceType\PageInterfaceType;
+use ProcessWire\GraphQL\Type\InterfaceType\PageFileInterfaceType;
+use ProcessWire\GraphQL\Utils;
 
 require_once $this->config->paths->site . 'modules/ProcessGraphQL/vendor/autoload.php';
 
@@ -37,7 +37,7 @@ public static function isLegalTemplateName($name)
 		if (preg_match('/^[_A-Za-z][-_0-9A-Za-z]*$/', $name) !== 1) return false; // the GraphQL naming requirement
 		if (strpos($name, '__') === 0) return false; // the names with `__` prefix are reserved by GraphQL
     if (strpos($name, '--') === 0) return false; // as we change the `-` symbols to `_` for field names the `--` becomes `__` and it also reserved by GraphQL
-		if (in_array($name, Settings::getReservedWords())) return false; // some words that used now and might be for future
+		if (in_array($name, Utils::getReservedWords())) return false; // some words that used now and might be for future
     return true;
 	}
 
@@ -127,4 +127,4 @@ public function getInputFields()
     return $inputfields;
   }
 
-}
+}

composer.json

@@ -2,6 +2,7 @@
     "name": "dadish/ProcessGraphql",
     "type": "processwire-plugin",
     "license": "MIT",
+    "description": "GraphQL for ProcessWire",
     "authors": [
         {
             "name": "Nurguly Ashyrov",

src/Config.php

@@ -0,0 +1,76 @@
+<?php
+
+namespace ProcessWire\GraphQL;
+
+use ProcessWire\WireData;
+use ProcessWire\ProcessGraphQL;
+
+class Config extends WireData {
+
+  protected $module;
+
+  public function __construct(ProcessGraphQL $module)
+  {
+    $this->module = $module;
+
+    // cache reference for useful ProcessWire API variables
+    $apiVars = [
+      'templates',
+      'fields',
+      'roles',
+      'users',
+      'pages',
+    ];
+    foreach ($apiVars as $varName) {
+      $this->$varName = \ProcessWire\wire($varName);
+    }
+
+    // Assign Config to module so we can access it easily accross the module codebase.
+    $module->Config = $this;
+  }
+
+  public function get($key)
+  {
+    switch ($key) {
+      case 'maxLimit':
+      case 'fullWidthGraphiQL':
+      case 'legalPageFields':
+      case 'legalPageFileFields':
+        return $this->module->$key;
+      case 'legalTemplates':
+        return $this->getLegalTemplates();
+      case 'legalFields':
+        return $this->getLegalFields();
+      default:
+        return parent::get($key);
+    }
+  }
+
+  protected function getLegalTemplates()
+  {
+    $legalTemplates = $this->module->legalTemplates;
+    $templates = \ProcessWire\wire('templates')->find("name=" . implode('|', $legalTemplates));
+    $user = \ProcessWire\wire('user');
+
+    // Wierd behavior with ProcessWire. $user->hasPermission() does not
+    // work if you do not load the required roles beforehand.
+    \ProcessWire\wire('roles')->find("");
+
+    foreach ($templates as $template) {
+      // We serve only those that user has permission to view
+      if (!$user->hasTemplatePermission('page-view', $template)) {
+        $templates->remove($template);
+      }
+    }
+
+    return $templates;
+  }
+
+  protected function getLegalFields()
+  {
+    $legalFields = $this->module->legalFields;
+    $fields = \ProcessWire\wire('fields')->find("name=" . implode('|', $legalFields));
+    return $fields;
+  }
+
+}

src/Schema.php

@@ -2,7 +2,7 @@
 
 use Youshido\GraphQL\Config\Schema\SchemaConfig;
 use Youshido\GraphQL\Schema\AbstractSchema;
-use ProcessWire\GraphQL\Settings;
+use ProcessWire\GraphQL\Utils;
 use ProcessWire\GraphQL\Field\Pages\PagesField;
 use ProcessWire\GraphQL\Field\TemplatedPageArray\TemplatedPageArrayField;
 use ProcessWire\GraphQL\Field\Debug\DbQueryCountField;
@@ -11,7 +11,6 @@
 use ProcessWire\GraphQL\Field\User\UserField;
 use ProcessWire\GraphQL\Field\Mutation\CreateTemplatedPage;
 
-
 class Schema extends AbstractSchema {
 
   protected $fields = [];
@@ -27,7 +26,7 @@ public function build(SchemaConfig $config)
     $query->addField(new PagesField());
 
     // $templates
-    foreach (Settings::getLegalTemplates() as $template) {
+    foreach (Utils::moduleConfig()->legalTemplates as $template) {
       $query->addField(new TemplatedPageArrayField($template));
     }
 
@@ -50,7 +49,7 @@ public function build(SchemaConfig $config)
     $mutation = $config->getMutation();
 
     // CreatePage
-    foreach (Settings::getLegalTemplates() as $template) {
+    foreach (Utils::moduleConfig()->legalTemplates as $template) {
       $mutation->addField(new CreateTemplatedPage($template));
     }
 

src/Settings.php

@@ -5,10 +5,10 @@
 use Youshido\GraphQL\Type\InterfaceType\AbstractInterfaceType;
 use Youshido\GraphQL\Type\Scalar\StringType;
 use Youshido\GraphQL\Type\Scalar\IntType;
+use ProcessWire\GraphQL\Utils;
 use ProcessWire\Pageimage;
 use ProcessWire\GraphQL\Type\Object\PageFileType;
 use ProcessWire\GraphQL\Type\Object\PageImageType;
-use ProcessWire\GraphQL\Settings;
 
 class PageFileInterfaceType extends AbstractInterfaceType {
 
@@ -25,7 +25,7 @@ public function getDescription()
   public function build($config)
   {
     $fields = self::getPageFileFields();
-    $legalPageFileFields = Settings::getLegalPageFileFields();
+    $legalPageFileFields = Utils::moduleConfig()->legalPageFileFields;
     foreach ($fields as $fieldName => $fieldConfig) {
       if (!in_array($fieldName, $legalPageFileFields)) continue;
       $config->addField($fieldName, $fieldConfig);

src/Type/InterfaceType/PageFileInterfaceType.php

@@ -3,9 +3,9 @@
 namespace ProcessWire\GraphQL\Type\InterfaceType;
 
 use Youshido\GraphQL\Type\InterfaceType\AbstractInterfaceType;
+use ProcessWire\GraphQL\Utils;
 use ProcessWire\Field;
 use ProcessWire\GraphQL\Type\Object\TemplatedPageType;
-use ProcessWire\GraphQL\Settings;
 
 class PageInterfaceType extends AbstractInterfaceType {
 
@@ -22,7 +22,7 @@ public function getDescription()
   public function build($config)
   {
     $fields = self::getPageFields();
-    $legalPageFields = Settings::getLegalPageFields();
+    $legalPageFields = Utils::moduleConfig()->legalPageFields;
 
     foreach ($fields as $fieldName => $fieldClassName) {
       if (!in_array($fieldName, $legalPageFields)) continue;
@@ -31,7 +31,7 @@ public function build($config)
     }
 
     // add global fields too
-    $legalFields = Settings::getLegalFields();
+    $legalFields = Utils::moduleConfig()->legalFields;
     foreach ($legalFields as $field) {
       if ($field->flags & Field::flagGlobal) {
         $className = "\\ProcessWire\\GraphQL\\Field\\Page\\Fieldtype\\" . $field->type->className();

src/Type/InterfaceType/PageInterfaceType.php

@@ -4,7 +4,7 @@
 
 use Youshido\GraphQL\Type\InterfaceType\AbstractInterfaceType;
 use Youshido\GraphQL\Type\Scalar\IntType;
-use ProcessWire\GraphQL\Settings;
+use ProcessWire\GraphQL\Utils;
 use ProcessWire\GraphQL\Type\Scalar\SelectorType;
 use ProcessWire\GraphQL\Type\Object\PageArrayType;
 use ProcessWire\GraphQL\Type\Object\TemplatedPageArrayType;
@@ -23,7 +23,7 @@ public function getDescription()
 
   public function build($config)
   {
-    $maxLimit = Settings::module()->maxLimit;
+    $maxLimit = Utils::moduleConfig()->maxLimit;
     $config->addFields([
 
       // \ProcessWire\PaginatedArray::getTotal()
@@ -68,7 +68,7 @@ public function resolveType($pageArray)
 
     // if there is only one template selected then we can assume it is a TemplatedPageArray
     if (count($templateSelector->values) === 1) {
-      $template = Settings::getLegalTemplates()->get($templateSelector->values[0]);
+      $template = Utils::moduleConfig()->legalTemplates->get($templateSelector->values[0]);
       return new TemplatedPageArrayType($template);
     }
     return new PageArrayType();

src/Type/InterfaceType/PaginatedArrayType.php

@@ -5,8 +5,8 @@
 use Youshido\GraphQL\Type\Object\AbstractObjectType;
 use ProcessWire\Template;
 use ProcessWire\Field;
+use ProcessWire\GraphQL\Utils;
 use ProcessWire\GraphQL\Type\InterfaceType\PageInterfaceType;
-use ProcessWire\GraphQL\Settings;
 
 class TemplatedPageType extends AbstractObjectType {
 
@@ -37,7 +37,7 @@ public function getDescription()
 
   public function build($config)
   {
-    $legalFields = Settings::getLegalFields();
+    $legalFields = Utils::moduleConfig()->legalFields;
     $config->applyInterface(new PageInterfaceType());
     foreach ($this->template->fields as $field) {
       if (!$legalFields->has($field)) continue;

src/Type/Object/TemplatedPageType.php

@@ -7,7 +7,7 @@
 use ProcessWire\Selectors;
 use ProcessWire\Selector;
 use ProcessWire\SelectorEqual;
-use ProcessWire\GraphQL\Settings;
+use ProcessWire\GraphQL\Utils;
 
 class SelectorType extends StringType {
 
@@ -29,7 +29,7 @@ public function serialize($selectors)
     $selectors = new Selectors($selectors);
 
     // make sure the limit field is not greater than max allowed
-    $maxLimit = Settings::module()->maxLimit;
+    $maxLimit = Utils::moduleConfig()->maxLimit;
     $limitSelector = self::findSelectorByField($selectors, 'limit');
     if ($limitSelector) {
       if ($maxLimit < $limitSelector->value) $limitSelector->set('value', $maxLimit);
@@ -40,7 +40,7 @@ public function serialize($selectors)
 
     // make sure to limit the search to legal templates only
     $templateSelector = self::findSelectorByField($selectors, 'template');
-    $legalTemplates = Settings::getLegalTemplates();
+    $legalTemplates = Utils::moduleConfig()->legalTemplates;
     $names = [];
 
     if ($templateSelector instanceof Selector) {