JSONTextExtension::__construct() - Code Metrics - Inspection of "Merge pull request #17 from jakxnz/minor/jsontexte..." - phptek/silverstripe-jsontext - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 6d49c7...27089c )

by Russell

created 2018-04-30 18:14 UTC

JSONTextExtension::__construct() A

↳ Parent: JSONTextExtension

Complexity

Conditions	3
Paths	2

Size

Total Lines	10
Code Lines	5

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	10
rs	9.4285
c	0
b	0
f	0
cc	3
eloc	5
nc	2
nop	0

<?php

/**
 * This {@link DataExtension} allows you to declare arbitrary input fields in
 * your getCMSFields() methods without them ever going near an equivalent DBField.
 *
 * The SilverStripe default gives you one DBField for every input field declared
 * in getCMSFields(). This extension however allows you to use a single blob
 * of JSON, stored in a single {@link JSONTextField} and manage each key=>value pair
 * from individual form input fields, without needing to declare equivalent or further
 * database fields. All you need to do is add a `$json_field_map` config static to
 * your model (See below).
 *
 * Notes:
 * - Untested on non CHAR DB field-types (v0.8)
 * - Only works for single dimensional JSON data
 *
 * <code>
 * private static $db = [
 *      'TestJSON' => JSONText::class,
 * ];
 *
 * private static $json_field_map = [
 *      'TestJSON' => ['TestField1', 'TestField2']
 * ];
 *
 * public function getCMSFields()
 * {
 *      $fields = parent::getCMSFields();
 *      $fields->addFieldsToTab('Root.Main', [
 *          TextField::create('TestField1', 'Test 1'),
 *          TextField::create('TestField2', 'Test 2'),
 *          TextField::create('TestJSON', 'Some JSON') // Uses a TextField for demo, normally this would be hidden from CMS users
 *      ]);
 *
 *      return $fields;
 * }
 * </code>
 *
 * @package jsontext
 * @subpackage control
 * @author Russell Michell <[email protected]>
 */

namespace PhpTek\JSONText\Extension;

use PhpTek\JSONText\Exception\JSONTextException;
use PhpTek\JSONText\ORM\FieldType\JSONText;
use SilverStripe\CMS\Controllers\CMSPageEditController;
use SilverStripe\Control\Controller;
use SilverStripe\Control\Director;
use SilverStripe\ORM\DataExtension;

class JSONTextExtension extends DataExtension
{

    public function __construct()
    {
        // Helpful class applicability message
        if (!Director::is_cli() && !class_exists(CMSPageEditController::class)) {
            $msg = 'Please install the silverstripe/cms package in order to use this extension.';
            throw new JSONTextException($msg);
        }

        return parent::__construct();

    }

    /**
     * Pre-process incoming CMS POST data, and modify any available {@link JSONText}
     * data for presentation in "headless" input fields.
     *
     * @return null
     */
    public function onBeforeWrite()
    {
        parent::onBeforeWrite();

        $owner = $this->getOwner();
        $controller = Controller::curr();
        $postVars = $controller->getRequest()->postVars();
        $fieldMap = $owner->config()->get('json_field_map');
        $doUpdate = (
            count($postVars) &&
            !empty($fieldMap) &&
            in_array(get_class($controller), [CMSPageEditController::class])
        );

        if (!$doUpdate) {
            return null;
        }

        // Could also use DataObject::getSchema()->fieldSpecs()

        foreach ($owner->config()->get('db') as $field => $type) {
            if ($type === JSONText::class) {
                $this->updateJSON($postVars, $owner);
            }
        }
    }

