Documentation

EB
in package

EasyBlog

Properties

$headersLoaded : mixed
$categoryTheme : mixed

Methods

_() : mixed: Converts to sef links
__callStatic() : mixed: Loads a library dynamically
accessCategoryLinkage() : mixed
accessNestedCategories() : mixed
accessNestedCategoriesId() : mixed
acl() : mixed: Load EasyBlog's ACL
addCanonicalURL() : mixed: Adds canonical URL to satisfy google bots in case they think that it's a duplicated content
ajax() : mixed: Renders the ajax library
autoload() : mixed: Renders the autoload file for other libraries from composer
blogimage() : mixed: Retrieves the blog image object
buildNestedCategories() : mixed
cache() : mixed: cache for post related items.
call() : mixed: Single point of entry for static calls.
category() : mixed: Retrieves the category library
checkEnvironment() : mixed: If the current user is a super admin, allow them to change the environment via the query string
checkToken() : mixed: Deprecated. Use FH::checkToken()
clearSession() : mixed
config() : mixed: Load's EasyBlog's settings object
date() : mixed: Loads the date helper object
db() : mixed: Get's the database object.
document() : mixed: Proxy for document library
easydiscuss() : mixed: Custom implementation of EasyDiscuss integrations
easysocial() : mixed: Custom implementation of EasySocial integrations
exception() : mixed: Creates a new instance of the exception library.
fd() : mixed
formatMicroblog() : mixed: Formats microblog posts. Use EB::quickpost()->getAdapter('source')->format($blog);
formatter() : mixed: Content formatter for the blogs
getAccessibleCategories() : mixed
getAmpPlaceholderImage() : mixed: Retrieves the default AMP placeholder image
getBloggerTheme() : mixed: Deprecated. No longer in use since 6.0
getCache() : mixed: Retrieves Joomla's cache object
getCallback() : mixed: Retrieve callback url from joomla session
getCategoriesForFilters() : mixed
getCategoryInclusion() : mixed: Retrieves a list of category id that should be included
getCategoryMenuBloggerId() : mixed
getCategoryTheme() : mixed: Retrieve the current category theme
getCdnUrl() : mixed: Retrieves the cdn url for the site
getConfig() : mixed: Deprecated. Use EB::config
getCoverSize() : mixed: Determines the image size to be used
getCurrentLanguage() : mixed: Retrieves the current language
getCurrentTemplate() : mixed: We cannot rely on $app->getTemplate() because we need to explicitly get the current default front end template.
getCustomThemes() : mixed: Retrieve easyblog custom themes
getDefaultCategoryId() : mixed
getDefaultSAIds() : mixed: Retrieves the default super administrator user id
getDeprecatedImageSizes() : mixed: Retrieve the deprecated image sizes
getEditor() : mixed: Retrieves the editor except composer page
getEditProfileLink() : mixed: Renders the edit profile link in EasyBlog
getErrorRedirection() : mixed: Give a proper redirection when the user does not have the permission to view item.
getExcludedLegacyCategories() : mixed: Legacy method to get excluded categories
getExternalLink() : mixed: Retrieves plain links (Non SEF)
getFirstImage() : mixed
getJoomlaLanguages() : mixed: Deprecated. Use FH::getJoomlaLanguages()
getJoomlaUserModel() : mixed: Loads the user model from Joomla
getJoomlaVersion() : mixed: Deprecated. Use FH::getJoomlaVersion()
getLanguages() : mixed: Deprecated. Use FH::getLanguages()
getLanguageTag() : mixed: Deprecated. Use FH::getCurrentLanguageTag()
getLastDayOfCurrentMonth() : mixed: Return the last date of the current month
getLikesAuthors() : mixed: Deprecated. Use EB::comment()->getLikesAuthors
getLimit() : mixed: Retrieve the limit defined in the settings given the specific key
getLocalParser() : mixed: Retrieves local version
getLocalVersion() : mixed: Retrieves the installed version of EasyBlog
getLoginLink() : mixed: Generates the login link within EasyBlog extension
getLogo() : mixed: Retrieves logo
getLogoOverridePath() : mixed: Retrieves the override path for a specific type of logo. It could either be schema, watermarks etc.
getMenuParams() : mixed: This method will intelligently determine which menu params this post should be inheriting from
getMetaKey() : mixed: Retrieves the meta key for the current operating system
getMomentLanguage() : mixed: Retrieve the current language tag set
getOtpConfig() : mixed: Retrieve the otpConfig from Joomla users
getPagePostTitle() : mixed: Generate page title for post entry page
getPageTitle() : mixed: Given a page title, this method would try to find any existing menu items that are tied to the current page view.
getPlaceholderImage() : mixed: Retrieves the default placeholder image
getPostStyles() : mixed: Central method to retrieve the post styles from the params
getPostTitle() : mixed: Get post title by ID
getPrivateCategories() : mixed: This function returns array of private categories respected the category acl view.
getRegistrationLink() : mixed: Renders the registration link within EasyBlog extension
getRemindUsernameLink() : mixed: Generates the remind username link
getResetPasswordLink() : mixed: Generates the reset password link within EasyBlog extension
getSAUsersIds() : mixed: Retrieves a list of super users from the site
getSession() : mixed
getSubscription() : mixed: Determines if the user is subscribed to any part of the notification in EasyBlog
getTemplate() : mixed: Deprecated. Use EB::themes() instead
getTwoFactorForms() : mixed: Prepares the HTML to render two factor forms on the page
getTwoFactorMethods() : mixed: Deprecated. Use FH::getTwoFactorMethods
getUniqueFileName() : mixed
getUnsubscribeLink() : mixed: Generates the unsubscribe link for emails
getUserGids() : mixed
getUsergroupsIds() : mixed: Retrieves all usergroups ids on the site
getUserId() : mixed: Given a username, retrieve the user's id.
getUsersTableCollation() : mixed: function to the column collation that compatible with Joomla 3.5 jos_users table collation.
getViewLimit() : mixed: Retrieve the limit defined for each views settings given from specific key
getXml() : mixed: Reads a XML file.
giphy() : mixed: Creates a new instance of the GIPHY library.
hasBlockType() : mixed: Determines if a list of posts contain the block by type given
hasImageWatermark() : mixed: Determines if we should be applying watermark on images
hasOverrideLogo() : mixed: Determine if custom logo is exists
hasTwoFactor() : mixed: Deprecated. Use FH::hasTwoFactor instead
helper() : mixed: Retrieve specific helper objects.
info() : mixed: Renders the info object
init() : mixed: Initializes EasyBlog's javascript framework
initFoundry() : mixed: Initializes Foundry
isAssociationEnabled() : mixed: Determines if language association is enabled
isBlogger() : mixed
isBloggerMode() : mixed: Deprecated since EB 6.0 as we no longer use it
isFalangActivated() : mixed: determined if falang activated.
isFeatured() : mixed
isFoundryEnabled() : mixed: Check if foundry plugin enabled or not.
isFromAdmin() : mixed: Use FH::isFromAdmin() instead
isJoomla31() : mixed: Deprecated. Use FH::isJoomla31()
isJoomla4() : mixed: Deprecated. Use FH::isJoomla4()
isJoomla40() : mixed: Deprecated but we still require this function so that user who perform upgrade from older version (5.2.x) will not hit error
isLegacyTheme() : mixed: Determines if the provided theme is a legacy theme
isLoggedIn() : mixed: Determines if the user is logged into the site
isMultiLingual() : mixed: Deprecated. Use FH::isMultiLingual
isRegistrationEnabled() : mixed: Deprecated. Use FH::isRegistrationEnabled()
isSiteAdmin() : mixed: Use FH::isSiteAdmin() instead
isSiteMultilingualEnabled() : mixed: Deprecated. Use FH::isMultiLinagual
isTeamAdmin() : mixed: Determines if the user is a team admin
jconfig() : mixed: Renders Joomla's configuration object
load() : mixed: Loads a library file
loadContentRouter() : mixed: Loads the necessary router file for com_content
loadLanguages() : mixed: Loads the default languages for EasyBlog
loadModuleCss() : mixed: Deprecated
loadServices() : mixed: Loads a list of services
location() : mixed: Proxy for location library.
makeArray() : mixed: Converts an argument into an array.
makeFolder() : bool: Detects if the folder exist based on the path given. If it doesn't exist, create it.
math() : mixed: math lib
mediamanager() : mixed: Proxy for media manager
minifyCSS() : mixed: Deprecated. Use FH::minifyCss($css)
model() : mixed: Method to retrieve a model
modules() : mixed: Render the modules library
normalize() : mixed: Deprecated. Rely on FD::normalize
normalizeSchema() : mixed: Converts characters to HTML entities for Schema structure data
pagination() : mixed: Pagination for EasyBlog
polls() : mixed: Creates a new instance of the Polls library.
populateCategories() : mixed: Generates a html code for category selection.
populateCategoryFilter() : mixed: Generates a html code for category selection in backend
populateCategoryLinkage() : mixed: Retrieve backward linkage from a child category
post() : mixed: Proxy for post library
raiseWarning() : mixed: Method to display Joomla's core alert
reactions() : mixed: Proxy for post library
registry() : mixed: Returns a new registry object
removeGallery() : mixed: Use EB::gallery()->removeGalleryCodes($text) instead
renderModule() : mixed: Renders module in a template
request() : mixed: Load the request library
requireLogin() : mixed: Requires the user to be logged in
sanitizeCsv() : mixed: Helper to sanitize comma separated values
scripts() : mixed: Render the scripts library
setCallback() : mixed: Set callback url in joomla session
setCategoryTheme() : mixed: Set the current category theme
setMeta() : mixed: Allows caller to set the meta
setMetaData() : mixed: Alternative to setMeta
showLogin() : mixed
showSiteName() : mixed: Use FH::getSiteName() instead
storeSession() : mixed
stripEmbedTags() : mixed: This method searches for built in tags and strips them off. This should only be used when you are trying to output some data that doesn't contain html tags.
stylesheet() : mixed: Creates a new stylesheet instance
table() : mixed: Method to retrieve a table object
template() : mixed: Deprecated. Use EB::themes
themes() : mixed: Creates a new theme instance
token() : mixed: Retrieves the token
triggerEvent() : mixed: Trigger Joomla events
uniqueLinkSegments() : mixed
unsplash() : mixed: Creates a new instance of the Unsplash library.
uploadMediaAvatar() : mixed: Standard method to process uploaded avatars
user() : mixed: Method to retrieve a EasyBlogUser object
verifyBlogPassword() : mixed: Verifies the password for a post

