Data/LobAccess.php

Show: inherited
    Table of Contents

    \Conjoon_Data_LobAccess

    Package: Default

    An interface for objects that gain read/write access to LOBs.

    Children
    \Conjoon_File_LobAccess
    \Conjoon_Db_LobAccess
    Author
    Thorsten Suckow-Homberg  

    Methods

    methodpublicaddLob( array $data ) : mixed

    Saves the lob specified in $data

    Parameters
    Name Type Description
    $data array
    Returns
    Type Description
    mixed a unique identifier for this lob, or null
    Throws
    Exception Description
    \Conjoon_Data_Exception
    methodpublicaddLobFromStream( array $data ) : mixed

    Adds the lob from a stream.

    Parameters
    Name Type Description
    $data array
    Returns
    Type Description
    mixed a unique identifier for this lob, or null
    Throws
    Exception Description
    \Conjoon_Data_Exception
    Details
    See
    \isStreamWritingSupported  
    methodpubliccopyLob( array $data ) : mixed

    Copies a Lob.

    Parameters
    Name Type Description
    $data array
    Returns
    Type Description
    mixed a unique identifier for this copied lob, otherwise null
    Throws
    Exception Description
    \Conjoon_Data_Exception
    methodpublicdeleteLob( array $data ) : bool

    Deletes a lob.

    Parameters
    Name Type Description
    $data array
    Returns
    Type Description
    bool true on success, otherwise false
    Throws
    Exception Description
    \Conjoon_Data_Exception
    methodpublicdeleteLobForId( int $id ) : bool

    Deletes a lob for an id.

    Parameters
    Name Type Description
    $id int
    Returns
    Type Description
    bool true on success, otherwise false
    Throws
    Exception Description
    \Conjoon_Data_Exception
    methodpublicgetLobAsStream( array $data ) : resource | null

    Returns a stream resource for a lob.

    Parameters
    Name Type Description
    $data array
    Returns
    Type Description
    resource | null
    Throws
    Exception Description
    \Conjoon_Data_Exception
    Details
    See
    \isStreamAccessSupported  
    methodpublicgetLobContent( array $data ) : string

    Returns the lob's content.

    Parameters
    Name Type Description
    $data array
    Returns
    Type Description
    string
    Throws
    Exception Description
    \Conjoon_Data_Exception
    methodpublicgetLobData( array $data ) : array

    Returns the meta data for the lob.

    If this method returns the lob itself within the returned array, the lob's content must be stored in the property "resource" If the lob's resource should be returned, the property "includeResource" should be available in the passed array.

    Parameters
    Name Type Description
    $data array
    Returns
    Type Description
    array or null if not exists
    Throws
    Exception Description
    \Conjoon_Data_Exception
    methodpublicisStreamAccessSupported( ) : bool

    Returns true if this class is capable of returning a lob as a stream, otherwise false

    Returns
    Type Description
    bool
    methodpublicisStreamWritingSupported( ) : bool

    Returns true if this class is capable of writing a lob as a stream, otherwise false

    Returns
    Type Description
    bool
    methodpublicmoveLob( array $data ) : mixed

    Moves a Lob.

    Parameters
    Name Type Description
    $data array
    Returns
    Type Description
    mixed a unique identifier for this moved lob, otherwise null
    Throws
    Exception Description
    \Conjoon_Data_Exception
    methodpublicsetLobName( array $data ) : bool

    Sets the name for a lob.

    Parameters
    Name Type Description
    $data array
    Returns
    Type Description
    bool true on success, otherwise false
    Throws
    Exception Description
    \Conjoon_Data_Exception
    Documentation was generated by DocBlox 0.18.1.