    /**
     * Called from {@link $this->onBeforeWrote()}. Inserts or updates each available
     * JSONText DB field with the appropriate input-field data, as per the model's
     * "json_field_map" config static.
     *
     * @param  array $postVars
     * @param  DataObject $owner
     * @return void
     * @throws JSONTextException
     */
    public function updateJSON(array $postVars, $owner)
    {
        $jsonFieldMap = $owner->config()->get('json_field_map');

        foreach ($jsonFieldMap as $jsonField => $mappedFields) {
            $jsonFieldData = [];

            foreach ($mappedFields as $fieldName) {
                if (!isset($postVars[$fieldName])) {
                    $msg = sprintf('%s doesn\'t exist in POST data.', $fieldName);
                    throw new JSONTextException($msg);
                }

                $jsonFieldData[$fieldName] = $postVars[$fieldName];
            }

            $fieldValue = singleton(JSONText::class)->toJson($jsonFieldData);
            $owner->setField($jsonField, $fieldValue);
        }
    }

    /**
     * The CMS input fields declared in the json_field_map static, are not DB-backed,
     * by virtue of this extension, they are backed by specific values represented
     * in the relevant JSON data. Therefore we need to pre-populate each such field's
     * value.
     *
     * @param  FieldList $fields
     * @return void
     */
    public function updateCMSFields(\SilverStripe\Forms\FieldList $fields)
    {
        $owner = $this->getOwner();
        $jsonFieldMap = $owner->config()->get('json_field_map');

        if (empty($jsonFieldMap)) {
            return;
        }

        foreach ($jsonFieldMap as $jsonField => $mappedFields) {
            if (!$owner->getField($jsonField)) {
                continue;
            }

            $jsonFieldObj = $owner->dbObject($jsonField);

            foreach ($mappedFields as $fieldName) {
                if (!$fieldValue = $jsonFieldObj->query('->>', $fieldName)) {
                    continue;
                }

                if ($fieldValue = array_values($jsonFieldObj->toArray($fieldValue))) {
                    $fieldValue = $fieldValue[0];
                    $owner->setField($fieldName, $fieldValue);
                }
            }
        }
    }
}


