Merge pull request #17 from backdrop-contrib/16/backdropcoder

Author: serundeputy

.gitignore

@@ -0,0 +1,2 @@
+# Ignore vendor
+vendor

.travis.yml

@@ -0,0 +1,21 @@
+language: php
+dist: xenial
+php:
+  - 7.2
+cache:
+  directories:
+    - $HOME/.composer/cache/files
+    - $HOME/.composer/cache/repo
+services:
+  - mysql
+addons:
+  - mariadb: '10.0'
+before_install:
+  - composer install
+
+script:
+  # Check code standards
+  - vendor/bin/phpcs -n --standard=vendor/backdrop/coder/coder_sniffer/Backdrop --ignore="vendor/*,README.md" --extensions=install,module,php,inc,theme .
+
+  # Unit tests
+

composer.json

@@ -0,0 +1,5 @@
+{
+    "require-dev": {
+        "backdrop/coder": "^1.0"
+    }
+}

headless.install

@@ -5,8 +5,10 @@
  * Remove config after uninstalling headless.
  */
 
+/**
+ * Implements hook_uninstall().
+ */
 function headless_uninstall() {
   $config = config('headless.settings');
   $config->delete();
 }
-

headless.module

@@ -1,7 +1,12 @@
 <?php
 /**
+ * @file
  * Headless allows you to use Backdrop CMS as an API.
  */
