EncryptedDBJson::scalarValueOnly() - Code Metrics - Inspection of "finalize json support" - lekoala/silverstripe-encrypt - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 618096...f2b69a )

by Thomas

created 2022-10-25 07:42 UTC

EncryptedDBJson::scalarValueOnly() A

↳ Parent: EncryptedDBJson

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	1

Metric	Value
eloc	1
c	1
b	0
f	1
dl	0
loc	3
rs	10
cc	1
nc	1
nop	0

<?php

namespace LeKoala\Encrypt;

use SilverStripe\Forms\HiddenField;
use ParagonIE\CipherSweet\JsonFieldMap;
use ParagonIE\CipherSweet\EncryptedJsonField;

/**
 * A simple extension over EncryptedDBText that supports json
 * as a datastructure
 * The data is stored in a text field
 *
 * If you want to access array stuff, you need to use
 * $model->dbObject('myField')->toArray() or any other method
 *
 * This field is a great way to store serialized encrypted data
 */
class EncryptedDBJson extends EncryptedDBText
{

    /**
     * @return string
     */
    public function getJsonMap()
    {
        if (array_key_exists('map', $this->options)) {
            return $this->options['map'];
        }
        return null;
    }

    /**
     * We cannot search on json fields
     *
     * @param string $title
     * @return HiddenField
     */
    public function scaffoldSearchField($title = null)
    {
        return HiddenField::create($this->getName());
    }

    /**
     * Json data is not easily displayed
     *
     * @param string $title
     * @param string $params
     * @return HiddenField
     */
    public function scaffoldFormField($title = null, $params = null)
    {
        return HiddenField::create($this->getName());
    }

    /**
     * @return mixed
     */
    public function decode()
    {
        if (!$this->value) {
            return false;
        }
        return json_decode($this->value);
    }

    /**
     * @return array
     */
    public function decodeArray()
    {
        if (!$this->value) {
            return [];
        }
        return json_decode($this->value, JSON_OBJECT_AS_ARRAY);
        return json_decode($this->value, /** @scrutinizer ignore-type */ JSON_OBJECT_AS_ARRAY);
    }

    /**
     * @return array
     */
    public function toArray()
    {
        return $this->decodeArray();
    }

    /**
     * @return string
     */
    public function pretty()
    {
        return json_encode(json_decode($this->value), JSON_PRETTY_PRINT);
    }

    /**
     * @inheritDoc
     */
    public function saveInto($dataObject)
    {
        if ($this->value && is_array($this->value)) {
            $this->value = json_encode($this->value);
        }
        parent::saveInto($dataObject);
    }

    /**
     * Add a value
     *
     * @link https://stackoverflow.com/questions/7851590/array-set-value-using-dot-notation
     * @param string|array $key
     * @param string $value
     * @return $this
     */
    public function addValue($key, $value)
    {
        $currentValue = $this->decodeArray();

        if (!is_array($key)) {
            $key = [$key];
        }
        $arr = &$currentValue;
        foreach ($key as $idx) {
            if (!isset($arr[$idx])) {
                $arr[$idx] = [];
            }
            $arr = &$arr[$idx];
        }
        $arr = $value;
        return $this->setValue($currentValue);
    }

    /**
     * Internally, the value is always a json string
     *
     * @param mixed $value
     * @param DataObject $record
filter:
    dependency_paths: ["lib/*"]
     * @param boolean $markChanged
     * @return $this
     */
    public function setValue($value, $record = null, $markChanged = true)
    {
        $this->setEncryptionAad($record);

        // Not supported, we need decrypted values for methods to work properly
        // Return early if we keep encrypted value in memory
        // if (!EncryptHelper::getAutomaticDecryption()) {
        //     $this->value = $value;
        //     return $this;
        // }

        // Decrypt first if needed
        if ($this->getJsonMap() && $value && is_string($value)) {
            if (EncryptHelper::isJsonEncrypted($value)) {
                $aad = $this->encryptionAad;
                $value = json_encode($this->getEncryptedJsonField()->decryptJson($value, $aad));
            }
        }
        // Internally, we use a string
        if (is_array($value)) {
            $value = json_encode($value);
        }

        return parent::setValue($value, $record, $markChanged);
    }

    /**
     * @inheritDoc
     */
    public function prepValueForDB($value)
    {
        // We need an array to encrypt
        if ($this->getJsonMap() && $value && is_string($value)) {
            $value = $this->toArray();
        }
        if (is_array($value)) {
            if ($this->getJsonMap()) {
                $aad = $this->encryptionAad;
                $value = $this->getEncryptedJsonField()->encryptJson($value, $aad);
                return $value; // return early
            } else {
                $value = json_encode($value);
            }
        }
        return parent::prepValueForDB($value);
    }

    /**
     * We return false because we can accept array and convert it to string
     * @return boolean
     */
    public function scalarValueOnly()
    {
        return false;
    }

    /**
     * @param CipherSweet $engine
filter:
    dependency_paths: ["lib/*"]
     * @param JsonFieldMap $map
     * @return EncryptedJsonField
     */
    public function getEncryptedJsonField($engine = null, $map = null)
    {
        if ($engine === null) {
            $engine = EncryptHelper::getCipherSweet();
        }
        if ($map === null) {
            $mapString = $this->getJsonMap();
            $map = JsonFieldMap::fromString($mapString);
        }
        $encryptedField = EncryptedJsonField::create($engine, $map, $this->tableName, $this->name);
        return $encryptedField;
    }
}


lekoala / silverstripe-encrypt

Push — master ( 618096...f2b69a )

EncryptedDBJson::scalarValueOnly() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like