Class ThemeObject

The basic ThemeObject class. Extends PersistentObject, is extended by various Theme related objects. Provides some basic methods that all use.

PersistentObject

ThemeObject

Direct known subclasses

MediaObject, ZenpageRoot

Indirect known subclasses

Album, AlbumBase, ZenpageCategory, ZenpageItems, ZenpageNews, ZenpagePage, AnyFile, dynamicAlbum, favorites, Image, TextObject, Transientimage, Video, WEBdocs

Package: classes
Located at classes.php

Methods summary
`public`	# `__construct( )` Class instantiator Class instantiator Overrides `PersistentObject::__construct()`
`public string`	# `getTitle( $locale = NULL )` Returns the title Returns the title Returns string
`public`	# `setTitle( string $title )` Stores the title Stores the title Parameters `$title` the title
`public string`	# `getParentID( )` Returns the partent id Returns the partent id Returns string
`public`	# `setParentID( $v )` Sets the ParentID field Sets the ParentID field Parameters `$v` of the parent
`public integer`	# `getHitcounter( )` Returns the hitcount Returns the hitcount Returns integer
`public`	# `countHit( )` counts visits to the object counts visits to the object
`public boolean`	# `getShow( )` Returns true published Returns true published Returns boolean
`public`	# `setShow( boolean $show )` Stores the published value Stores the published value Parameters `$show` True if the album is published
`public string`	# `getTags( )` Returns the tag data Returns the tag data Returns string
`public`	# `setTags( string $tags )` Stores tag information Stores tag information Parameters `$tags` the tag list
`public boolean`	# `hasTag( string $checktag )` Checks if an object has a tag assigned. Checks if an object has a tag assigned. Parameters `$checktag` tag to check for Returns boolean
`public integer`	# `getDateTime( )` Returns the unformatted date Returns the unformatted date Returns integer
`public`	# `setDateTime( string $datetime )` Stores the date Stores the date Parameters `$datetime` formatted date
`public array`	# `getCodeblock( )` Returns the codeblocks as an serialized array Returns the codeblocks as an serialized array Returns array
`public`	# `setCodeblock( $cb )` set the codeblocks as an serialized array set the codeblocks as an serialized array
`public string`	# `getCustomData( $locale = NULL )` returns the custom data field returns the custom data field Returns string
`public`	# `setCustomData( string $val )` Sets the custom data field Sets the custom data field Parameters `$val` the value to be put in custom_data
`public boolean`	# `getCommentsAllowed( )` Retuns true if comments are allowed Retuns true if comments are allowed Returns boolean
`public`	# `setCommentsAllowed( boolean $commentson )` Sets the comments allowed flag Sets the comments allowed flag Parameters `$commentson` true if they are allowed
`public array`	# `getComments( boolean $moderated = false, boolean $private = false, boolean $desc = false )` Returns an array of comments for this album Returns an array of comments for this album Parameters `$moderated` if false, ignores comments marked for moderation `$private` if false ignores private comments `$desc` set to true for descending order Returns array
`public object`	# `addComment( string $name, string $email, string $website, string $comment, string $code, string $code_ok, string $ip, boolean $private, boolean $anon, string $customdata )` Adds comments to the album assumes data is coming straight from GET or POST Adds comments to the album assumes data is coming straight from GET or POST Returns a comment object Parameters `$name` Comment author name `$email` Comment author email `$website` Comment author website `$comment` body of the comment `$code` CAPTCHA code entered `$code_ok` CAPTCHA hash expected `$ip` the IP address of the comment poster `$private` set to true if the comment is for the admin only `$anon` set to true if the poster wishes to remain anonymous `$customdata` Returns object
`public integer`	# `getCommentCount( )` Returns the count of comments in the album. Ignores comments in moderation Returns the count of comments in the album. Ignores comments in moderation Returns integer
`public`	# `isMyItem( bit $action )` Checks basic access rights of an object Checks basic access rights of an object Parameters `$action` what the caller wants to do
`public`	# `checkForGuest( & $hint = NULL, & $show = NULL )` returns false (deny) if gallery is "private" returns false (deny) if gallery is "private" Parameters `$hint` `$show`
`public`	# `checkAccess( string & $hint = NULL, string & $show = NULL )` Checks if viewing of object is allowed Parameters `$hint` `$show`
`public boolean`	# `checkPublishDates( )` Checks if the item is either expired or in scheduled publishing A class method wrapper of the functions.php function of the same name Checks if the item is either expired or in scheduled publishing A class method wrapper of the functions.php function of the same name Returns boolean

Methods inherited from PersistentObject
`__toString(), copy(), get(), getData(), getID(), instantiate(), move(), remove(), save(), set(), setDefaults()`

Properties summary
`public`	`$comments`	# `NULL`
`public`	`$manage_rights`	# `ADMIN_RIGHTS`
`public`	`$manage_some_rights`	# `ADMIN_RIGHTS`
`public`	`$view_rights`	# `VIEW_ALL_RIGHTS`

Properties inherited from PersistentObject
`$exists, $id, $loaded, $table, $transient`

Packages

Classes

Functions

Class ThemeObject

Direct known subclasses

Indirect known subclasses

Overrides

Returns

Parameters

Returns

Parameters

Returns

Returns

Parameters

Returns

Parameters

Parameters

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Parameters

Parameters

Returns

Parameters

Returns

Returns

Parameters

Parameters

Parameters

Returns