ZenphotoCMS 1.6.1

ZenpageCategory extends ZenpageRoot
in package

zpcore

plugins

zenpage

classes

zenpage news category class

$comments


    public
        mixed
    $comments
     = \NULL

$exists


    public
        mixed
    $exists
     = \false

$loaded


    public
        mixed
    $loaded
     = \false

$manage_rights


    public
        mixed
    $manage_rights
     = \MANAGE_ALL_NEWS_RIGHTS

$manage_some_rights


    public
        mixed
    $manage_some_rights
     = \ZENPAGE_NEWS_RIGHTS

$parent


    public
        mixed
    $parent
     = \null

$parents


    public
        mixed
    $parents
     = \null

$table


    public
        mixed
    $table

$transient


    public
        mixed
    $transient

$urparent


    public
        mixed
    $urparent
     = \null

$view_rights


    public
        mixed
    $view_rights
     = \ALL_NEWS_RIGHTS

$id


    protected
        mixed
    $id
     = 0

$is_protected


    protected
        mixed
    $is_protected
     = \null

$is_public


    protected
        mixed
    $is_public
     = \null

$sortdirection


    protected
        mixed
    $sortdirection
     = \true

$sortSticky


    protected
        mixed
    $sortSticky
     = \true

$sorttype


    protected
        mixed
    $sorttype
     = 'date'

$cache_by


    private
        mixed
    $cache_by

$commentcount


    private
        mixed
    $commentcount

$data


    private
        mixed
    $data
     = \NULL

$tempdata


    private
        mixed
    $tempdata
     = \NULL

$unique_set


    private
        mixed
    $unique_set
     = \NULL

$updates


    private
        mixed
    $updates
     = \NULL

$use_cache


    private
        mixed
    $use_cache
     = \false

__construct()


    public
                    __construct(mixed $catlink[, mixed $create = NULL ]) : mixed

Parameters

$catlink : mixed
$create : mixed = NULL

Return values

mixed —

__toString()

"Magic" function to return a string identifying the object when it is treated as a string


    public
                    __toString() : string

Return values

string —

addComment()

Adds comments to the album assumes data is coming straight from GET or POST


    public
                    addComment(string $name, string $email, string $website, string $comment, string $code, string $code_ok, string $ip, bool $private, bool $anon, string $customdata, bool $dataconfirmation) : object

Returns a comment object

Parameters

$name : string: Comment author name
$email : string: Comment author email
$website : string: Comment author website
$comment : string: body of the comment
$code : string: CAPTCHA code entered
$code_ok : string: CAPTCHA hash expected
$ip : string: the IP address of the comment poster
$private : bool: set to true if the comment is for the admin only
$anon : bool: set to true if the poster wishes to remain anonymous
$customdata : string
$dataconfirmation : bool: true or false if data privacy confirmation was required

Return values

object —

checkAccess()

Checks if viewing of object is allowed by rights or protection status


    public
                    checkAccess([string &$hint = NULL ][, string &$show = NULL ]) : mixed

Parameters

$hint : string = NULL
$show : string = NULL

Return values

mixed —

checkChanges()

By default the object is saved if there are any updates within the property `$updates` no matter if these are actual changes to existing data.


    public
                    checkChanges([bool $update = true ]) : bool

This checks that and internally updates the $updates property with the actual changes obky so you optionally can skip unnecessary object saves.

Standard object fields lastchange and lastchangeuser are exclude because lastchange always changes and both make no sense if there is no actual content change at all.

This can be used before calling the save() method or enabled within the save() method optionally

Parameters

$update : bool = true: True (default) to also update the $updates property with changes found or clear it. False to only check for changes.

Return values

bool —

checkForGuest()

Checks if the item is password protected and if the password has been entered


    public
                    checkForGuest([ &$hint = NULL ][,  &$show = NULL ]) : mixed

Parameters

$hint : = NULL
$show : = NULL

Return values

mixed —

checkforGuest()

Checks if user is allowed to access news category


    public
                    checkforGuest([ &$hint = NULL ][,  &$show = NULL ]) : mixed

