Table_File¶

class Table_File¶

extends Omeka_Db_Table

property Table_File::$_target¶

protected

Table_File::applySearchFilters($select, $params)¶

Parameters:

$select –

$params –

Table_File::filterBySince($select, $dateSince, $dateField)¶

Filter select object by date since.

Parameters:

$select (Zend_Db_Select) –

$dateSince (string) – ISO 8601 formatted date

$dateField (string) – “added” or “modified”

Table_File::filterByHasDerivativeImage($select, $hasDerivative)¶

Parameters:

$select –

$hasDerivative –

Table_File::getSelect()¶

All files should only be retrieved if they join properly on the items table.

Returns: Omeka_Db_Select

Table_File::getRandomFileWithImage($itemId)¶

Retrieve a random file with an image associated with an item.

Parameters:

$itemId (integer) –

Returns:
File

Table_File::findByItem($itemId, $fileIds = array(), $sort = 'order')¶

Retrieve files associated with an item.

Parameters:

$itemId (integer) –

$fileIds (array) – Optional If given, this will only retrieve files with these specific IDs.

$sort (string) – The manner by which to order the files. For example: ‘id’: file id, ‘filename’ = alphabetical by filename. The default is ‘order’, following the user’s specified order.

Returns:
array

Table_File::findOneByItem($itemId, $index = 0, $sort = 'order')¶

Get a single file associated with an item, by index.

Parameters:

$itemId (integer) –

$index (integer) –

$sort (string) – The manner by which to order the files. For example: ‘id’: file id, ‘filename’ = alphabetical by filename. The default is ‘order’, following the user’s specified order.

Returns:
File|null

Table_File::findWithImages($itemId, $index = null, $sort = 'order')¶

Retrieve files for an item that has derivative images.

Parameters:

$itemId (integer) – The ID of the item to get images for.

$index (integer|null) – Optional If given, this specifies the file to retrieve for an item, based upon the ordering of its files.

$sort (string) – The manner by which to order the files. For example: ‘id’: file id, ‘filename’: alphabetical by filename. The default is ‘order’, following the user’s specified order.

Returns:
File|array

Table_File::_orderFilesBy($select, $sort)¶

Orders select results for files.

Parameters:

$select –

$sort (string) – The manner in which to order the files by. For example: ‘id’ = file id ‘filename’ = alphabetical by filename

Returns:
void