1. class
  2. Riimu
  3. \
  4. Kit
  5. \
  6. PHPEncoder
  7. \
  8. Encoder
  9. \
  10. StringEncoder

StringEncoder

class StringEncoder implements Encoder (View source)

Encoder for string values.

Methods

array
getDefaultOptions()

Returns a list of options and their default values as an associative array.

bool
supports(mixed $value)

Tells if the encoder supports encoding the given value.

string
encode(mixed $value, int $depth, array $options, callable $encode)

Generates the PHP code representation for the given value.

Details

at line 22
array getDefaultOptions()

Returns a list of options and their default values as an associative array.

Return Value

array List of options and their default values

at line 27
bool supports(mixed $value)

Tells if the encoder supports encoding the given value.

Parameters

mixed $value Value to test

Return Value

bool True if the value can be encoded, false otherwise

at line 32
string encode(mixed $value, int $depth, array $options, callable $encode)

Generates the PHP code representation for the given value.

Parameters

mixed $value Value to encode
int $depth Current indentation depth of the output
array $options List of encoder options
callable $encode Callback used to encode values

Return Value

string The PHP code that represents the given value