Parameters

$hint : = NULL
$show : = NULL

Return values

mixed —

checkPublishDates()

Checks if the item is either expired or needs to be scheduled published


    public
                    checkPublishDates() : bool

Unpublishes the item if expired (saves to db) or scheduled (temporary) and returns false if expired or scheduled.

Return values

bool —

checkScheduledPublishing()

Checks if the item has expired or is in scheduled publishing


    public
            static        checkScheduledPublishing(array<string|int, mixed> $row) : int

Returns 1 if expired, 2 if in scheduled future publishing

Parameters

$row : array<string|int, mixed>: database row of the object

Return values

int —

clearCache()

Clears the object cache by setting it to an empty array completely or a specific object (class name) cache.


    public
            static        clearCache([mixed $class = null ]) : mixed

Note: You normally never need to use this. But on certain occasions it may be necessary to avoid memory issues if you loop through a lot of object creations.

Parameters

$class : mixed = null

Return values

mixed —

clearObjectCache()

Shortcut to clear the cache of the current object class only


    public
                    clearObjectCache() : mixed

Return values

mixed —

copy()

Copy this record to another unique set. Checks if the record exists there first, if so returns false. If successful returns true. No changes are made to this object and no other objects are created, just the database entry.


    public
                    copy(mixed $new_unique_set) : mixed

A call to copy is instant, it does not require a save() following it.

Parameters

$new_unique_set : mixed

Return values

mixed —

countHit()

counts visits to the object


    public
                    countHit() : mixed

Return values

mixed —

get()

Get the value of a variable. If $current is false, return the value as of the last save of this object.


    public
                    get(mixed $var[, mixed $current = true ]) : mixed

Parameters

$var : mixed
$current : mixed = true

Return values

mixed —

getArticle()

Returns an article from the album based on the index passed.


    public
                    getArticle(int $index[, mixed $published = NULL ][, mixed $sortorder = 'date' ][, mixed $sortdirection = 'desc' ][, mixed $sticky = true ]) : int

Parameters

$index : int
$published : mixed = NULL
$sortorder : mixed = 'date'
$sortdirection : mixed = 'desc'
$sticky : mixed = true

Return values

int —

getArticles()

Gets news articles titlelinks this category is attached to


    public
                    getArticles(int $articles_per_page[, string $published = NULL ][, bool $ignorepagination = false ][, string $sortorder = NULL ][, string $sortdirection = NULL ][, bool $sticky = NULL ][, string $author = null ][, string|null|false $date = false ]) : array<string|int, mixed>

NOTE: Since this function only returns titlelinks for use with the object model it does not exclude articles that are password protected via a category

Parameters

$articles_per_page : int: The number of articles to get
$published : string = NULL: "published" for published articles, "published-unpublished" for published articles only from an unpublished category, "unpublished" for unpublished articles, "sticky" for sticky articles (published or not!) for Admin page use only, "all" for all articles
$ignorepagination : bool = false: Since also used for the news loop this function automatically paginates the results if the "page" GET variable is set. To avoid this behaviour if using it directly to get articles set this TRUE (default FALSE)
$sortorder : string = NULL: "date" (default), "title", "popular", "mostrated", "toprated", "random" This parameter is not used for date archives
$sortdirection : string = NULL: "asc" or "desc" for ascending or descending order This parameter is not used for date archives
$sticky : bool = NULL: set to true to place "sticky" articles at the front of the list.
$author : string = null: Optional author name to get the article of
$date : string|null|false = false: Date YYYY-mm format for a date archive, null uses global theme date archive context, false (default) to disable date archive context

Return values

array<string|int, mixed> —

getCategories()

Gets the sub categories recursivly by titlelink


    public
                    getCategories([bool $visible = true ][, string $sorttype = NULL ][, bool $sortdirection = NULL ][, bool $directchilds = true ]) : array<string|int, mixed>

Parameters

$visible : bool = true: TRUE for published and unprotected
$sorttype : string = NULL: NULL for the standard order as sorted on the backend, "title", "date", "popular"
$sortdirection : bool = NULL: True for descending (default), false for ascending direction
$directchilds : bool = true: Default true to get only the direct sub level pages, set to false to get all levels

