\PhotoStorage
PhotoStorage allows to attach images for any kind of items on some scope
Synopsis
class PhotoStorage
{
- // constants
- const UPLOAD_URL_WEBC = '?module=photostorage&uploadcamphoto=true';
- const UPLOAD_URL_FILE = '?module=photostorage&uploadfilephoto=true';
- const MODULE_URL = '?module=photostorage';
- const ROUTE_PROXY = 'getimg';
- const EX_NOSCOPE = 'NO_OBJECT_SCOPE_SET';
- const EX_WRONG_EXT = 'WRONG_FILE_EXTENSION';
- const WATRERMARK_PATH = 'content/documents/watermark.png';
- // members
- protected array $photoCfg = ;
- protected array $altCfg = ;
- protected array $allimages = ;
- protected array $imagesCount = ;
- protected array $imagesList = ;
- protected string $scope = '';
- protected string $itemId = '';
- protected string $myLogin = '';
- protected bool $imagesLoadedFlag = false;
- protected bool $proxyMode = false;
- protected string $storagePath = 'content/documents/photostorage/';
- protected string $storageUrlPrefix = '';
- // methods
- public void __construct()
- protected void setScope()
- protected void setItemid()
- protected void loadConfig()
- protected void setOptions()
- protected void loadAlter()
- protected void setLogin()
- protected void loadAllImages()
- protected void registerImage()
- protected void unregisterImage()
- protected string imageControls()
- public string uploadControlsPanel()
- protected string backUrlHelper()
- public int getImagesCount()
- public array getImagesList()
- public array getAvailScopes()
- protected string getImageUrl()
- public string renderScopesGallery()
- public string renderImagesList()
- public string renderImagesRaw()
- public void catchDownloadImage()
- public void proxyImage()
- public void catchDeleteImage()
- public void catchWebcamUpload()
- public void imagePostProcessing()
- public void catchFileUpload()
- public string renderUploadForm()
- public string renderWebcamForm()
Constants
Name | Value |
---|---|
UPLOAD_URL_WEBC | '?module=photostorage&uploadcamphoto=true' |
UPLOAD_URL_FILE | '?module=photostorage&uploadfilephoto=true' |
MODULE_URL | '?module=photostorage' |
ROUTE_PROXY | 'getimg' |
EX_NOSCOPE | 'NO_OBJECT_SCOPE_SET' |
EX_WRONG_EXT | 'WRONG_FILE_EXTENSION' |
WATRERMARK_PATH | 'content/documents/watermark.png' |
Members
protected
- $allimages
—
array
Contains array of available images in database as id=>imagedata - $altCfg
—
array
Contains system alter config as key=>value - $imagesCount
—
array
Contains loaded images count for each item in some scope as scope=>itemid=>count - $imagesList
—
array
Contains loaded images paths for each item in some scope as scope=>itemid=>imagesList - $imagesLoadedFlag
—
bool
Flag for preventing multiple database requests - $itemId
—
string
Contains current instance item ID in the current scope - $myLogin
—
string
Contains current administrator login - $photoCfg
—
array
Contains system photostorage.ini config as key=>value - $proxyMode
—
bool
Use photostorage as image proxy flag - $scope
—
string
Contains current photostorage items scope - $storagePath
—
string
Contains images storage path. May be specified in PHOTOSTORAGE_DIRECTORY option. - $storageUrlPrefix
—
string
Custom, optional images display prefix URL. Configurable via PHOTOSTORAGE_URL_PREFIX option.
Methods
protected
- backUrlHelper() — Returns custom module backlinks for some scopes
- getImageUrl() — Returns image HTTP accessable URL
- imageControls() — Returns basic image controls
- loadAllImages() — Loads images list from database into private prop
- loadAlter() — Loads system alter config into private prop
- loadConfig() — Loads system photostorage config into private prop
- registerImage() — Registers uploaded image in database
- setItemid() — Object scope item Id setter
- setLogin() — Administrator login setter
- setOptions() — Sets some current instance specific options.
- setScope() — Object scope setter
- unregisterImage() — Deletes uploaded image from database
public
- __construct() — Initializes photostorage engine for some scope/item id
- catchDeleteImage() — deletes image from database and FS by its ID
- catchDownloadImage() — Downloads image file by its id
- catchFileUpload() — Catches file upload in background
- catchWebcamUpload() — Catches webcam snapshot upload in background
- getAvailScopes() — Retuns all available scopes and images count in it as scope=>count
- getImagesCount() — Returns count of loaded images for some itemid in some scope
- getImagesList() — Returns array of links of images for some itemId in current scope if it exists
- imagePostProcessing() — Performs some image postprocessing on images uploads
- proxyImage() — Returns some image content as is if proxy mode enabled \ and image file exists in storage path
- renderImagesList() — Returns current scope/item images list
- renderImagesRaw() — Returns list of available images for current scope/item
- renderScopesGallery() — Returns list of all available images for all scopes
- renderUploadForm() — Returns file upload form
- renderWebcamForm() — Returns webcamera snapshot form
- uploadControlsPanel() — Returns image upload controls