Data/LobAccess.php
\Conjoon_Data_LobAccess
Package: Default
Parameters
Returns
Throws
An interface for objects that gain read/write access to LOBs.
- Children
- \Conjoon_File_LobAccess
- \Conjoon_Db_LobAccess
- Author
- Thorsten Suckow-Homberg
Methods

addLob(
array $data
)
:
mixedSaves the lob specified in $data
Parameters
Returns
Throws
| Name | Type | Description |
|---|---|---|
| $data | array |
| Type | Description |
|---|---|
| mixed | a unique identifier for this lob, or null |
| Exception | Description |
|---|---|
| \Conjoon_Data_Exception |

addLobFromStream(
array $data
)
:
mixedAdds the lob from a stream.
Parameters
Returns
Throws
Details
| Name | Type | Description |
|---|---|---|
| $data | array |
| Type | Description |
|---|---|
| mixed | a unique identifier for this lob, or null |
| Exception | Description |
|---|---|
| \Conjoon_Data_Exception |
- See
- \isStreamWritingSupported

copyLob(
array $data
)
:
mixedCopies a Lob.
Parameters
Returns
Throws
| Name | Type | Description |
|---|---|---|
| $data | array |
| Type | Description |
|---|---|
| mixed | a unique identifier for this copied lob, otherwise null |
| Exception | Description |
|---|---|
| \Conjoon_Data_Exception |

deleteLob(
array $data
)
:
boolDeletes a lob.
Parameters
Returns
Throws
| Name | Type | Description |
|---|---|---|
| $data | array |
| Type | Description |
|---|---|
| bool | true on success, otherwise false |
| Exception | Description |
|---|---|
| \Conjoon_Data_Exception |

deleteLobForId(
int $id
)
:
boolDeletes a lob for an id.
Parameters
Returns
Throws
| Name | Type | Description |
|---|---|---|
| $id | int |
| Type | Description |
|---|---|
| bool | true on success, otherwise false |
| Exception | Description |
|---|---|
| \Conjoon_Data_Exception |

getLobAsStream(
array $data
)
:
resource | nullReturns a stream resource for a lob.
Parameters
Returns
Throws
Details
| Name | Type | Description |
|---|---|---|
| $data | array |
| Type | Description |
|---|---|
| resource | null |
| Exception | Description |
|---|---|
| \Conjoon_Data_Exception |
- See
- \isStreamAccessSupported

getLobContent(
array $data
)
:
stringReturns the lob's content.
Parameters
Returns
Throws
| Name | Type | Description |
|---|---|---|
| $data | array |
| Type | Description |
|---|---|
| string |
| Exception | Description |
|---|---|
| \Conjoon_Data_Exception |

getLobData(
array $data
)
:
arrayReturns 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.
| Name | Type | Description |
|---|---|---|
| $data | array |
| Type | Description |
|---|---|
| array | or null if not exists |
| Exception | Description |
|---|---|
| \Conjoon_Data_Exception |

isStreamAccessSupported(
)
:
boolReturns true if this class is capable of returning a lob as a stream, otherwise false
Returns
| Type | Description |
|---|---|
| bool |

isStreamWritingSupported(
)
:
boolReturns true if this class is capable of writing a lob as a stream, otherwise false
Returns
| Type | Description |
|---|---|
| bool |

moveLob(
array $data
)
:
mixedMoves a Lob.
Parameters
Returns
Throws
| Name | Type | Description |
|---|---|---|
| $data | array |
| Type | Description |
|---|---|
| mixed | a unique identifier for this moved lob, otherwise null |
| Exception | Description |
|---|---|
| \Conjoon_Data_Exception |

setLobName(
array $data
)
:
boolSets the name for a lob.
Parameters
Returns
Throws
| Name | Type | Description |
|---|---|---|
| $data | array |
| Type | Description |
|---|---|
| bool | true on success, otherwise false |
| Exception | Description |
|---|---|
| \Conjoon_Data_Exception |