Return values

array<string|int, mixed> —

getCodeblock()

Returns the codeblocks as an serialized array


    public
                    getCodeblock() : array<string|int, mixed>

Return values

array<string|int, mixed> —

getCommentCount()

Returns the count of comments in the album. Ignores comments in moderation


    public
                    getCommentCount() : int

Return values

int —

getComments()

Returns an array of comments for this album


    public
                    getComments([bool $moderated = false ][, bool $private = false ][, bool $desc = false ]) : array<string|int, mixed>

Parameters

$moderated : bool = false: if false, ignores comments marked for moderation
$private : bool = false: if false ignores private comments
$desc : bool = false: set to true for descending order

Return values

array<string|int, mixed> —

getCommentsAllowed()

Retuns true if comments are allowed


    public
                    getCommentsAllowed() : bool

Return values

bool —

getCustomData()

returns the custom data field


    public
                    getCustomData([mixed $locale = NULL ]) : string

Parameters

$locale : mixed = NULL

Return values

string —

getData()

returns the database record of the object


    public
                    getData() : array<string|int, mixed>

Return values

array<string|int, mixed> —

getDateTime()

Returns the unformatted date


    public
                    getDateTime() : int

Return values

int —

getDefaultSortorder()

Gets the default sortorder if a category


    public
                    getDefaultSortorder() : string

Use this before save()

a) If you created an new item after you set a parentid and no new specific sortorder b) You updated the parentid without setting specific new sortorder

The sortorder takes care of existing categories on the level and adds the item after existing ones.

Return values

string —

getDesc()

Returns the description


    public
                    getDesc([mixed $locale = NULL ]) : string

Parameters

$locale : mixed = NULL

Return values

string —

getExpireDate()

Returns the expired date if available,


    public
                    getExpireDate() : string

Return values

string —

getHitcounter()

Returns the hitcount


    public
                    getHitcounter() : int

Return values

int —

getID()

Returns the id


    public
                    getID() : string

Return values

string —

getIndex()

Get the index of this article


    public
                    getIndex(mixed $sortorder, mixed $sortdirection, mixed $sticky) : int

Parameters

$sortorder : mixed
$sortdirection : mixed
$sticky : mixed

Return values

int —

getLastChange()

Returns the last change user


    public
                    getLastChange() : string

Return values

string —

getLastChangeUser()

Returns the last change user


    public
                    getLastChangeUser() : string

Return values

string —

getLevel()

Gets the level based on the sort order if the theme object is hierachical. Otherwise returns 1 (top level)


    public
                    getLevel() : int

Return values

int —

getLink()

Returns the full path to a news category


    public
                    getLink([string $page = NULL ][, string $path = null ]) : string

Parameters

$page : string = NULL: The category page number
$path : string = null: Default null, optionally pass a path constant like WEBPATH or FULLWEBPATH

Return values

string —

getName()

Returns the name (titlelink)


    public
                    getName() : string

Return values

string —

getNextArticle()

Returns the next article.


    public
                    getNextArticle([mixed $sortorder = 'date' ][, mixed $sortdirection = 'desc' ][, mixed $sticky = true ]) : object

Parameters

$sortorder : mixed = 'date'
$sortdirection : mixed = 'desc'
$sticky : mixed = true

Return values

object —

getParent()

Gets the parent category object based on the parentid set


    public
                    getParent() : obj|null

Return values

obj|null —

getParentID()

Returns the partent id


    public
                    getParentID() : string

Return values

string —

getParents()

Gets the parent categories' titlelinks recursivly to the category


    public
                    getParents() : array<string|int, mixed>|null

Return values

array<string|int, mixed>|null —

getPassword()


    public
                    getPassword() : mixed

Return values

mixed —

getPasswordHint()


    public
                    getPasswordHint([mixed $locale = NULL ]) : mixed

Parameters

$locale : mixed = NULL

Return values

mixed —

getPermalink()

