PHP Class Imbo\Database\Mongo

A MongoDB database driver for Imbo Valid parameters for this driver: - (string) databaseName Name of the database. Defaults to 'imbo' - (string) server The server string to use when connecting to MongoDB. Defaults to 'mongodb://localhost:27017' - (array) options Options to use when creating the MongoDB\Client instance. Defaults to ['connect' => true, 'connectTimeoutMS' => 1000].

Author: Christer Edvartsen ([email protected])

Inheritance: implements Imbo\Database\DatabaseInterface

Datei anzeigen Open project: imbo/imbo Class Usage Examples

Public Methods

Method	Description
__construct ( array $params = null, MongoDB\Client $client = null, MongoDB\Collection $imageCollection = null, MongoDB\Collection $shortUrlCollection = null, BSONToArray $bsonToArray = null )	Class constructor
deleteImage ( $user, $imageIdentifier )
deleteMetadata ( $user, $imageIdentifier )
deleteShortUrls ( $user, $imageIdentifier, $shortUrlId = null )
getImageMimeType ( $user, $imageIdentifier )
getImageProperties ( $user, $imageIdentifier )
getImages ( array $users, Query $query, Images $model )
getLastModified ( array $users, $imageIdentifier = null )
getMetadata ( $user, $imageIdentifier )
getNumBytes ( $user = null )
getNumImages ( $user = null )
getNumUsers ( )
getShortUrlId ( $user, $imageIdentifier, $extension = null, array $query = [] )
getShortUrlParams ( $shortUrlId )
getStatus ( )
imageExists ( $user, $imageIdentifier )
insertImage ( $user, $imageIdentifier, Image $image )
insertShortUrl ( $shortUrlId, $user, $imageIdentifier, $extension = null, array $query = [] )
load ( $user, $imageIdentifier, Image $image )
updateMetadata ( $user, $imageIdentifier, array $metadata )

Private Methods

Method	Description
getCollection ( string $type ) : MongoDB\Collection	Get the mongo collection instance
getImageCollection ( ) : MongoDB\Collection	Fetch the image collection
getMongoClient ( ) : MongoDB\Client	Get the mongo client instance
getShortUrlCollection ( ) : MongoDB\Collection	Fetch the shortUrl collection

Method Details

__construct() public method

Class constructor

public __construct ( array $params = null, MongoDB\Client $client = null, MongoDB\Collection $imageCollection = null, MongoDB\Collection $shortUrlCollection = null, BSONToArray $bsonToArray = null )
$params	array	Parameters for the driver
$client	MongoDB\Client	MongoClient instance
$imageCollection	MongoDB\Collection	MongoCollection instance for the images
$shortUrlCollection	MongoDB\Collection	MongoCollection instance for the short URLs
$bsonToArray	Imbo\Helpers\BSONToArray	Helper to recursively convert documents to arrays

deleteImage() public method

public deleteImage ( $user, $imageIdentifier )

deleteMetadata() public method

public deleteMetadata ( $user, $imageIdentifier )

deleteShortUrls() public method

public deleteShortUrls ( $user, $imageIdentifier, $shortUrlId = null )

getImageMimeType() public method

public getImageMimeType ( $user, $imageIdentifier )

getImageProperties() public method

public getImageProperties ( $user, $imageIdentifier )

getImages() public method

public getImages ( array $users, Query $query, Images $model )
$users	array
$query	Imbo\Resource\Images\Query
$model	Imbo\Model\Images

getLastModified() public method

public getLastModified ( array $users, $imageIdentifier = null )
$users	array

getMetadata() public method

public getMetadata ( $user, $imageIdentifier )

getNumBytes() public method

public getNumBytes ( $user = null )

getNumImages() public method

public getNumImages ( $user = null )

getNumUsers() public method

public getNumUsers ( )

getShortUrlId() public method

public getShortUrlId ( $user, $imageIdentifier, $extension = null, array $query = [] )
$query	array

getShortUrlParams() public method

public getShortUrlParams ( $shortUrlId )

getStatus() public method

public getStatus ( )

imageExists() public method

public imageExists ( $user, $imageIdentifier )

insertImage() public method

public insertImage ( $user, $imageIdentifier, Image $image )
$image	Imbo\Model\Image

insertShortUrl() public method

public insertShortUrl ( $shortUrlId, $user, $imageIdentifier, $extension = null, array $query = [] )
$query	array

load() public method

public load ( $user, $imageIdentifier, Image $image )
$image	Imbo\Model\Image

updateMetadata() public method

public updateMetadata ( $user, $imageIdentifier, array $metadata )
$metadata	array