Diviner Tech Docs PhabricatorFileROT13StorageFormat

final class PhabricatorFileROT13StorageFormat
Phorge Technical Documentation (Files)

Trivial example of a file storage format for at-rest encryption.

This format applies ROT13 encoding to file data as it is stored and reverses it on the way out. This encoding is trivially reversible. This format is for testing, developing, and understanding encoding formats and is not intended for production use.

Methods

public function __get($name)
Inherited

This method is not documented.

Parameters

$name

Return

wild

public function __set($name, $value)
Inherited

This method is not documented.

Parameters

	$name
	$value

Return

wild

public function current()
Inherited

This method is not documented.

Return

wild

public function key()
Inherited

This method is not documented.

Return

wild

public function next()
Inherited

This method is not documented.

Return

wild

public function rewind()
Inherited

This method is not documented.

Return

wild

public function valid()
Inherited

This method is not documented.

Return

wild

private function throwOnAttemptedIteration()
Inherited

This method is not documented.

Return

wild

public function getPhobjectClassConstant($key, $byte_limit)
Inherited

Phobject

Read the value of a class constant.

This is the same as just typing self::CONSTANTNAME, but throws a more useful message if the constant is not defined and allows the constant to be limited to a maximum length.

Parameters

string	$key	Name of the constant.
int\|null	$byte_limit	Maximum number of bytes permitted in the value.

Return

string

Value of the constant.

final public function setFile($file)
Inherited

This method is not documented.

Parameters

PhabricatorFile

$file

Return

wild

final public function getFile()
Inherited

This method is not documented.

Return

wild

public function getStorageFormatName()

This method is not documented.

Return

wild

public function newReadIterator($raw_iterator)

This method is not documented.

Parameters

$raw_iterator

Return

wild

public function newWriteIterator($raw_iterator)

This method is not documented.

Parameters

$raw_iterator

Return

wild

public function newFormatIntegrityHash()
Inherited

This method is not documented.

Return

wild

public function newStorageProperties()

This method is not documented.

Return

wild

public function canGenerateNewKeyMaterial()
Inherited

This method is not documented.

Return

wild

public function generateNewKeyMaterial()
Inherited

This method is not documented.

Return

wild

public function canCycleMasterKey()
Inherited

This method is not documented.

Return

wild

public function cycleStorageProperties()
Inherited

This method is not documented.

Return

wild

public function selectMasterKey($key_name)
Inherited

This method is not documented.

Parameters

$key_name

Return

wild

final public function getStorageFormatKey()
Inherited

This method is not documented.

Return

wild

final public static function getAllFormats()
Inherited

This method is not documented.

Return

wild

final public static function getFormat($key)
Inherited

This method is not documented.

Parameters

$key

Return

wild

final public static function requireFormat($key)
Inherited

This method is not documented.

Parameters

$key

Return

wild

Defined: src/applications/files/format/PhabricatorFileROT13StorageFormat.php:11
Extends: PhobjectPhabricatorFileStorageFormat

final class PhabricatorFileROT13StorageFormatPhorge Technical Documentation (Files)

Methods

public function __get($name)Inherited

public function __set($name, $value)Inherited

public function current()Inherited

public function key()Inherited

public function next()Inherited

public function rewind()Inherited

public function valid()Inherited

private function throwOnAttemptedIteration()Inherited

public function getPhobjectClassConstant($key, $byte_limit)Inherited

final public function setFile($file)Inherited

final public function getFile()Inherited

public function getStorageFormatName()

public function newReadIterator($raw_iterator)

public function newWriteIterator($raw_iterator)

public function newFormatIntegrityHash()Inherited

public function newStorageProperties()

public function canGenerateNewKeyMaterial()Inherited

public function generateNewKeyMaterial()Inherited

public function canCycleMasterKey()Inherited

public function cycleStorageProperties()Inherited

public function selectMasterKey($key_name)Inherited

final public function getStorageFormatKey()Inherited

final public static function getAllFormats()Inherited

final public static function getFormat($key)Inherited

final public static function requireFormat($key)Inherited

final class PhabricatorFileROT13StorageFormat
Phorge Technical Documentation (Files)

public function __get($name)
Inherited

public function __set($name, $value)
Inherited

public function current()
Inherited

public function key()
Inherited

public function next()
Inherited

public function rewind()
Inherited

public function valid()
Inherited

private function throwOnAttemptedIteration()
Inherited

public function getPhobjectClassConstant($key, $byte_limit)
Inherited

final public function setFile($file)
Inherited

final public function getFile()
Inherited

public function newFormatIntegrityHash()
Inherited

public function canGenerateNewKeyMaterial()
Inherited

public function generateNewKeyMaterial()
Inherited

public function canCycleMasterKey()
Inherited

public function cycleStorageProperties()
Inherited

public function selectMasterKey($key_name)
Inherited

final public function getStorageFormatKey()
Inherited

final public static function getAllFormats()
Inherited

final public static function getFormat($key)
Inherited

final public static function requireFormat($key)
Inherited