$headersLoaded


    public
    static    mixed
    $headersLoaded
     = []

$categoryTheme


    private
    static    mixed
    $categoryTheme
     = \null

_()

Converts to sef links


    public
            static        _(mixed $link[, mixed $xhtml = true ]) : mixed

Parameters

$link : mixed
$xhtml : mixed = true

__callStatic()

Loads a library dynamically


    public
            static        __callStatic(mixed $method, mixed $arguments) : mixed

Parameters

$method : mixed
$arguments : mixed

accessCategoryLinkage()


    public
            static        accessCategoryLinkage(mixed $childId, mixed &$arr) : mixed

Parameters

$childId : mixed
$arr : mixed

accessNestedCategories()


    public
            static        accessNestedCategories(mixed $arr, mixed &$html[, mixed $deep = '0' ][, mixed $default = '0' ][, mixed $type = 'select' ][, mixed $linkDelimiter = '' ]) : mixed

Parameters

$arr : mixed
$html : mixed
$deep : mixed = '0'
$default : mixed = '0'
$type : mixed = 'select'
$linkDelimiter : mixed = ''

accessNestedCategoriesId()


    public
            static        accessNestedCategoriesId(mixed $arr, mixed &$newArr) : mixed

Parameters

$arr : mixed
$newArr : mixed

