-- Hoogle documentation, generated by Haddock
-- See Hoogle, http://www.haskell.org/hoogle/


-- | PHP session serialization
--   
--   PHP session serialization
@package hs-php-session
@version 0.0.8.8


-- | Encodes and decodes serialized PHP sessions in the format used by the
--   "php" setting for serialize_handler.
module Data.PHPSession.Types

-- | Holds the <a>top-level</a> session variables and their value contents.
type PHPSessionVariableList = [(ByteString, PHPSessionValue)]
data PHPSessionClassName
PHPSessionClassName :: ByteString -> PHPSessionClassName
data PHPSessionValue
PHPSessionValueArray :: [(PHPSessionValue, PHPSessionValue)] -> PHPSessionValue
PHPSessionValueBool :: Bool -> PHPSessionValue
PHPSessionValueFloat :: (Either Int Double) -> PHPSessionValue
PHPSessionValueInt :: Int -> PHPSessionValue
PHPSessionValueNull :: PHPSessionValue
PHPSessionValueObject :: PHPSessionClassName -> [(PHPSessionValue, PHPSessionValue)] -> PHPSessionValue
PHPSessionValueObjectSerializeable :: PHPSessionClassName -> ByteString -> PHPSessionValue
PHPSessionValueString :: ByteString -> PHPSessionValue
PHPSessionValueMisc :: ByteString -> [PHPSessionAttr] -> PHPSessionValue
data PHPSessionAttr
PHPSessionAttrInt :: Int -> PHPSessionAttr
PHPSessionAttrFloat :: Double -> PHPSessionAttr
PHPSessionAttrNested :: [PHPSessionValue] -> PHPSessionAttr
instance Eq PHPSessionAttr
instance Show PHPSessionAttr
instance Ord PHPSessionValue
instance Eq PHPSessionValue
instance Show PHPSessionValue
instance Eq PHPSessionClassName
instance Show PHPSessionClassName


-- | Encodes and decodes serialized PHP sessions in the format used by the
--   "php" setting for session.serialize_handler.
module Data.PHPSession

-- | Decodes a <tt>ByteString</tt> representing a PHP session into a
--   <a>PHPSessionVariableList</a>
decodePHPSession :: ByteString -> Maybe PHPSessionVariableList

-- | Decodes a <tt>ByteString</tt> into a <a>PHPSessionValue</a>
decodePHPSessionValue :: ByteString -> Maybe PHPSessionValue

-- | Encode a <a>PHPSessionVariableList</a> into a <tt>ByteString</tt>.
encodePHPSession :: PHPSessionVariableList -> ByteString

-- | Encode a <a>PHPSessionValue</a> into a <tt>ByteString</tt>.
encodePHPSessionValue :: PHPSessionValue -> ByteString

-- | Decodes as much as needed of a <tt>ByteString</tt> representing a PHP
--   session into a <a>PHPSessionVariableList</a>
decodePartialPHPSession :: ByteString -> (Maybe PHPSessionVariableList, ByteString)

-- | Decodes as much of a <tt>ByteString</tt> as needed into a
--   <a>PHPSessionValue</a>
decodePartialPHPSessionValue :: ByteString -> (Maybe PHPSessionValue, ByteString)

-- | Holds the <a>top-level</a> session variables and their value contents.
type PHPSessionVariableList = [(ByteString, PHPSessionValue)]
data PHPSessionClassName
PHPSessionClassName :: ByteString -> PHPSessionClassName
data PHPSessionValue
PHPSessionValueArray :: [(PHPSessionValue, PHPSessionValue)] -> PHPSessionValue
PHPSessionValueBool :: Bool -> PHPSessionValue
PHPSessionValueFloat :: (Either Int Double) -> PHPSessionValue
PHPSessionValueInt :: Int -> PHPSessionValue
PHPSessionValueNull :: PHPSessionValue
PHPSessionValueObject :: PHPSessionClassName -> [(PHPSessionValue, PHPSessionValue)] -> PHPSessionValue
PHPSessionValueObjectSerializeable :: PHPSessionClassName -> ByteString -> PHPSessionValue
PHPSessionValueString :: ByteString -> PHPSessionValue
PHPSessionValueMisc :: ByteString -> [PHPSessionAttr] -> PHPSessionValue
data PHPSessionAttr
PHPSessionAttrInt :: Int -> PHPSessionAttr
PHPSessionAttrFloat :: Double -> PHPSessionAttr
PHPSessionAttrNested :: [PHPSessionValue] -> PHPSessionAttr