Returns the perma link status (only used on admin)


    public
                    getPermalink() : string

Return values

string —

getPrevArticle()

Return the previous article


    public
                    getPrevArticle([mixed $sortorder = 'date' ][, mixed $sortdirection = 'desc' ][, mixed $sticky = true ]) : object

Parameters

$sortorder : mixed = 'date'
$sortdirection : mixed = 'desc'
$sticky : mixed = true

Return values

object —

getShow()

Returns true published


    public
                    getShow() : bool

Return values

bool —

getSortDirection()


    public
                    getSortDirection() : mixed

Return values

mixed —

getSortOrder()

Returns the sort order


    public
                    getSortOrder() : string

Return values

string —

getSortSticky()


    public
                    getSortSticky() : mixed

Return values

mixed —

getSortType()


    public
                    getSortType() : mixed

Return values

mixed —

getSubCategories()


    public
                    getSubCategories([mixed $visible = true ][, mixed $sorttype = NULL ][, mixed $sortdirection = NULL ][, mixed $directchilds = false ]) : mixed

Parameters

$visible : mixed = true
$sorttype : mixed = NULL
$sortdirection : mixed = NULL
$directchilds : mixed = false

Return values

mixed —

getTags()

Returns the tag data


    public
                    getTags() : string

Return values

string —

getTitle()

Returns the title


    public
                    getTitle([mixed $locale = NULL ]) : string

Parameters

$locale : mixed = NULL

Return values

string —

getTitlelink()

Returns the titlelink


    public
                    getTitlelink() : string

Return values

string —

getTotalArticles()

Returns the articles count


    public
                    getTotalArticles() : mixed

Return values

mixed —

getTotalNewsPages()

Gets the total news pages


    public
                    getTotalNewsPages() : mixed

Return values

mixed —

getUrParent()

Gets the object of the oldest ancester of the page or category. Returns the object of the page/category itself if there is no urparent


    public
                    getUrParent() : mixed

Return values

mixed —

getUser()


    public
                    getUser() : mixed

Return values

mixed —

hasExpiration()

Returns true if the item will be automatically unpublished by a not yet reached future expire date


    public
                    hasExpiration() : bool

Return values

bool —

hasExpired()

Returns true if the items has been unpublished after reaching the set expire date.


    public
                    hasExpired() : bool

Return values

bool —

hasExpireDate()

Returns true if the item has a proper expire date set no matter if it has expired already or will expire in the future


    public
                    hasExpireDate() : bool

Return values

bool —

hasFutureDate()

Returns the future date (publishdate for gallery, date for Zenpage items) if set to the future only


    public
                    hasFutureDate() : string

Return values

string —

| null

hasInactiveExpiration()

Returns true if a future expiredate is set but the item is unpublished


    public
                    hasInactiveExpiration() : bool

Return values

bool —

hasInactivePublishSchedule()

Returns true if the item has a future date but is not published


    public
                    hasInactivePublishSchedule() : bool

Return values

bool —

hasPublishSchedule()

Returns true if the item will be automatically published by a future date set


    public
                    hasPublishSchedule() : bool

Return values

bool —

hasTag()

Checks if an object has a tag assigned.


    public
                    hasTag(string $checktag) : bool

Parameters

$checktag : string: tag to check for

Return values

bool —

instantiate()

}


    public
                    instantiate( $tablename,  $unique_set[,  $cache_by = NULL ][,  $use_cache = true ][,  $is_transient = false ][,  $allowCreate = true ]) : bool

Prime instantiator for Zenphoto objects

Parameters

$tablename :: The name of the database table
$unique_set :: An array of unique fields
$cache_by : = NULL
$use_cache : = true
$is_transient : = false: Set true to prevent database insertion
$allowCreate : = true: Set true to allow a new object to be made.

Return values

bool —

will be true if the unique_set does not already exist

isMyItem()

Checks if user is news author


    public
                    isMyItem([bit $action = LIST_RIGHTS ]) : mixed

Parameters

$action : bit = LIST_RIGHTS: User rights level, default LIST_RIGHTS

returns true of access is allowed

