Documentation

Gallery
in package

Gallery

This class is used to publish the pictures of the gallery on the frontend.

Tags
copyright

CLOUDREXX CMS - CLOUDREXX AG

author

Cloudrexx Development Team info@cloudrexx.com

version
1.2
subpackage

module_gallery

todo

Edit PHP DocBlocks!

Table of Contents

Properties

$_objTpl  : mixed
$arrSettings  : mixed
$langId  : mixed
$pageContent  : mixed
$strCmd  : mixed
$strImagePath  : mixed
$strImageWebPath  : mixed
$strThumbnailPath  : mixed
$strThumbnailWebPath  : mixed

Methods

__construct()  : mixed
Constructor
addComment()  : mixed
Add a new comment to database
checkAccessToCategory()  : mixed
Check whether logged user has access to te given category, Redirect to no access when not having access
checkAuth()  : unknown
Check category authorisation
countVoting()  : mixed
Add a new voting to database
getCategoryTree()  : string
Shows the Category-Tree
getJavascript()  : mixed
Writes the javascript-function into the template
getPage()  : mixed
Reads the act and selects the right action
getPageAttributes()  : array<string|int, mixed>
Get Page title and description
getPictureDetailLink()  : string
Get picture details link of the picture
getPreviousAndNextPicture()  : array<string|int, mixed>
Get the previous and next picture id's
getSiblingList()  : mixed
Not unlike {@link getCategoryTree()}, but instead of a tree, this returns a list of siblings of the current gallery
parseCategoryTree()  : mixed
Parse the category tree into the given page template
parsePictureCommentsTab()  : null
Parse the comment details of the given picture
parsePictureVotingTab()  : null
Parse the voting details of the given picture
showCategoryOverview()  : mixed
Shows the Overview of categories
showPicture()  : mixed
Show the picture with the id $intPicId (with popup)
showPictureNoPop()  : mixed
Show picture in [[CONTENT]] (no popup is used)
categoryAllowsComments()  : bool
Are comments activated for the given category
categoryAllowsVoting()  : bool
Are comments activated for the given category
categoryIsProtected()  : unknown
Check if a category is marked 'protected'. Return the access id
getCategoryId()  : mixed

Properties

Methods

__construct()

Constructor

public __construct(mixed $pageContent) : mixed
Parameters
$pageContent : mixed
Tags
global

ADONewConnection

global

array

global

integer

addComment()

Add a new comment to database

public addComment() : mixed
Tags
global

ADONewConnection

global

Cache

checkAccessToCategory()

Check whether logged user has access to te given category, Redirect to no access when not having access

public checkAccessToCategory(mixed $categoryId) : mixed
Parameters
$categoryId : mixed

checkAuth()

Check category authorisation

public checkAuth(unknown_type $id) : unknown

Check if the user is permitted to access the current category

Parameters
$id : unknown_type
Return values
unknown

countVoting()

Add a new voting to database

public countVoting(mixed $intPicId, mixed $intMark) : mixed
Parameters
$intPicId : mixed
$intMark : mixed
Tags
global

ADONewConnection

global

Cache

getCategoryTree()

Shows the Category-Tree

public getCategoryTree() : string
Tags
global

array

global

ADONewConnection

Return values
string —

The category tree

getJavascript()

Writes the javascript-function into the template

public getJavascript() : mixed

getPage()

Reads the act and selects the right action

public getPage() : mixed

getPageAttributes()

Get Page title and description

public getPageAttributes() : array<string|int, mixed>
Return values
array<string|int, mixed> —

returns pagetitle and metadescription as array

getPictureDetailLink()

Get picture details link of the picture

public getPictureDetailLink(int $categoryId, int $pictureId) : string
Parameters
$categoryId : int

Category id

$pictureId : int

Picture id

Return values
string —

Link to the picture detail

getPreviousAndNextPicture()

Get the previous and next picture id's

public getPreviousAndNextPicture(int $categoryId, int $pictureId) : array<string|int, mixed>
Parameters
$categoryId : int

Category Id

$pictureId : int

Picture Id

Return values
array<string|int, mixed> —

Return's the previous and next picture of the given id

getSiblingList()

Not unlike {@link getCategoryTree()}, but instead of a tree, this returns a list of siblings of the current gallery

public getSiblingList() : mixed

parseCategoryTree()

Parse the category tree into the given page template

public parseCategoryTree(Sigma $template) : mixed
Parameters
$template : Sigma

Template instance

parsePictureCommentsTab()

Parse the comment details of the given picture

public parsePictureCommentsTab(Sigma $template, int $categoryId, int $pictureId) : null
Parameters
$template : Sigma

Template instance

$categoryId : int

Category id

$pictureId : int

Picture id

Return values
null

parsePictureVotingTab()

Parse the voting details of the given picture

public parsePictureVotingTab(Sigma $template, int $categoryId, int $pictureId) : null
Parameters
$template : Sigma

Template instance

$categoryId : int

Category id

$pictureId : int

Picture id

Return values
null

showCategoryOverview()

Shows the Overview of categories

public showCategoryOverview([int $intParentId = 0 ]) : mixed
Parameters
$intParentId : int = 0

showPicture()

Show the picture with the id $intPicId (with popup)

public showPicture(int $intPicId) : mixed
Parameters
$intPicId : int

The id of the picture which should be shown

showPictureNoPop()

Show picture in [[CONTENT]] (no popup is used)

public showPictureNoPop(int $intPicId) : mixed
Parameters
$intPicId : int

categoryAllowsComments()

Are comments activated for the given category

protected categoryAllowsComments(int $categoryId) : bool
Parameters
$categoryId : int

the category id

Return values
bool —

comments are activated

categoryAllowsVoting()

Are comments activated for the given category

protected categoryAllowsVoting(int $categoryId) : bool
Parameters
$categoryId : int

the category id

Return values
bool —

comments are activated

categoryIsProtected()

Check if a category is marked 'protected'. Return the access id

private categoryIsProtected(unknown_type $id[, mixed $type = "frontend" ]) : unknown
Parameters
$id : unknown_type
$type : mixed = "frontend"
Return values
unknown

getCategoryId()

private getCategoryId(mixed $id) : mixed
Parameters
$id : mixed 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results