Data.PHPSession.Types

Types used for representing PHP data types from encoding and decoding a PHP session.

PHP session types

type PHPSessionVariableList = [(ByteString, PHPSessionValue)]

Holds the "top-level" session variables and their value contents.

data PHPSessionClassName

Represents the name of a PHP class.

Constructors

PHPSessionClassName ByteString

Instances

Eq PHPSessionClassName

Show PHPSessionClassName

data PHPSessionValue

PHPSessionValue Represents a PHP value, which may be a number, string, array, object, boolean, null, or references.

• PHPSessionValueArray represents an array as a list of key-value pairs of values of type PHPSessionValue.
• PHPSessionValueObject is similar to PHPSessionValueArray but also includes a class name of type PHPSessionClassName.
• PHPSessionValueObjectSerializeable represent objects of which their classes implement Serializeable to handle their own serialization and don't use the normal serialization format for its contained objects.
• PHPSessionValueBool, PHPSessionValueInt, PHPSessionValueFloat, PHPSessionValueNull, and PHPSessionValueString represent basic types boolean, integer, floats, null and string respectively.
• PHPSessionValueFloat stores the number representation as an Either Int Double to preserve instances where the number representation is actually an integer. It should be noted that the re-encoded value is usually rounded unlike PHP's representation.
• PHPSessionValueMisc stores a few other types such as references and values which follow the general serialization format but aren't recognized by the decoder. A list of PHPSessionAttr provides the information for reconstructing the serialized representation when re-encoding this type of value.

Constructors

PHPSessionValueArray [(PHPSessionValue, PHPSessionValue)]

PHPSessionValueBool Bool

PHPSessionValueFloat (Either Int Double)

PHPSessionValueInt Int

PHPSessionValueNull

PHPSessionValueObject PHPSessionClassName [(PHPSessionValue, PHPSessionValue)]

PHPSessionValueObjectSerializeable PHPSessionClassName ByteString

PHPSessionValueString ByteString

PHPSessionValueMisc ByteString [PHPSessionAttr]

Instances

Eq PHPSessionValue

Ord PHPSessionValue

Show PHPSessionValue

data PHPSessionAttr

PHPSessionAttr are values associated with PHPSessionValueMisc to inspect and generally re-encode the necessary information for that value.

Constructors

PHPSessionAttrInt Int

PHPSessionAttrFloat Double

PHPSessionAttrNested [PHPSessionValue]

Instances

Eq PHPSessionAttr

Show PHPSessionAttr

data PHPSessionDecodingError

PHPSessionDecodingError are error types that can be returned if decoding did not succeed. They are returned by the Either versions of the decoding functions.

• PHPSessionStringEmpty is given if the decoder got an empty byte sequence.
• PHPSessionCouldntDecodeSerializablePast is given if the decoding does not succeed while in the particular byte sequence for a class that implements Serializable.
• PHPSessionCouldntDecodeObjectPast is given if the decoding does not succeed while in the particular byte sequence for a PHP object value.
• PHPSessionCouldntDecodeStringPast is given if the decoding does not succeed while in the particular byte sequence for a PHP string.
• PHPSessionCouldntDecodePast is given if the decoding does not succeed while decoding common byte sequences which are composed mainly of PHPSessionAttr forms.
• PHPSessionValueNotFullyDecoded is given if the byte sequence is not fully decoded to a PHPSessionValue when using decodePHPSessionValue or decodePHPSessionValueEither.
• PHPSessionNotFullyDecoded is given.if the byte sequence is not fully decoded to a PHPSessionVariableList when using decodePHPSession or decodePHPSessionEither.

Constructors

PHPSessionStringEmpty

PHPSessionCouldntDecodeSerializablePast ByteString

PHPSessionCouldntDecodeObjectPast ByteString

PHPSessionCouldntDecodeStringPast ByteString

PHPSessionCouldntDecodePast ByteString

PHPSessionValueNotFullyDecoded PHPSessionValue ByteString

PHPSessionNotFullyDecoded PHPSessionVariableList ByteString

Instances

Eq PHPSessionDecodingError

Show PHPSessionDecodingError