Return values

mixed —

isProtected()

Checks if the item is password protected. Checks if the password has been entered *


    public
                    isProtected() : bool

Return values

bool —

isProtectedByParent()

Returns true if not protected but protection is inherited by a parent


    public
                    isProtectedByParent() : bool

Return values

bool —

isPublic()

Returns true if this category is published and also all of its parents.


    public
                    isPublic() : bool

Return values

bool —

isPublished()

Returns true if the item itself is published


    public
                    isPublished([bool $use_dbvalue = false ]) : bool

Parameters

$use_dbvalue : bool = false: Set to true to use the actual db value stored and not the possibly temporary modified value (e.g. if in scheduled publishing or expiration)

Return values

bool —

isSubCategoryOf()

Checks if the current news category is a sub category of $catlink


    public
                    isSubCategoryOf(mixed $catlink) : bool

Parameters

$catlink : mixed

Return values

bool —

isSubNewsCategoryOf()


    public
                    isSubNewsCategoryOf(mixed $catlink) : mixed

Parameters

$catlink : mixed

Return values

mixed —

isUnpublishedByParent()

Returns true if itself published but unpublished status is inheretited by a parent


    public
                    isUnpublishedByParent() : bool

Return values

bool —

isVisible()

Checks if the current item is visible (= listed) to the current visitor via rights, publish status or protection status


    public
                    isVisible([bit $action = LIST_RIGHTS ]) : bool

Convenience wrapper for various methods.

Parameters

$action : bit = LIST_RIGHTS: User rights level, default LIST_RIGHTS

Return values

bool —

move()

Change one or more values of the unique set assigned to this record.


    public
                    move(mixed $new_unique_set) : mixed

Checks if the record already exists first, if so returns false. If successful returns true and changes $this->unique_set A call to move is instant, it does not require a save() following it.

Parameters

$new_unique_set : mixed

Return values

mixed —

remove()

Deletes a category (and also if existing its subpages) from the database


    public
                    remove() : mixed

Return values

mixed —

save()

Save the updates made to this object since the last update. Returns true if successful, false if not.


    public
                    save([bool $checkupdates = false ]) : mixed

Parameters

$checkupdates : bool = false: Default false. If true the internal $updates property is checked for actual changes so unnecessary saving is skipped. Applies to already existing objects only.

Return values

mixed —

set()

Set a variable in this object. Does not persist to the database until save() is called. So, IMPORTANT: Call save() after set() to persist.


    public
                    set(mixed $var, mixed $value) : mixed

If the requested variable is not in the database, sets it in temp storage, which won't be persisted to the database.

Parameters

$var : mixed
$value : mixed

Return values

mixed —

setCodeblock()

set the codeblocks as an serialized array


    public
                    setCodeblock(mixed $cb) : mixed

Parameters

$cb : mixed

Return values

mixed —

setCommentsAllowed()

Sets the comments allowed flag


    public
                    setCommentsAllowed(bool $commentson) : mixed

Parameters

$commentson : bool: true if they are allowed

Return values

mixed —

setCustomData()

Sets the custom data field


    public
                    setCustomData(string $val) : mixed

Parameters

$val : string: the value to be put in custom_data

Return values

mixed —

setDateTime()

Stores the date


    public
                    setDateTime(string $datetime) : mixed

Parameters

$datetime : string: formatted date

Return values

mixed —

setDefaultSortorder()

Sets a default sortorder for the category.


    public
                    setDefaultSortorder() : mixed

Use this before save()

a) If you created an new item after you set a parentid and no new specific sortorder b) You updated the parentid without setting specific new sortorder

The sortorder takes care of existing categories on the level and adds the item after existing ones.

Return values

mixed —

setDesc()

Stores the description


    public
                    setDesc(string $desc) : mixed

Parameters

$desc : string: description text

Return values

mixed —

setLastChange()

stores the current date in the format 'Y-m-d H:i:s' as the last change date


    public
                    setLastChange() : mixed

Return values

mixed —

setLastchangeUser()

stores the last change user


    public
                    setLastchangeUser(mixed $a) : mixed

