Db/LobAccess.php
\Conjoon_Db_LobAccess
Package: Default
Parameters
Returns
Throws
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

addLob(
array $data
)
:
mixed
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
)
:
mixed
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
)
:
mixed
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
)
:
bool
Parameters
Returns
Throws
| Name | Type | Description |
|---|---|---|
| $data | array |
| Type | Description |
|---|---|
| bool | true on success, otherwise false |
| Exception | Description |
|---|---|
| \Conjoon_Data_Exception |

deleteLobForId(
int $id
)
:
bool
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 | null
inherited
Returns a stream resource for a lob.
Inherited from: \Conjoon_Data_LobAccess::getLobAsStream()
Parameters
Returns
Throws
Details
| Name | Type | Description |
|---|---|---|
| $data | array |
| Type | Description |
|---|---|
| resource | null |
| Exception | Description |
|---|---|
| \Conjoon_Data_Exception |
- See
- \isStreamAccessSupported

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

getLobData(
array $data
)
:
array
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(
)
:
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 |

isStreamWritingSupported(
)
:
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 |

moveLob(
array $data
)
:
mixed
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
)
:
bool
Parameters
Returns
Throws
| Name | Type | Description |
|---|---|---|
| $data | array |
| Type | Description |
|---|---|
| bool | true on success, otherwise false |
| Exception | Description |
|---|---|
| \Conjoon_Data_Exception |