\EncryptedEnum

Class EncryptedEnum

Synopsis

class EncryptedEnum extends Enum {

• // members
• public boolean $is_encrypted = true;
• protected AtRestCryptoService $service;
• // methods
• public void __construct()
• public void setValue()
• public void getDecryptedValue()
• public void getValue()
• public void requireField()
• public void prepValueForDB()
• public array enumValues()
• // Inherited methods from EncryptedFieldTrait
• public Key|null getEncryptionKey()
• public void setEncryptionKey()
}


Hierarchy

Extends

• Enum

Uses

• EncryptedFieldTrait

Members

protected

• $service — AtRestCryptoService

public

• $is_encrypted

Methods

public

• __construct()
• enumValues() — Returns the values of this enum as an array, suitable for insertion into a {@link DropdownField}
• getDecryptedValue()
• getValue()
• prepValueForDB()
• requireField()
• setValue()

Inherited from EncryptedFieldTrait

public

• getEncryptionKey() — Returns a custom key if one is explicitly set for this field. If a key is not set using setEncryptionKey(), returns null, which will trigger the AtRestCryptoService to use the default global key set in the ENCRYPT_AT_REST_KEY constant.
• setEncryptionKey() — Sets an encryption key that will override the default key defined in the ENCRYPT_AT_REST_KEY constant.