1			<?php
2
3			/**
4			* This {@link DataExtension} allows you to declare arbitrary input fields in
5			* your getCMSFields() methods without them ever going near an equivalent DBField.
6			*
7			* The SilverStripe default gives you one DBField for every input field declared
8			* in getCMSFields(). This extension however allows you to use a single blob
9			* of JSON, stored in a single {@link JSONTextField} and manage each key=>value pair
10			* from individual form input fields, without needing to declare equivalent or further
11			* database fields. All you need to do is add a `$json_field_map` config static to
12			* your model (See below).
13			*
14			* Notes:
15			* - Untested on non CHAR DB field-types (v0.8)
16			* - Only works for single dimensional JSON data
17			*
18			* <code>
19			* private static $db = [
20			* 'TestJSON' => JSONText::class,
21			* ];
22			*
23			* private static $json_field_map = [
24			* 'TestJSON' => ['TestField1', 'TestField2']
25			* ];
26			*
27			* public function getCMSFields()
28			* {
29			* $fields = parent::getCMSFields();
30			* $fields->addFieldsToTab('Root.Main', [
31			* TextField::create('TestField1', 'Test 1'),
32			* TextField::create('TestField2', 'Test 2'),
33			* TextField::create('TestJSON', 'Some JSON') // Uses a TextField for demo, normally this would be hidden from CMS users
34			* ]);
35			*
36			* return $fields;
37			* }
38			* </code>
39			*
40			* @package jsontext
41			* @subpackage control
42			* @author Russell Michell <[email protected]>
43			*/
44
45			namespace PhpTek\JSONText\Extension;
46
47			use PhpTek\JSONText\Exception\JSONTextException;
48			use PhpTek\JSONText\ORM\FieldType\JSONText;
49			use SilverStripe\CMS\Controllers\CMSPageEditController;
50			use SilverStripe\Control\Controller;
51			use SilverStripe\Control\Director;
52			use SilverStripe\ORM\DataExtension;
53
54			class JSONTextExtension extends DataExtension
55			{
56
57			public function __construct()
58			{
59			// Helpful class applicability message
60			if (!Director::is_cli() && !class_exists(CMSPageEditController::class)) {
61			$msg = 'Please install the silverstripe/cms package in order to use this extension.';
62			throw new JSONTextException($msg);
63			}
64
65			return parent::__construct();
			0 ignored issues – show Bug introduced 2018-04-30 04:41 UTC by Report Bug Copy Issue Report Constructors do not have meaningful return values, anything that is returned from here is discarded. Are you sure this is correct? Loading history...
66			}
67
68			/**
69			* Pre-process incoming CMS POST data, and modify any available {@link JSONText}
70			* data for presentation in "headless" input fields.
71			*
72			* @return null
73			*/
74			public function onBeforeWrite()
75			{
76			parent::onBeforeWrite();
77
78			$owner = $this->getOwner();
79			$controller = Controller::curr();
80			$postVars = $controller->getRequest()->postVars();
81			$fieldMap = $owner->config()->get('json_field_map');
82			$doUpdate = (
83			count($postVars) &&
84			!empty($fieldMap) &&
85			in_array(get_class($controller), [CMSPageEditController::class])
86			);
87
88			if (!$doUpdate) {
89			return null;
90			}
91
92			// Could also use DataObject::getSchema()->fieldSpecs()
			0 ignored issues – show Unused Code Comprehensibility introduced 2018-04-10 00:05 UTC by Report Bug Copy Issue Report `44%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
93			foreach ($owner->config()->get('db') as $field => $type) {
94			if ($type === JSONText::class) {
95			$this->updateJSON($postVars, $owner);
96			}
97			}
98			}
99
100			/**
101			* Called from {@link $this->onBeforeWrote()}. Inserts or updates each available
102			* JSONText DB field with the appropriate input-field data, as per the model's
103			* "json_field_map" config static.
104			*
105			* @param array $postVars
106			* @param DataObject $owner
107			* @return void
108			* @throws JSONTextException
109			*/
110			public function updateJSON(array $postVars, $owner)
111			{
112			$jsonFieldMap = $owner->config()->get('json_field_map');
113
114			foreach ($jsonFieldMap as $jsonField => $mappedFields) {
115			$jsonFieldData = [];
116
117			foreach ($mappedFields as $fieldName) {
118			if (!isset($postVars[$fieldName])) {
119			$msg = sprintf('%s doesn\'t exist in POST data.', $fieldName);
120			throw new JSONTextException($msg);
121			}
122
123			$jsonFieldData[$fieldName] = $postVars[$fieldName];
124			}
125
126			$fieldValue = singleton(JSONText::class)->toJson($jsonFieldData);
127			$owner->setField($jsonField, $fieldValue);
128			}
129			}
130
131			/**
132			* The CMS input fields declared in the json_field_map static, are not DB-backed,
133			* by virtue of this extension, they are backed by specific values represented
134			* in the relevant JSON data. Therefore we need to pre-populate each such field's
135			* value.
136			*
137			* @param FieldList $fields
138			* @return void
139			*/
140			public function updateCMSFields(\SilverStripe\Forms\FieldList $fields)
141			{
142			$owner = $this->getOwner();
143			$jsonFieldMap = $owner->config()->get('json_field_map');
144
145			if (empty($jsonFieldMap)) {
146			return;
147			}
148
149			foreach ($jsonFieldMap as $jsonField => $mappedFields) {
150			if (!$owner->getField($jsonField)) {
151			continue;
152			}
153
154			$jsonFieldObj = $owner->dbObject($jsonField);
155
156			foreach ($mappedFields as $fieldName) {
157			if (!$fieldValue = $jsonFieldObj->query('->>', $fieldName)) {
158			continue;
159			}
160
161			if ($fieldValue = array_values($jsonFieldObj->toArray($fieldValue))) {
162			$fieldValue = $fieldValue[0];
163			$owner->setField($fieldName, $fieldValue);
164			}
165			}
166			}
167			}
168			}
169

phptek / silverstripe-jsontext

Push — master ( 6d49c7...27089c )

JSONTextExtension::__construct() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like