Db/LobAccess.php

Show: inherited
    Table of Contents

    \Conjoon_Db_LobAccess

    Package: Default

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

    Parent(s)
    \Conjoon_Data_LobAccess
    Children
    \Conjoon_Modules_Groupware_Files_File_Model_File
    Author
    Thorsten Suckow-Homberg  

    Methods

    methodpublicaddLob( array $data ) : mixed
    inherited

    Saves the lob specified in $data

    Inherited from: \Conjoon_Data_LobAccess::addLob()
    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
    inherited

    Adds the lob from a stream.

    Inherited from: \Conjoon_Data_LobAccess::addLobFromStream()
    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
    inherited

    Copies a Lob.

    Inherited from: \Conjoon_Data_LobAccess::copyLob()
    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
    inherited

    Deletes a lob.

    Inherited from: \Conjoon_Data_LobAccess::deleteLob()
    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
    inherited

    Deletes a lob for an id.

    Inherited from: \Conjoon_Data_LobAccess::deleteLobForId()
    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
    inherited

    Returns a stream resource for a lob.

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

    Returns the lob's content.

    Inherited from: \Conjoon_Data_LobAccess::getLobContent()
    Parameters
    Name Type Description
    $data array
    Returns
    Type Description
    string
    Throws
    Exception Description
    \Conjoon_Data_Exception
    methodpublicgetLobData( array $data ) : array
    inherited

    Returns the meta data for the lob.

    Inherited from: \Conjoon_Data_LobAccess::getLobData()

    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
    inherited

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

    Inherited from: \Conjoon_Data_LobAccess::isStreamAccessSupported()
    Returns
    Type Description
    bool
    methodpublicisStreamWritingSupported( ) : bool
    inherited

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

    Inherited from: \Conjoon_Data_LobAccess::isStreamWritingSupported()
    Returns
    Type Description
    bool
    methodpublicmoveLob( array $data ) : mixed
    inherited

    Moves a Lob.

    Inherited from: \Conjoon_Data_LobAccess::moveLob()
    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
    inherited

    Sets the name for a lob.

    Inherited from: \Conjoon_Data_LobAccess::setLobName()
    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.