acl()

Load EasyBlog's ACL


    public
            static        acl([mixed $userId = '' ]) : mixed

Parameters

$userId : mixed = ''

addCanonicalURL()

Adds canonical URL to satisfy google bots in case they think that it's a duplicated content


    public
            static        addCanonicalURL([mixed $extraFishes = array() ]) : mixed

Parameters

$extraFishes : mixed = array()

ajax()

Renders the ajax library


    public
            static        ajax() : mixed

autoload()

Renders the autoload file for other libraries from composer


    public
            static        autoload() : mixed

blogimage()

Retrieves the blog image object


    public
            static        blogimage(mixed $path, mixed $uri[, mixed $storageType = 'joomla' ]) : mixed

Parameters

$path : mixed
$uri : mixed
$storageType : mixed = 'joomla'

buildNestedCategories()


    public
            static        buildNestedCategories(mixed $parentId, mixed &$parent[, mixed $ignorePrivate = false ][, mixed $isPublishedOnly = false ][, mixed $isWrite = false ][, mixed $exclusion = array() ]) : mixed

Parameters

$parentId : mixed
$parent : mixed
$ignorePrivate : mixed = false
$isPublishedOnly : mixed = false
$isWrite : mixed = false
$exclusion : mixed = array()

cache()

cache for post related items.


    public
            static        cache() : mixed

call()

Single point of entry for static calls.


    public
            static        call(mixed $className, mixed $method[, mixed $args = array() ]) : mixed

Parameters

$className : mixed
$method : mixed
$args : mixed = array()

category()

Retrieves the category library


    public
            static        category() : mixed

checkEnvironment()

If the current user is a super admin, allow them to change the environment via the query string


    public
            static        checkEnvironment() : mixed

checkToken()

Deprecated. Use FH::checkToken()


    public
            static        checkToken() : mixed

clearSession()


    public
            static        clearSession(mixed $key[, mixed $ns = 'COM_EASYBLOG' ]) : mixed

Parameters

$key : mixed
$ns : mixed = 'COM_EASYBLOG'

config()

Load's EasyBlog's settings object


    public
            static        config() : mixed

date()

Loads the date helper object


    public
            static        date([mixed $current = '' ][, mixed $offset = null ]) : mixed

Parameters

$current : mixed = ''
$offset : mixed = null

db()

Get's the database object.


    public
            static        db() : mixed

document()

Proxy for document library


    public
            static        document([mixed $json = null ]) : mixed

Parameters

$json : mixed = null

easydiscuss()

Custom implementation of EasyDiscuss integrations


    public
            static        easydiscuss() : mixed

easysocial()

Custom implementation of EasySocial integrations


    public
            static        easysocial() : mixed

exception()

Creates a new instance of the exception library.


    public
            static        exception([mixed $message = '' ][, mixed $type = EASYBLOG_MSG_ERROR ][, mixed $silent = false ][, mixed $customErrorCode = null ]) : mixed

Parameters