Parameters

$a : mixed

Return values

mixed —

setName()

sets the name (title link)


    public
                    setName( $v) : mixed

Parameters

$v :

Return values

mixed —

setParentID()

Sets the ParentID field


    public
                    setParentID( $v) : mixed

Parameters

$v :: id of the parent

Return values

mixed —

setPassword()

Sets the encrypted password


    public
                    setPassword(string $pwd) : mixed

Parameters

$pwd : string: the cleartext password

Return values

mixed —

setPasswordHint()

Sets the password hint


    public
                    setPasswordHint(string $hint) : mixed

Parameters

$hint : string: the hint text

Return values

mixed —

setPermalink()


    public
                    setPermalink(mixed $v) : mixed

Parameters

$v : mixed

Return values

mixed —

setPublished()

Stores the published value


    public
                    setPublished(bool $published) : mixed

Parameters

$published : bool: True if the item is published

Return values

mixed —

setShow()

Stores the published value


    public
                    setShow(bool $show) : mixed

Parameters

$show : bool: True if the album is published

Return values

mixed —

setSortDirection()


    public
                    setSortDirection(mixed $value) : mixed

Parameters

$value : mixed

Return values

mixed —

setSortOrder()

Stores the sort order


    public
                    setSortOrder(string $sortorder) : mixed

Parameters

$sortorder : string: image sort order

Return values

mixed —

setSortSticky()


    public
                    setSortSticky(mixed $value) : mixed

Parameters

$value : mixed

Return values

mixed —

setSortType()


    public
                    setSortType(mixed $value) : mixed

Parameters

$value : mixed

Return values

mixed —

setTags()

Stores tag information


    public
                    setTags(string $tags) : mixed

Parameters

$tags : string: the tag list

Return values

mixed —

setTitle()

Stores the title


    public
                    setTitle(string $title) : mixed

Parameters

$title : string: the title

Return values

mixed —

setTitlelink()

sets the title link


    public
                    setTitlelink( $v) : mixed

Parameters

$v :

Return values

mixed —

setUser()

Sets the guest user


    public
                    setUser(string $user) : mixed

Parameters

$user : string

Return values

mixed —

setDefaults()

Sets default values for new objects using the set() method.


    protected
                    setDefaults() : mixed

Should do nothing in the base class; subclasses should override.

Return values

mixed —

addToCache()

add the entry to the cache


    private
                    addToCache( $entry) : mixed

Parameters

$entry :

Return values

mixed —

getFromCache()

check the cache for presence of the entry and return it if found


    private
                    getFromCache() : mixed

Return values

mixed —

load()

Load the data array from the database, using the unique id set to get the unique record.


    private
                    load(bool $allowCreate) : false

Parameters

$allowCreate : bool: set to true to enable new object creation.

Return values

false —

if the record already exists, true if a new record was created.

ZenpageCategory extends ZenpageRoot in package zpcore plugins zenpage classes

Tags

Table of Contents

Properties

$comments

$exists

$loaded

$manage_rights

$manage_some_rights

$parent

$parents

$table

$transient

$urparent

$view_rights

$id

$is_protected

$is_public

$sortdirection

$sortSticky

$sorttype

$cache_by

$commentcount

$data

$tempdata

$unique_set

$updates

$use_cache

Methods

__construct()

Parameters

Return values

__toString()

Return values

addComment()

Parameters

Return values

checkAccess()

Parameters

Return values

checkChanges()

Parameters

Tags

Return values

checkForGuest()

Parameters

Return values

checkforGuest()

Parameters

Return values

checkPublishDates()

Return values

checkScheduledPublishing()

Parameters

Tags

Return values

clearCache()

Parameters

Tags

Return values

clearObjectCache()

Tags

Return values

copy()

Parameters

Return values

countHit()

Return values

get()

Parameters

Return values

getArticle()

Parameters

Return values

getArticles()

Parameters

Return values

getCategories()

Parameters

Tags

ZenpageCategory extends ZenpageRoot
in package

zpcore

plugins

zenpage

classes