Documentation

EasyBlogMediaManagerJomSocialSource extends EasyBlogMediaManagerAbstractSource
in package

Table of Contents

Properties

$app  : mixed
$config  : mixed
$db  : mixed
$doc  : mixed
$input  : mixed
$jconfig  : mixed
$lang  : mixed
$my  : mixed
$string  : mixed
$rx_exclude  : mixed
$variationTypes  : mixed
$baseURI  : mixed
$exists  : mixed
$fileName  : mixed
$path  : mixed
$relative  : mixed

Methods

__construct()  : mixed
createVariation()  : mixed
This should be implemented by child instances
decorateFolder()  : mixed
Decorates the album item as a folder for JomSocial
decorateImage()  : mixed
Decorates the image object
delete()  : mixed
Deletes a file from the site
deleteVariations()  : mixed
Remove all image variations from the site
exists()  : mixed
Determines if JomSocial Exists
getAlbums()  : mixed
Retrieves a list of albums created on the site in JomSocial
getError()  : mixed
getErrors()  : mixed
getItem()  : mixed
Returns information about a photo in an album
getItems()  : mixed
Retrieves a list of albums or photos in an album
getPhotoVariations()  : mixed
Retrieves a list of photo variations on the site
getUniqueFileName()  : mixed
Alias function for uniqueFilename
getVariationItem()  : mixed
Structures the variation object
getVariations()  : mixed
hasError()  : mixed
hasErrors()  : mixed
hasLogin()  : mixed
Determines if the current place needs a login screen.
isAlbum()  : mixed
Determines if a given uri is an album or a photo item
isExcluded()  : mixed
Determines if the file is excluded
isLegacyImageVariation()  : mixed
Determines if this item is a legacy image file
isMobile()  : mixed
Determines if this is a mobile layout
isTablet()  : mixed
Determines if this is a tablet layout
loadLanguage()  : mixed
Helper method to load language
move()  : mixed
Moves a file or folder from destination to target
rename()  : mixed
Renames a file
renameVariations()  : mixed
Rename all variations when the main file is renamed
renderFolderContents()  : mixed
Render folder contents from media manager
renderFolderItems()  : mixed
Render folder items from media manager
serializeParam()  : mixed
setError()  : mixed
uniqueFilename()  : mixed
upload()  : mixed
createItem()  : mixed
Creates a new item object for media manager
getFileItem()  : mixed
Retrieves information about a uri
getFolderItem()  : mixed
Returns the structure of the folder
rx_variations()  : mixed
isDevelopmentMode()  : mixed
Determines if EasyBlog is running on dev mode

Properties

$app

public mixed $app = \null

$config

public mixed $config = \null

$db

public mixed $db = \null

$doc

public mixed $doc = \null

$input

public mixed $input = \null

$jconfig

public mixed $jconfig = \null

$lang

public mixed $lang = \null

$my

public mixed $my = \null

$string

public mixed $string = \null

$variationTypes

protected mixed $variationTypes = [\EBLOG_BLOG_IMAGE_PREFIX => 'blogimage', \EBLOG_USER_VARIATION_PREFIX => 'user', \EBLOG_SYSTEM_VARIATION_PREFIX => 'system']

Methods

__construct()

public __construct(mixed $lib) : mixed
Parameters
$lib : mixed

createVariation()

This should be implemented by child instances

public createVariation(mixed $uri, mixed $name, mixed $params) : mixed
Parameters
$uri : mixed
$name : mixed
$params : mixed
Tags
since
6.0.0
access

public

decorateFolder()

Decorates the album item as a folder for JomSocial

public decorateFolder(CTableAlbum $album) : mixed
Parameters
$album : CTableAlbum
Tags
since
5.1
access

public

decorateImage()

Decorates the image object

public decorateImage(CTablePhoto $photo, CTableAlbum $album) : mixed
Parameters
$photo : CTablePhoto
$album : CTableAlbum
Tags
since
5.1
access

public

delete()

Deletes a file from the site

public delete(mixed $uri) : mixed
Parameters
$uri : mixed
Tags
since
5.1
access

public

deleteVariations()

Remove all image variations from the site

public deleteVariations(mixed $uri) : mixed
Parameters
$uri : mixed
Tags
since
5.0
access

public

exists()

Determines if JomSocial Exists

public exists() : mixed
Tags
since
5.1
access

public

getAlbums()

Retrieves a list of albums created on the site in JomSocial

public getAlbums(mixed $userId) : mixed
Parameters
$userId : mixed
Tags
since
5.0
access

public

getError()

public getError() : mixed

getErrors()

public getErrors() : mixed

getItem()

