lekoala / silverstripe-encrypt

tests/Test_EncryptedModel.php

<?php

namespace LeKoala\Encrypt\Test;

use SilverStripe\Assets\File;
use SilverStripe\Dev\TestOnly;
use SilverStripe\ORM\DataObject;
use SilverStripe\Security\Member;
use LeKoala\Encrypt\EncryptedFile;
use LeKoala\Encrypt\EncryptedDBJson;
use LeKoala\Encrypt\EncryptedDBText;
use LeKoala\Encrypt\EncryptedDBField;
use LeKoala\Encrypt\EncryptedDBVarchar;
use LeKoala\Encrypt\HasEncryptedFields;
use ParagonIE\CipherSweet\JsonFieldMap;
use LeKoala\Encrypt\EncryptedDBHTMLText;
use LeKoala\Encrypt\EncryptedNumberField;
use LeKoala\Encrypt\EncryptHelper;

/**
 * A test model for our encryption
 *
 * @property string $Name
 * @property string $MyText
 * @property string $MyHTMLText
 * @property string $MyVarchar
 * @property string $MyNumber
 * @property string $MyVarcharWithIndex
 * @property string $MyJson
 * @property string $MyEncryptedJson
 * @property int $RegularFileID
 * @property int $EncryptedFileID
 */
class Test_EncryptedModel extends DataObject implements TestOnly
{
    use HasEncryptedFields;

    /**
     * @var string
     */
    private static $table_name = 'EncryptedModel';

The private property $table_name is not used, and could be removed.

    /**
     * @var array<string,string>
     */
    private static $db = [

The private property $db is not used, and could be removed.

        "Name" => 'Varchar',
        "MyText" => EncryptedDBText::class,
        "MyHTMLText" => EncryptedDBHTMLText::class,
        "MyVarchar" => EncryptedDBVarchar::class,
        "MyNumber" => EncryptedNumberField::class . '(["output_size" => 4, "domain_size" => 10])',
        "MyIndexedVarchar" => EncryptedDBField::class,
        "MyNullIndexedVarchar" => EncryptedDBField::class,
        "MyJson" => EncryptedDBJson::class,
        "MyEncryptedJson" => EncryptedDBJson::class . "(['map' => '7551830f{\"fields\":{\"$6e616d65\":\"string\",\"$616374697665\":\"bool\",\"$616765\":\"int\"}}'])", // phpcs:ignore
    ];

    /**
     * @var array<string,string>
     */
    private static $has_one = [

The private property $has_one is not used, and could be removed.

        "RegularFile" => File::class,
        // We use regular File class for encrypted files to keep only one table
        "EncryptedFile" => File::class,
        "EncryptedFileClass" => EncryptedFile::class,
        "Member" => Member::class,
    ];

    /**
     * @var array<string,mixed>
     */
    private static $indexes = [

The private property $indexes is not used, and could be removed.

        'MyIndexedVarcharBlindIndex' => true,
        'MyNumberBlindIndex' => true,
        'MyNumberLastFourBlindIndex' => true,
    ];

    /**
     * @param string $baseTable
     * @param string $now
     * @return void
     */
    protected function writeBaseRecord($baseTable, $now)
    {
        parent::writeBaseRecord($baseTable, $now);
        // After base record is written, we have an ID and therefore AAD has changed
        $this->resetFieldValues();
    }

    public function getField(string $field): mixed
    {
        return $this->getEncryptedField($field);
    }

    public function setField(string $fieldName, mixed $value): static
    {
        return $this->setEncryptedField($fieldName, $value);
    }
}