$message : mixed = ''
$type : mixed = EASYBLOG_MSG_ERROR
$silent : mixed = false
$customErrorCode : mixed = null

fd()


    public
            static        fd() : mixed

formatMicroblog()

Formats microblog posts. Use EB::quickpost()->getAdapter('source')->format($blog);


    public
            static        formatMicroblog(mixed &$row) : mixed

Parameters

$row : mixed

formatter()

Content formatter for the blogs


    public
            static        formatter(mixed $type, mixed $items[, mixed $cache = true ][, mixed $options = array() ]) : mixed

Parameters

$type : mixed
$items : mixed
$cache : mixed = true
$options : mixed = array()

getAccessibleCategories()


    public
            static        getAccessibleCategories([mixed $parentId = 0 ]) : mixed

Parameters

$parentId : mixed = 0

getAmpPlaceholderImage()

Retrieves the default AMP placeholder image


    public
            static        getAmpPlaceholderImage() : mixed

getBloggerTheme()

Deprecated. No longer in use since 6.0


    public
            static        getBloggerTheme() : mixed

getCache()

Retrieves Joomla's cache object


    public
            static        getCache() : mixed

getCallback()

Retrieve callback url from joomla session


    public
            static        getCallback([mixed $default = '' ][, mixed $resetSession = true ]) : mixed

Parameters

$default : mixed = ''
$resetSession : mixed = true

getCategoriesForFilters()


    public
            static        getCategoriesForFilters([mixed $parentId = null ]) : mixed

Parameters

$parentId : mixed = null

getCategoryInclusion()

Retrieves a list of category id that should be included


    public
            static        getCategoryInclusion(mixed $categories) : mixed

Parameters

$categories : mixed

getCategoryMenuBloggerId()


    public
            static        getCategoryMenuBloggerId() : mixed

getCategoryTheme()

Retrieve the current category theme


    public
            static        getCategoryTheme() : mixed

getCdnUrl()

Retrieves the cdn url for the site


    public
            static        getCdnUrl() : mixed

getConfig()

Deprecated. Use EB::config


    public
            static        getConfig() : mixed

getCoverSize()

Determines the image size to be used


    public
            static        getCoverSize(mixed $configKey) : mixed

Parameters

$configKey : mixed

getCurrentLanguage()

Retrieves the current language


    public
            static        getCurrentLanguage() : mixed

getCurrentTemplate()

We cannot rely on $app->getTemplate() because we need to explicitly get the current default front end template.


    public
            static        getCurrentTemplate() : mixed

getCustomThemes()

Retrieve easyblog custom themes


    public
            static        getCustomThemes(mixed $template) : mixed

Parameters

$template : mixed

getDefaultCategoryId()


    public
            static        getDefaultCategoryId() : mixed

getDefaultSAIds()

Retrieves the default super administrator user id


    public
            static        getDefaultSAIds() : mixed

getDeprecatedImageSizes()

Retrieve the deprecated image sizes


    public
            static        getDeprecatedImageSizes() : mixed

getEditor()

Retrieves the editor except composer page


    public
            static        getEditor([mixed $nameOnly = false ]) : mixed

Parameters

$nameOnly : mixed = false

getEditProfileLink()

Renders the edit profile link in EasyBlog


    public
            static        getEditProfileLink([mixed $forceEBLink = false ][, mixed $external = false ]) : mixed

Parameters

$forceEBLink : mixed = false
$external : mixed = false

getErrorRedirection()

Give a proper redirection when the user does not have the permission to view item.


    public
            static        getErrorRedirection([mixed $message = null ]) : mixed

Parameters

$message : mixed = null

getExcludedLegacyCategories()

Legacy method to get excluded categories


    public
            static        getExcludedLegacyCategories() : mixed

getExternalLink()

Retrieves plain links (Non SEF)


    public
            static        getExternalLink(mixed $link[, mixed $xhtml = false ]) : mixed

Parameters

$link : mixed
$xhtml : mixed = false

getFirstImage()


    public
            static        getFirstImage(mixed $content) : mixed

Parameters

$content : mixed

getJoomlaLanguages()

Deprecated. Use FH::getJoomlaLanguages()


    public
            static        getJoomlaLanguages() : mixed

getJoomlaUserModel()

Loads the user model from Joomla


    public
            static        getJoomlaUserModel() : mixed

getJoomlaVersion()

Deprecated. Use FH::getJoomlaVersion()


    public
            static        getJoomlaVersion() : mixed

getLanguages()

Deprecated. Use FH::getLanguages()


    public
            static        getLanguages([mixed $selected = '' ][, mixed $subname = true ]) : mixed

Parameters

$selected : mixed = ''
$subname : mixed = true

getLanguageTag()

Deprecated. Use FH::getCurrentLanguageTag()


    public
            static        getLanguageTag() : mixed

getLastDayOfCurrentMonth()

Return the last date of the current month


    public
            static        getLastDayOfCurrentMonth(mixed $dateString) : mixed

Parameters

$dateString : mixed

getLikesAuthors()