Returns information about a photo in an album

public getItem(mixed $uri[, mixed $relative = false ]) : mixed
Parameters
$uri : mixed
$relative : mixed = false
Tags
since
5.1
access

public

getItems()

Retrieves a list of albums or photos in an album

public getItems(mixed $uri[, mixed $includeVariations = false ]) : mixed
Parameters
$uri : mixed
$includeVariations : mixed = false
Tags
since
5.1
access

public

getPhotoVariations()

Retrieves a list of photo variations on the site

public getPhotoVariations(CTablePhoto $photo) : mixed
Parameters
$photo : CTablePhoto
Tags
since
5.1
access

public

getUniqueFileName()

Alias function for uniqueFilename

public getUniqueFileName(mixed $path, mixed $fileName) : mixed
Parameters
$path : mixed
$fileName : mixed
Tags
since
5.1
access

public

getVariationItem()

Structures the variation object

public getVariationItem(mixed $name, mixed $url, mixed $fileName) : mixed
Parameters
$name : mixed
$url : mixed
$fileName : mixed
Tags
since
5.0
access

public

getVariations()

public getVariations(mixed $uri[, mixed $relative = false ]) : mixed
Parameters
$uri : mixed
$relative : mixed = false

hasError()

public hasError() : mixed

hasErrors()

public hasErrors() : mixed

hasLogin()

Determines if the current place needs a login screen.

public hasLogin() : mixed

Should be extended on child if needs overriding.

Tags
since
5.1
access

public

isAlbum()

Determines if a given uri is an album or a photo item

public isAlbum(mixed $uri) : mixed
Parameters
$uri : mixed
Tags
since
5.0
access

public

@return

isExcluded()

Determines if the file is excluded

public isExcluded(mixed $file) : mixed
Parameters
$file : mixed
Tags
since
5.0
access

public

isLegacyImageVariation()

Determines if this item is a legacy image file

public isLegacyImageVariation() : mixed
Tags
since
5.0
access

public

isMobile()

Determines if this is a mobile layout

public isMobile() : mixed
Tags
since
5.1
access

public

isTablet()

Determines if this is a tablet layout

public isTablet() : mixed
Tags
since
5.3
access

public

loadLanguage()

Helper method to load language

public loadLanguage([mixed $admin = false ]) : mixed
Parameters
$admin : mixed = false
Tags
since
5.0
access

public

move()

Moves a file or folder from destination to target

public move(mixed $source, mixed $target) : mixed
Parameters
$source : mixed
$target : mixed
Tags
since
5.0
access

public

rename()

Renames a file

public rename(mixed $sourceUri, mixed $targetUri) : mixed
Parameters
$sourceUri : mixed
$targetUri : mixed
Tags
since
5.0
access

public

renameVariations()

Rename all variations when the main file is renamed

public renameVariations(mixed $sourceUri, mixed $targetUri) : mixed
Parameters
$sourceUri : mixed
$targetUri : mixed
Tags
since
5.0
access

public

renderFolderContents()

Render folder contents from media manager

public renderFolderContents(mixed $folder) : mixed
Parameters
$folder : mixed
Tags
since
5.1
access

public

renderFolderItems()

Render folder items from media manager

public renderFolderItems(mixed $folder[, mixed $nextPage = 1 ]) : mixed
Parameters
$folder : mixed
$nextPage : mixed = 1
Tags
since
5.2
access

public

serializeParam()

public serializeParam(mixed $params) : mixed
Parameters
$params : mixed

setError()

public setError(mixed $msg) : mixed
Parameters
$msg : mixed

uniqueFilename()

public static uniqueFilename(mixed $folderpath, mixed $filename) : mixed
Parameters
$folderpath : mixed
$filename : mixed

upload()

public upload(mixed $file[, mixed $folderuri = null ]) : mixed
Parameters
$file : mixed
$folderuri : mixed = null

createItem()

Creates a new item object for media manager

protected createItem(mixed $uri) : mixed
Parameters
$uri : mixed
Tags
since
5.0
access

public

getFileItem()

Retrieves information about a uri

protected getFileItem(mixed $uri) : mixed
Parameters
$uri : mixed
Tags
since
5.0
access

public

getFolderItem()

Returns the structure of the folder

protected getFolderItem(mixed $uri) : mixed
Parameters
$uri : mixed
Tags
since
5.1
access

public

rx_variations()

protected rx_variations([mixed $filename = null ]) : mixed
Parameters
$filename : mixed = null

isDevelopmentMode()

Determines if EasyBlog is running on dev mode

private isDevelopmentMode() : mixed
Tags
since
5.1
access

public


        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results