ZenpageCategory
extends ZenpageRoot
in package
zenpage news category class
Tags
Table of Contents
- $comments : mixed
- $exists : mixed
- $loaded : mixed
- $manage_rights : mixed
- $manage_some_rights : mixed
- $parent : mixed
- $parents : mixed
- $table : mixed
- $transient : mixed
- $view_rights : mixed
- $id : mixed
- $is_public : mixed
- $sortdirection : mixed
- $sortSticky : mixed
- $sorttype : mixed
- $cache_by : mixed
- $commentcount : mixed
- $data : mixed
- $tempdata : mixed
- $unique_set : mixed
- $updates : mixed
- $use_cache : mixed
- __construct() : mixed
- __toString() : string
- "Magic" function to return a string identifying the object when it is treated as a string
- addComment() : object
- Adds comments to the album assumes data is coming straight from GET or POST
- checkAccess() : mixed
- Checks if viewing of object is allowed
- checkChanges() : bool
- 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.
- checkForGuest() : mixed
- returns false (deny) if gallery is "private"
- checkforGuest() : mixed
- Checks if user is allowed to access news category
- checkPublishDates() : bool
- Checks if the item is either expired or needs to be scheduled published A class method wrapper of the functions.php function of the same name
- checkScheduledPublishing() : int
- Checks if the item has expired or is in scheduled publishing
- clearCache() : mixed
- Clears the object cache by setting it to an empty array completely or a specific object (class name) cache.
- clearObjectCache() : mixed
- Shortcut to clear the cache of the current object class only
- copy() : mixed
- 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.
- countHit() : mixed
- counts visits to the object
- get() : mixed
- Get the value of a variable. If $current is false, return the value as of the last save of this object.
- getArticle() : int
- Returns an article from the album based on the index passed.
- getArticles() : array<string|int, mixed>
- Gets news articles titlelinks this category is attached to
- getCategories() : array<string|int, mixed>
- Gets the sub categories recursivly by titlelink
- getCodeblock() : array<string|int, mixed>
- Returns the codeblocks as an serialized array
- getCommentCount() : int
- Returns the count of comments in the album. Ignores comments in moderation
- getComments() : array<string|int, mixed>
- Returns an array of comments for this album
- getCommentsAllowed() : bool
- Retuns true if comments are allowed
- getCustomData() : string
- returns the custom data field
- getData() : array<string|int, mixed>
- returns the database record of the object
- getDateTime() : int
- Returns the unformatted date
- getDefaultSortorder() : string
- Gets the default sortorder if a category
- getDesc() : string
- Returns the description
- getHitcounter() : int
- Returns the hitcount
- getID() : string
- Returns the id
- getIndex() : int
- Get the index of this article
- getLastChange() : string
- Returns the last change user
- getLastChangeUser() : string
- Returns the last change user
- getLink() : string
- Returns the full path to a news category
- getName() : string
- Returns the name (titlelink)
- getNextArticle() : object
- Returns the next article.
- getParent() : obj|null
- Gets the parent category object based on the parentid set
- getParentID() : string
- Returns the partent id
- getParents() : array<string|int, mixed>|null
- Gets the parent categories' titlelinks recursivly to the category
- getPassword() : mixed
- getPasswordHint() : mixed
- getPermalink() : string
- Returns the perma link status (only used on admin)
- getPrevArticle() : object
- Return the previous article
- getShow() : bool
- Returns true published
- getSortDirection() : mixed
- getSortOrder() : string
- Returns the sort order
- getSortSticky() : mixed
- getSortType() : mixed
- getSubCategories() : mixed
- getTags() : string
- Returns the tag data
- getTitle() : string
- Returns the title
- getTitlelink() : string
- Returns the titlelink
- getTotalArticles() : mixed
- Returns the articles count
- getTotalNewsPages() : mixed
- Gets the total news pages
- getUser() : mixed
- hasExpiration() : bool
- Returns true if the item will be automatically unpublished by a not yet reached future expire date
- hasExpired() : bool
- Returns true if the items has been unpublished after reaching the set expire date.
- hasExpireDate() : bool
- Returns true if the item has a proper expire date set no matter if it has expired already or will expire in the future
- hasFutureDate() : string
- Returns the future date (publishdate for gallery, date for Zenpage items) if set to the future only
- hasInactiveExpiration() : bool
- Returns true if a future expiredate is set but the item is unpublished
- hasInactivePublishSchedule() : bool
- Returns true if the item has a future date but is not published
- hasPublishSchedule() : bool
- Returns true if the item will be automatically published by a future date set
- hasTag() : bool
- Checks if an object has a tag assigned.
- instantiate() : bool
- }
- isMyItem() : mixed
- Checks if user is news author
- isProtected() : bool
- Checks if a category is protected and returns TRUE or FALSE
- isPublic() : bool
- Returns true if this category is published and also all of its parents.
- isPublished() : bool
- Returns true if the item itself is published
- isSubCategoryOf() : bool
- Checks if the current news category is a sub category of $catlink
- isSubNewsCategoryOf() : mixed
- move() : mixed
- Change one or more values of the unique set assigned to this record.
- remove() : mixed
- Deletes a category (and also if existing its subpages) from the database
- save() : mixed
- Save the updates made to this object since the last update. Returns true if successful, false if not.
- set() : mixed
- Set a variable in this object. Does not persist to the database until save() is called. So, IMPORTANT: Call save() after set() to persist.
- setCodeblock() : mixed
- set the codeblocks as an serialized array
- setCommentsAllowed() : mixed
- Sets the comments allowed flag
- setCustomData() : mixed
- Sets the custom data field
- setDateTime() : mixed
- Stores the date
- setDefaultSortorder() : mixed
- Sets a default sortorder for the category.
- setDesc() : mixed
- Stores the description
- setLastChange() : mixed
- stores the current date in the format 'Y-m-d H:i:s' as the last change date
- setLastchangeUser() : mixed
- stores the last change user
- setName() : mixed
- sets the name (title link)
- setParentID() : mixed
- Sets the ParentID field
- setPassword() : mixed
- Sets the encrypted password
- setPasswordHint() : mixed
- Sets the password hint
- setPermalink() : mixed
- setPublished() : mixed
- Stores the published value
- setShow() : mixed
- Stores the published value
- setSortDirection() : mixed
- setSortOrder() : mixed
- Stores the sort order
- setSortSticky() : mixed
- setSortType() : mixed
- setTags() : mixed
- Stores tag information
- setTitle() : mixed
- Stores the title
- setTitlelink() : mixed
- sets the title link
- setUser() : mixed
- Sets the guest user
- setDefaults() : mixed
- Sets default values for new objects using the set() method.
- addToCache() : mixed
- add the entry to the cache
- getFromCache() : mixed
- check the cache for presence of the entry and return it if found
- load() : false
- Load the data array from the database, using the unique id set to get the unique record.
Properties
$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
$view_rights
public
mixed
$view_rights
= \ALL_NEWS_RIGHTS
$id
protected
mixed
$id
= 0
$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
Methods
__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
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.
Tags
Return values
bool —checkForGuest()
returns false (deny) if gallery is "private"
public
checkForGuest([ &$hint = NULL ][, &$show = NULL ]) : mixed
Parameters
Return values
mixed —checkforGuest()
Checks if user is allowed to access news category
public
checkforGuest([ &$hint = NULL ][, &$show = NULL ]) : mixed
Parameters
Return values
mixed —checkPublishDates()
Checks if the item is either expired or needs to be scheduled published A class method wrapper of the functions.php function of the same name
public
checkPublishDates() : bool
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
Tags
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
Tags
Return values
mixed —clearObjectCache()
Shortcut to clear the cache of the current object class only
public
clearObjectCache() : mixed
Tags
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 ]) : 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
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
Tags
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.
Tags
Return values
string —getDesc()
Returns the description
public
getDesc([mixed $locale = NULL ]) : string
Parameters
- $locale : mixed = NULL
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
Tags
Return values
string —getLink()
Returns the full path to a news category
public
getLink([string $page = NULL ]) : string
Parameters
- $page : string = NULL
-
The category page number
Return values
string —getName()
Returns the name (titlelink)
public
getName() : string
Tags
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
Tags
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
Tags
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
Tags
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
Tags
Return values
string —getTotalArticles()
Returns the articles count
public
getTotalArticles() : mixed
Tags
Return values
mixed —getTotalNewsPages()
Gets the total news pages
public
getTotalNewsPages() : mixed
Tags
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
Tags
Return values
bool —hasExpired()
Returns true if the items has been unpublished after reaching the set expire date.
public
hasExpired() : bool
Tags
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
Tags
Return values
bool —hasFutureDate()
Returns the future date (publishdate for gallery, date for Zenpage items) if set to the future only
public
hasFutureDate() : string
Tags
Return values
string —| null
hasInactiveExpiration()
Returns true if a future expiredate is set but the item is unpublished
public
hasInactiveExpiration() : bool
Tags
Return values
bool —hasInactivePublishSchedule()
Returns true if the item has a future date but is not published
public
hasInactivePublishSchedule() : bool
Tags
Return values
bool —hasPublishSchedule()
Returns true if the item will be automatically published by a future date set
public
hasPublishSchedule() : bool
Tags
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) : mixed
Parameters
- $action : bit
-
what the caller wants to do
returns true of access is allowed
Return values
mixed —isProtected()
Checks if a category is protected and returns TRUE or FALSE
public
isProtected() : bool
Return values
bool —isPublic()
Returns true if this category is published and also all of its parents.
public
isPublic() : bool
Tags
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)
Tags
Return values
bool —isSubCategoryOf()
Checks if the current news category is a sub category of $catlink
public
isSubCategoryOf(mixed $catlink) : bool
Parameters
- $catlink : mixed
Tags
Return values
bool —isSubNewsCategoryOf()
public
isSubNewsCategoryOf(mixed $catlink) : mixed
Parameters
- $catlink : mixed
Tags
Return values
mixed —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.
Tags
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
Tags
Return values
mixed —setName()
sets the name (title link)
public
setName( $v) : mixed
Parameters
Tags
Return values
mixed —setParentID()
Sets the ParentID field
public
setParentID( $v) : mixed
Parameters
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
Tags
Return values
mixed —setShow()
Stores the published value
public
setShow(bool $show) : mixed
Parameters
- $show : bool
-
True if the album is published
Tags
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
Tags
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
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.