Deprecated. Use EB::comment()->getLikesAuthors


    public
            static        getLikesAuthors(mixed $contentId, mixed $type, mixed $userId) : mixed

Parameters

$contentId : mixed
$type : mixed
$userId : mixed

getLimit()

Retrieve the limit defined in the settings given the specific key


    public
            static        getLimit([mixed $key = 'listlength' ]) : mixed

Parameters

$key : mixed = 'listlength'

getLocalParser()

Retrieves local version


    public
            static        getLocalParser() : mixed

getLocalVersion()

Retrieves the installed version of EasyBlog


    public
            static        getLocalVersion() : mixed

getLoginLink()

Generates the login link within EasyBlog extension


    public
            static        getLoginLink([mixed $returnURL = '' ]) : mixed

Parameters

$returnURL : mixed = ''

getLogo()

Retrieves logo


    public
            static        getLogo([mixed $type = 'email' ][, mixed $forceDefault = false ]) : mixed

Parameters

$type : mixed = 'email'
$forceDefault : mixed = false

getLogoOverridePath()

Retrieves the override path for a specific type of logo. It could either be schema, watermarks etc.


    public
            static        getLogoOverridePath(mixed $type) : mixed

Parameters

$type : mixed

getMenuParams()

This method will intelligently determine which menu params this post should be inheriting from


    public
            static        getMenuParams(mixed $id, mixed $type[, mixed $menuParams = false ][, mixed $debug = false ]) : mixed

Parameters

$id : mixed
$type : mixed
$menuParams : mixed = false
$debug : mixed = false

getMetaKey()

Retrieves the meta key for the current operating system


    public
            static        getMetaKey() : mixed

getMomentLanguage()

Retrieve the current language tag set


    public
            static        getMomentLanguage() : mixed

getOtpConfig()

Retrieve the otpConfig from Joomla users


    public
            static        getOtpConfig([mixed $userId = null ]) : mixed

Parameters

$userId : mixed = null

getPagePostTitle()

Generate page title for post entry page


    public
            static        getPagePostTitle(mixed $postTitle) : mixed

Parameters

$postTitle : mixed

getPageTitle()

Given a page title, this method would try to find any existing menu items that are tied to the current page view.


    public
            static        getPageTitle([mixed $default = '' ][, mixed $useMenuForTitle = true ]) : mixed

If a page title is tied, it will then use the page title defined in the menu.

Parameters

$default : mixed = ''
$useMenuForTitle : mixed = true

getPlaceholderImage()

Retrieves the default placeholder image


    public
            static        getPlaceholderImage([mixed $protocol = false ][, mixed $type = '' ]) : mixed

Parameters

$protocol : mixed = false
$type : mixed = ''

getPostStyles()

Central method to retrieve the post styles from the params


    public
            static        getPostStyles(mixed $params) : mixed

Parameters

$params : mixed

getPostTitle()

Get post title by ID


    public
            static        getPostTitle(mixed $id) : mixed

Parameters

$id : mixed

getPrivateCategories()

This function returns array of private categories respected the category acl view.


    public
            static        getPrivateCategories() : mixed

getRegistrationLink()

Renders the registration link within EasyBlog extension


    public
            static        getRegistrationLink() : mixed

getRemindUsernameLink()

Generates the remind username link


    public
            static        getRemindUsernameLink() : mixed

getResetPasswordLink()

Generates the reset password link within EasyBlog extension


    public
            static        getResetPasswordLink() : mixed

getSAUsersIds()

Retrieves a list of super users from the site


    public
            static        getSAUsersIds() : mixed

getSession()


    public
            static        getSession(mixed $key[, mixed $ns = 'COM_EASYBLOG' ]) : mixed

Parameters

$key : mixed
$ns : mixed = 'COM_EASYBLOG'

getSubscription()

Determines if the user is subscribed to any part of the notification in EasyBlog


    public
            static        getSubscription(mixed $email[, mixed $type = EBLOG_SUBSCRIPTION_SITE ][, mixed $uid = null ]) : mixed

Parameters

$email : mixed
$type : mixed = EBLOG_SUBSCRIPTION_SITE
$uid : mixed = null

getTemplate()

Deprecated. Use EB::themes() instead


    public
            static        getTemplate([mixed $theme = false ][, mixed $options = [] ]) : mixed

Parameters

$theme : mixed = false
$options : mixed = []

getTwoFactorForms()

Prepares the HTML to render two factor forms on the page


    public
            static        getTwoFactorForms(mixed $otpConfig[, mixed $userId = null ]) : mixed

Parameters

$otpConfig : mixed
$userId : mixed = null

getTwoFactorMethods()

Deprecated. Use FH::getTwoFactorMethods


    public
            static        getTwoFactorMethods() : mixed

getUniqueFileName()


    public
            static        getUniqueFileName(mixed $originalFilename, mixed $path) : mixed

Parameters

$originalFilename : mixed
$path : mixed

getUnsubscribeLink()