+
+/**
+ * Implements hook_menu().
+ */
 function headless_menu() {
   $items = array();
   // Return JSON for individual nodes.
@@ -88,7 +93,7 @@ function headless_term_item($vocab, $tid) {
 
 /**
  * Page callback for views.
- * 
+ *
  * This is to make it backwards compatible
  */
 function headless_views($view) {
@@ -148,16 +153,18 @@ function headless_paragraphs_item($type, $entity_id) {
 }
 
 /**
- * Helper function
+ * Helper function to add pager data to /api/v2/views/%/% endpoints.
  *
- * We mimic the core function to add some extra pager data to the 
+ * We mimic the core function to add some extra pager data to the
  * returned value.
  */
 function _views_get_view_result($name, $display_id = NULL) {
   $args = func_get_args();
-  array_shift($args); // remove $name
+  // Remove $name.
+  array_shift($args);
   if (count($args)) {
-    array_shift($args); // remove $display_id
+    // Remove $display_id.
+    array_shift($args);
   }
 
   $view = views_get_view($name);

includes/headless.admin.inc

@@ -8,32 +8,34 @@
  * Headless configuration form.
  */
 function headless_settings_form($form, &$form_state) {
+  $help = '
+    <div class="headless-settings__help">
+      Use this form to select wich entities you would like to expose as json endpoints.
+    </div>
+  ';
   $form['help'] = array(
-    '#markup' => '<div class="headless-settings__help">
-      Use this form to select wich entities you would like to expose
-      as json endpoints.
-    </div>',
+    '#markup' => $help,
   );
   $form['nodes'] = array(
     '#type' => 'fieldset',
     '#title' => 'Node Types',
     '#collapsible' => TRUE,
   );
   // Get the node types.
-  $nodeTypes = node_type_get_types();
-  $nodeTypeOptions = [];
-  foreach($nodeTypes as $key => $type) {
-    $nodeTypeOptions[$key] = $key;
+  $node_types = node_type_get_types();
+  $node_type_options = [];
+  foreach ($node_types as $key => $type) {
+    $node_type_options[$key] = $key;
   }
   $form['nodes']['node-checkboxes'] = array(
     '#type' => 'checkboxes',
-    '#options' => $nodeTypeOptions,
+    '#options' => $node_type_options,
     '#default_value' => _headless_get_default_options('node'),
   );
-  $vocabularyTypes = taxonomy_get_vocabularies();
-  $vocabularyTypeOptions = [];
-  foreach($vocabularyTypes as $key => $type) {
-    $vocabularyTypeOptions[$key] = $key;
+  $vocabulary_types = taxonomy_get_vocabularies();
+  $vocabulary_type_options = [];
+  foreach ($vocabulary_types as $key => $type) {
+    $vocabulary_type_options[$key] = $key;
   }
   $form['vocabularies'] = array(
     '#type' => 'fieldset',
@@ -43,7 +45,7 @@ function headless_settings_form($form, &$form_state) {
   );
   $form['vocabularies']['vocabularies-checkboxes'] = array(
     '#type' => 'checkboxes',
-    '#options' => $vocabularyTypeOptions,
+    '#options' => $vocabulary_type_options,
     '#default_value' => _headless_get_default_options('vocabularies'),
   );
   $form['views'] = array(
@@ -52,17 +54,17 @@ function headless_settings_form($form, &$form_state) {
     '#collapsible' => TRUE,
     '#collapsed' => TRUE,
   );
-  $myViews = views_get_views_as_options(TRUE, 'enabled', NULL, TRUE, TRUE);
+  $my_views = views_get_views_as_options(TRUE, 'enabled', NULL, TRUE, TRUE);
   $form['views']['views-checkboxes'] = array(
     '#type' => 'checkboxes',
-    '#options' => $myViews,
+    '#options' => $my_views,
     '#default_value' => _headless_get_default_options('views'),
   );
   if (module_exists('paragraphs')) {
-    $paragraphsTypes = paragraphs_bundle_load();
-    $paragraphsTypeOptions = [];
-    foreach($paragraphsTypes as $key => $type) {
-      $paragraphsTypeOptions[$key] = $key;
+    $paragraphs_types = paragraphs_bundle_load();
+    $paragraphs_type_options = [];
+    foreach ($paragraphs_types as $key => $type) {
+      $paragraphs_type_options[$key] = $key;
     }
     $form['paragraphs'] = array(
       '#type' => 'fieldset',
@@ -72,7 +74,7 @@ function headless_settings_form($form, &$form_state) {
     );
     $form['paragraphs']['paragraphs-checkboxes'] = array(
       '#type' => 'checkboxes',
-      '#options' => $paragraphsTypeOptions,
+      '#options' => $paragraphs_type_options,
       '#default_value' => _headless_get_default_options('paragraphs'),
     );
   }
@@ -92,7 +94,7 @@ function headless_settings_form($form, &$form_state) {
 function headless_settings_form_submit($form, &$form_state) {
   // Remove unnecessary values.
   form_state_values_clean($form_state);
-  foreach($form_state['input']['node-checkboxes'] as $type => $value) {
+  foreach ($form_state['input']['node-checkboxes'] as $type => $value) {
     if ($value != NULL) {
       $val = 1;
     }
@@ -101,7 +103,7 @@ function headless_settings_form_submit($form, &$form_state) {
     }
     config_set('headless.settings', 'node.' . $type, $val);
   }
-  foreach($form_state['input']['vocabularies-checkboxes'] as $type => $value) {
+  foreach ($form_state['input']['vocabularies-checkboxes'] as $type => $value) {
     if ($value != NULL) {
       $val = 1;
     }
@@ -110,7 +112,7 @@ function headless_settings_form_submit($form, &$form_state) {
     }
     config_set('headless.settings', 'vocabularies.' . $type, $val);
   }
-  foreach($form_state['input']['views-checkboxes'] as $type => $value) {
+  foreach ($form_state['input']['views-checkboxes'] as $type => $value) {
     if ($value != NULL) {
       $val = 1;
     }
@@ -120,7 +122,7 @@ function headless_settings_form_submit($form, &$form_state) {
     config_set('headless.settings', 'views.' . $type, $val);
   }
   if (isset($form_state['input']['views-checkboxes'])) {
-    foreach($form_state['input']['views-checkboxes'] as $type => $value) {
+    foreach ($form_state['input']['views-checkboxes'] as $type => $value) {
       if ($value != NULL) {
         $val = 1;
       }
@@ -131,7 +133,7 @@ function headless_settings_form_submit($form, &$form_state) {
     }
   }
   if (isset($form_state['input']['paragraphs-checkboxes'])) {
-    foreach($form_state['input']['paragraphs-checkboxes'] as $type => $value) {
+    foreach ($form_state['input']['paragraphs-checkboxes'] as $type => $value) {
       if ($value != NULL) {
         $val = 1;
       }
@@ -164,7 +166,7 @@ function _headless_get_default_options($types) {
   $types = config_get('headless.settings', $types);
 
   if (isset($types)) {
-    foreach($types as $key => $type) {
+    foreach ($types as $key => $type) {
       if ($type != 0) {
         $checked[] = $key;
       }

includes/headless.router.inc

@@ -1,7 +1,8 @@
 <?php
 /**
+ * @file
  * Router: allow API queries via strings in URL path.
- *  The router will try to resolve a string to an API asset.
+ * The router will try to resolve a string to an API asset.
  */
 
 /**
@@ -18,7 +19,7 @@ function headless_router(string $path) {
     ->condition('alias', '%' . db_like($path) . '%', 'LIKE')
     ->addTag('node_access')
     ->execute();
-  foreach($query as $i => $asset) {
+  foreach ($query as $i => $asset) {
     $assets[] = $asset;
   }
   $source = $assets[0]->source;