Decodes a ByteString containing a serialization of a list of session variables using the "php" session serialization format into a PHPSessionVariableList

A version of decodePHPSession that returns a PHPSessionDecodingError when decoding the ByteString fails.

Decodes a ByteString containing a session serialization of a value into a PHPSessionValue. The format being decoded is similar if not probably the same format used by PHP's serialize/unserialize functions. Nothing is returned if the input bytestring could not be parsed correctly.

A version of decodePHPSessionValue that returns PHPSessionDecodingError when decoding the ByteString fails.

Encode a PHPSessionVariableList into a ByteString containing the serialization of a list of session variables using the "php" session serialization format.

Encode a PHPSessionValue into a ByteString containing the serialization of a PHP value. The format being encoded into is similar if not probably the same format used by PHP's serialize/unserialize functions.

convTo is a convenience function that converts natively typed values to PHPSessionValue, with the resulting PHP type determined by the type cast or inferred.

arrayOfPHPStrings :: PHPSessionValue
arrayOfPHPStrings =
  let str1 = "Hello" :: BS.ByteString
      str2 = "World"
   in convTo [(0 :: Int, str1), (1, str2)]

In the above example code, the OverloadedStrings language extension is assumed.

convFrom and convFromSafe are convenience functions that translate PHP values stored as PHPSessionValue into appropriate Haskell types depending on the desired type cast or inferred. Functions provided in this module provide non-coerced type translations and so will either carry on the translation or signal the fact that the attempted conversion will alter the type of the value. For situations where altering value types is expected, alternative conversion functions with similar type signatures are provided in modules within Data.PHPSession.ImplicitConv.

The example arrayOfPHPStrings definition given in convTo can be reverted back to Haskell types, which evaluates to [(0,"Hello"),(1,"World")].

>>> convFrom arrayOfPHPStrings :: [(Int,LBS.ByteString)]
[(0,"Hello"),(1,"World")]

However, if the desired type signature is changed to a completely different type, then a runtime exception is thrown:

>>> convFrom arrayOfPHPStrings :: [(Int,Int)]
*** Exception: Type mismatch converting from (PHPSessionValueString "Hello") to Int

Where there is the possibility that the value being sought may be NULL, the type should be (Maybe a).

A version of convFrom which returns a Left with an error message instead of throwing an exception.

Decodes as much of a ByteString as needed into a PHPSessionValue and returns the rest of the string. Decoding ends at either the end of the string or when the extent of the current nested structure is met when an extra closing curly brace is encountered. The format being decoded is similar if not probably the same format used by PHP's serialize/unserialize functions. Nothing is returned if the input bytestring could not be parsed correctly.

A version of decodePartialPHPSessionValue that uses Either, on decoding error a PHPSessionDecodingError is returned.

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

Represents the name of a PHP class.

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.

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