Generates the unsubscribe link for emails


    public
            static        getUnsubscribeLink(mixed $subdata[, mixed $external = false ][, mixed $isAllType = false ][, mixed $email = '' ]) : mixed

Parameters

$subdata : mixed
$external : mixed = false
$isAllType : mixed = false
$email : mixed = ''

getUserGids()


    public
            static        getUserGids([mixed $userId = '' ][, mixed $implode = false ]) : mixed

Parameters

$userId : mixed = ''
$implode : mixed = false

getUsergroupsIds()

Retrieves all usergroups ids on the site


    public
            static        getUsergroupsIds([mixed $idOnly = false ]) : mixed

Parameters

$idOnly : mixed = false

getUserId()

Given a username, retrieve the user's id.


    public
            static        getUserId(mixed $username) : mixed

Parameters

$username : mixed

getUsersTableCollation()

function to the column collation that compatible with Joomla 3.5 jos_users table collation.


    public
            static        getUsersTableCollation(mixed $from) : mixed

Parameters

$from : mixed

getViewLimit()

Retrieve the limit defined for each views settings given from specific key


    public
            static        getViewLimit([mixed $name = 'limit' ][, mixed $view = 'listing' ]) : mixed

Parameters

$name : mixed = 'limit'
$view : mixed = 'listing'

getXml()

Reads a XML file.


    public
            static        getXml(mixed $data[, mixed $isFile = true ]) : mixed

Parameters

$data : mixed
$isFile : mixed = true

giphy()

Creates a new instance of the GIPHY library.


    public
            static        giphy() : mixed

hasBlockType()

Determines if a list of posts contain the block by type given


    public
            static        hasBlockType(mixed $type, mixed $posts) : mixed

Parameters

$type : mixed
$posts : mixed

hasImageWatermark()

Determines if we should be applying watermark on images


    public
            static        hasImageWatermark() : mixed

hasOverrideLogo()

Determine if custom logo is exists


    public
            static        hasOverrideLogo(mixed $type) : mixed

Parameters

$type : mixed

hasTwoFactor()

Deprecated. Use FH::hasTwoFactor instead


    public
            static        hasTwoFactor() : mixed

helper()

Retrieve specific helper objects.


    public
            static        helper(mixed $helper) : mixed

Parameters

$helper : mixed

info()

Renders the info object


    public
            static        info() : mixed

init()

Initializes EasyBlog's javascript framework


    public
            static        init([mixed $section = 'site' ]) : mixed

Parameters

$section : mixed = 'site'

initFoundry()

Initializes Foundry


    public
            static        initFoundry() : mixed

isAssociationEnabled()

Determines if language association is enabled


    public
            static        isAssociationEnabled() : mixed

isBlogger()


    public
            static        isBlogger(mixed $userId) : mixed

Parameters

$userId : mixed

isBloggerMode()

Deprecated since EB 6.0 as we no longer use it


    public
            static        isBloggerMode() : mixed

isFalangActivated()

determined if falang activated.


    public
            static        isFalangActivated() : mixed

isFeatured()


    public
            static        isFeatured(mixed $type, mixed $id) : mixed

Parameters

$type : mixed
$id : mixed

isFoundryEnabled()

Check if foundry plugin enabled or not.


    public
            static        isFoundryEnabled() : mixed

isFromAdmin()

Use FH::isFromAdmin() instead


    public
            static        isFromAdmin() : mixed

isJoomla31()

Deprecated. Use FH::isJoomla31()


    public
            static        isJoomla31() : mixed

isJoomla4()

Deprecated. Use FH::isJoomla4()


    public
            static        isJoomla4() : mixed

isJoomla40()

Deprecated but we still require this function so that user who perform upgrade from older version (5.2.x) will not hit error


    public
            static        isJoomla40() : mixed

isLegacyTheme()

Determines if the provided theme is a legacy theme


    public
            static        isLegacyTheme(mixed $theme) : mixed

Parameters

$theme : mixed

isLoggedIn()

Determines if the user is logged into the site


    public
            static        isLoggedIn() : mixed

isMultiLingual()

Deprecated. Use FH::isMultiLingual


    public
            static        isMultiLingual() : mixed

isRegistrationEnabled()

Deprecated. Use FH::isRegistrationEnabled()


    public
            static        isRegistrationEnabled() : mixed

isSiteAdmin()

Use FH::isSiteAdmin() instead


    public
            static        isSiteAdmin([mixed $id = null ]) : mixed

Parameters

$id : mixed = null

isSiteMultilingualEnabled()

Deprecated. Use FH::isMultiLinagual


    public
            static        isSiteMultilingualEnabled() : mixed

isTeamAdmin()

Determines if the user is a team admin


    public
            static        isTeamAdmin() : mixed

jconfig()

Renders Joomla's configuration object


    public
            static        jconfig() : mixed

load()

Loads a library file


    public
            static        load(mixed $file) : mixed

Parameters

$file : mixed

loadContentRouter()

Loads the necessary router file for com_content


    public
            static        loadContentRouter() : mixed

loadLanguages()

Loads the default languages for EasyBlog


    public
            static        loadLanguages([mixed $path = JPATH_ROOT ]) : mixed

Parameters

$path : mixed = JPATH_ROOT

loadModuleCss()

Deprecated


    public
            static        loadModuleCss() : mixed

loadServices()

Loads a list of services


    public
            static        loadServices() : mixed

location()

Proxy for location library.


    public
            static        location([mixed $provider = null ]) : mixed

Parameters

$provider : mixed = null

makeArray()

Converts an argument into an array.


    public
            static        makeArray(mixed $item[, mixed $delimeter = null ]) : mixed

Parameters

$item : mixed
$delimeter : mixed = null

makeFolder()

Detects if the folder exist based on the path given. If it doesn't exist, create it.


    public
            static        makeFolder(string $path) : bool

Parameters

$path : string: The path to the folder.

Return values

bool —

True if exists (after creation or before creation) and false otherwise.

math()

math lib


    public
            static        math() : mixed

mediamanager()

Proxy for media manager


    public
            static        mediamanager([mixed $source = EBLOG_MEDIA_SOURCE_LOCAL ]) : mixed

Parameters

$source : mixed = EBLOG_MEDIA_SOURCE_LOCAL

minifyCSS()

Deprecated. Use FH::minifyCss($css)


    public
            static        minifyCSS(mixed $css) : mixed

Parameters

$css : mixed

model()

Method to retrieve a model


    public
            static        model(mixed $name) : mixed

Parameters

$name : mixed

modules()

Render the modules library


    public
            static        modules(mixed $module) : mixed

Parameters

$module : mixed

normalize()

Deprecated. Rely on FD::normalize


    public
            static        normalize(mixed $data, mixed $key[, mixed $default = null ]) : mixed

Parameters

$data : mixed
$key : mixed
$default : mixed = null

normalizeSchema()

Converts characters to HTML entities for Schema structure data


    public
            static        normalizeSchema(mixed $schemaContent) : mixed

Parameters

$schemaContent : mixed

pagination()

Pagination for EasyBlog


    public
            static        pagination(mixed $total, mixed $limitstart, mixed $limit[, mixed $prefix = '' ]) : mixed

Parameters

$total : mixed
$limitstart : mixed
$limit : mixed
$prefix : mixed = ''

polls()

Creates a new instance of the Polls library.


    public
            static        polls(mixed $id) : mixed

Parameters

$id : mixed

populateCategories()

Generates a html code for category selection.


    public
            static        populateCategories(mixed $parentId, mixed $userId, mixed $outType, mixed $eleName, mixed $default[, mixed $isWrite = false ][, mixed $isPublishedOnly = false ][, mixed $isFrontendWrite = false ][, mixed $exclusion = array() ][, mixed $attributes = '' ][, mixed $defaultText = 'COM_EASYBLOG_SELECT_PARENT_CATEGORY' ][, mixed $customClass = '' ]) : mixed

Parameters

$parentId : mixed
$userId : mixed
$outType : mixed
$eleName : mixed
$default : mixed
$isWrite : mixed = false
$isPublishedOnly : mixed = false
$isFrontendWrite : mixed = false
$exclusion : mixed = array()
$attributes : mixed = ''
$defaultText : mixed = 'COM_EASYBLOG_SELECT_PARENT_CATEGORY'
$customClass : mixed = ''

populateCategoryFilter()

Generates a html code for category selection in backend


    public
            static        populateCategoryFilter(mixed $eleName[, mixed $catId = '' ][, mixed $attributes = '' ][, mixed $defaultText = 'COM_EASYBLOG_SELECT_A_CATEGORY' ][, mixed $className = '' ]) : mixed

Parameters

$eleName : mixed
$catId : mixed = ''
$attributes : mixed = ''
$defaultText : mixed = 'COM_EASYBLOG_SELECT_A_CATEGORY'
$className : mixed = ''

populateCategoryLinkage()

Retrieve backward linkage from a child category


    public
            static        populateCategoryLinkage(mixed $childId) : mixed

Parameters

$childId : mixed

post()

Proxy for post library


    public
            static        post([mixed $uid = null ][, mixed $revisionId = null ]) : mixed

Parameters

$uid : mixed = null
$revisionId : mixed = null

raiseWarning()

Method to display Joomla's core alert


    public
            static        raiseWarning(mixed $errCode, mixed $msg) : mixed

Parameters

$errCode : mixed
$msg : mixed

reactions()

Proxy for post library


    public
            static        reactions(EasyBlogPost $post) : mixed

Parameters

$post : EasyBlogPost

registry()

Returns a new registry object


    public
            static        registry([mixed $contents = '' ][, mixed $isFile = false ]) : mixed

Parameters

$contents : mixed = ''
$isFile : mixed = false

removeGallery()

Use EB::gallery()->removeGalleryCodes($text) instead


    public
            static        removeGallery(mixed $text) : mixed

Parameters

$text : mixed

renderModule()

Renders module in a template


    public
            static        renderModule(mixed $position[, mixed $attributes = array() ][, mixed $content = null ]) : mixed

Parameters

$position : mixed
$attributes : mixed = array()
$content : mixed = null

request()

Load the request library


    public
            static        request() : mixed

requireLogin()

Requires the user to be logged in


    public
            static        requireLogin() : mixed

sanitizeCsv()

Helper to sanitize comma separated values


    public
            static        sanitizeCsv(mixed $string[, mixed $type = 'integer' ]) : mixed

Parameters

$string : mixed
$type : mixed = 'integer'

scripts()

Render the scripts library


    public
            static        scripts([mixed $location = 'site' ]) : mixed

Parameters

$location : mixed = 'site'

setCallback()

Set callback url in joomla session


    public
            static        setCallback(mixed $data) : mixed

Parameters

$data : mixed

setCategoryTheme()

Set the current category theme


    public
            static        setCategoryTheme(mixed $theme) : mixed

Parameters

$theme : mixed

setMeta()

Allows caller to set the meta


    public
            static        setMeta(mixed $id, mixed $type[, mixed $defaultViewDesc = '' ][, mixed $pagination = null ]) : mixed

Parameters

$id : mixed
$type : mixed
$defaultViewDesc : mixed = ''
$pagination : mixed = null

setMetaData()

Alternative to setMeta


    public
            static        setMetaData(mixed $keywords, mixed $description) : mixed

Parameters

$keywords : mixed
$description : mixed

showLogin()


    public
            static        showLogin([mixed $return = '' ]) : mixed

Parameters

$return : mixed = ''

showSiteName()

Use FH::getSiteName() instead


    public
            static        showSiteName() : mixed

storeSession()


    public
            static        storeSession(mixed $data, mixed $key[, mixed $ns = 'COM_EASYBLOG' ]) : mixed

Parameters

$data : mixed
$key : mixed
$ns : mixed = 'COM_EASYBLOG'

stripEmbedTags()

This method searches for built in tags and strips them off. This should only be used when you are trying to output some data that doesn't contain html tags.


    public
            static        stripEmbedTags(mixed $content) : mixed

Parameters

$content : mixed

stylesheet()

Creates a new stylesheet instance


    public
            static        stylesheet(mixed $location[, mixed $name = null ][, mixed $useOverride = false ]) : mixed

Parameters

$location : mixed
$name : mixed = null
$useOverride : mixed = false

table()

Method to retrieve a table object


    public
            static        table(mixed $name) : mixed

Parameters

$name : mixed

template()

Deprecated. Use EB::themes


    public
            static        template([mixed $options = [] ]) : mixed

Parameters

$options : mixed = []

themes()

Creates a new theme instance


    public
            static        themes([mixed $options = [] ]) : mixed

Parameters

$options : mixed = []

token()

Retrieves the token


    public
            static        token() : mixed

triggerEvent()

Trigger Joomla events


    public
            static        triggerEvent(mixed $event, mixed &$row, mixed &$params, mixed $limitstart) : mixed

Parameters

$event : mixed
$row : mixed
$params : mixed
$limitstart : mixed

uniqueLinkSegments()


    public
            static        uniqueLinkSegments([mixed $urls = '' ]) : mixed

Parameters

$urls : mixed = ''

unsplash()

Creates a new instance of the Unsplash library.


    public
            static        unsplash() : mixed

uploadMediaAvatar()

Standard method to process uploaded avatars


    public
            static        uploadMediaAvatar(mixed $mediaType, mixed $mediaTable[, mixed $isFromBackend = false ][, mixed $inputName = 'Filedata' ]) : mixed

Parameters

$mediaType : mixed
$mediaTable : mixed
$isFromBackend : mixed = false
$inputName : mixed = 'Filedata'

user()

Method to retrieve a EasyBlogUser object


    public
            static        user([mixed $ids = null ][, mixed $debug = false ]) : mixed

Parameters

$ids : mixed = null
$debug : mixed = false

verifyBlogPassword()

Verifies the password for a post


    public
            static        verifyBlogPassword(mixed $crypt, mixed $id) : mixed

Parameters

$crypt : mixed
$id : mixed

EB in package EasyBlog

Table of Contents

Properties

Methods

Properties

$headersLoaded

$categoryTheme

Methods

_()

Parameters

Tags

__callStatic()

Parameters

Tags

accessCategoryLinkage()

Parameters

accessNestedCategories()

Parameters

accessNestedCategoriesId()

Parameters

acl()

Parameters

Tags

addCanonicalURL()

Parameters

Tags

ajax()

Tags

autoload()

Tags

blogimage()

Parameters

Tags

buildNestedCategories()

Parameters

cache()

Tags

call()

Parameters

Tags

category()

Tags

checkEnvironment()

Tags

checkToken()

clearSession()

Parameters

config()

Tags

date()

Parameters

Tags

db()

Tags

document()

Parameters

Tags

easydiscuss()

Tags

easysocial()

Tags

exception()

Parameters

Tags

EB
in package

EasyBlog