

[ class tree: classes ] [ index: classes ] [ all elements ]

Class: ThemeObject

Source Location: /classes.php

Class ThemeObject

Class Overview

The basic ThemeObject class. Extends PersistentObject, is extended by various Theme related objects.

Provides some basic methods that all use.

Located in /classes.php [line 385]

PersistentObject
   |
   --ThemeObject

Properties

Methods

[ Top ]

Descendants

Child Class	Description
MediaObject	Root class for images and albums
ZenpageRoot	Base class from which all Zenpage classes derive

[ Top ]

Inherited Properties, Constants, and Methods

Inherited Properties

Inherited Methods

Inherited Constants

Inherited From PersistentObject

PersistentObject::$cache_by

PersistentObject::$data

PersistentObject::$id

PersistentObject::$loaded

PersistentObject::$table

PersistentObject::$tempdata

PersistentObject::$transient

PersistentObject::$unique_set

PersistentObject::$updates

PersistentObject::$use_cache

Inherited From PersistentObject

PersistentObject::PersistentObject()

Prime instantiator for Zenphoto objects

PersistentObject::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.

PersistentObject::get()

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

PersistentObject::getID()

Returns the id

PersistentObject::move()

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

PersistentObject::remove()

Deletes object from the database

PersistentObject::save()

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

PersistentObject::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.

PersistentObject::setDefaults()

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

[ Top ]

Property Summary

mixed	$commentcount
mixed	$comments
mixed	$manage_rights
mixed	$manage_some_rights
mixed	$view_rights

[ Top ]

Method Summary

ThemeObject	__construct()	Class instantiator
object	addComment()	Adds comments to the album assumes data is coming straight from GET or POST
void	checkAccess()	Checks if viewing of object is allowed
void	checkForGuest()	returns false (deny) if gallery is "private"
void	countHit()	counts visits to the object
array	getCodeblock()	Returns the codeblocks as an serialized array
int	getCommentCount()	Returns the count of comments in the album. Ignores comments in moderation
array	getComments()	Returns an array of comments for this album
bool	getCommentsAllowed()	Retuns true if comments are allowed
string	getCustomData()	returns the custom data field
int	getDateTime()	Returns the unformatted date
int	getHitcounter()	Returns the hitcount
string	getParentID()	Returns the partent id
bool	getShow()	Returns true published
string	getTags()	Returns the tag data
string	getTitle()	Returns the title
bool	hasTag()	Checks if an object has a tag assigned.
void	isMyItem()	Checks basic access rights of an object
void	setCodeblock()	set the codeblocks as an serialized array
void	setCommentsAllowed()	Sets the comments allowed flag
void	setCustomData()	Sets the custom data field
void	setDateTime()	Stores the date
void	setParentID()	Sets the ParentID field
void	setShow()	Stores the published value
void	setTags()	Stores tag information
void	setTitle()	Stores the title

[ Top ]

Properties

mixed $commentcount [line 388]

[ Top ]

mixed $comments = NULL [line 387]

[ Top ]

mixed $manage_rights = ADMIN_RIGHTS [line 389]

Redefined in descendants as:

[ Top ]

mixed $manage_some_rights = ADMIN_RIGHTS [line 390]

Redefined in descendants as:

[ Top ]

mixed $view_rights = VIEW_ALL_RIGHTS [line 391]

Redefined in descendants as:

[ Top ]

Methods

Constructor __construct [line 396]

ThemeObject __construct(
)

Class instantiator

Redefined in descendants as:

MediaObject::__construct() : Class instantiator
Album::__construct() : Constructor for albums
Transientimage::__construct() : creates a transient image (that is, one that is not stored in the database)
TextObject::__construct() : creates a textobject (image standin)
AnyFile::__construct() : creates a WEBdocs (image standin)
WEBdocs::__construct() : creates a WEBdocs (image standin)
Video::__construct() : Constructor for class-video
ZenpageCategory::__construct()
ZenpageItems::__construct() : Class instantiator
ZenpageNews::__construct()
ZenpagePage::__construct()

[ Top ]

addComment [line 620]

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

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

Returns a comment object

Parameters:

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

[ Top ]

checkAccess [line 674]

void checkAccess(
[
&$hint = NULL], [
&$show = NULL], unknown_type
$hint, unknown_type
$show 
)

Checks if viewing of object is allowed

Parameters:

unknown_type	$hint:
unknown_type	$show:
	&$hint:
	&$show:

Redefined in descendants as:

_Image::checkAccess() : returns true if user is allowed to see the image

[ Top ]

checkForGuest [line 664]

void checkForGuest(
[$hint
&$hint = NULL], [$show
&$show = NULL] 
)

returns false (deny) if gallery is "private"

Parameters:

$hint	&$hint:
$show	&$show:

[ Top ]

countHit [line 445]

void countHit(
)

counts visits to the object

[ Top ]

getCodeblock [line 533]

array getCodeblock(
)

Returns the codeblocks as an serialized array

[ Top ]

getCommentCount [line 630]

int getCommentCount(
)

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

[ Top ]

getComments [line 585]

array getComments(
[bool
$moderated = false], [bool
$private = false], [bool
$desc = false] 
)

Returns an array of comments for this album

Parameters:

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

[ Top ]

getCommentsAllowed [line 566]

bool getCommentsAllowed(
)

Retuns true if comments are allowed

[ Top ]

getCustomData [line 550]

string getCustomData(
)

returns the custom data field

[ Top ]

getDateTime [line 511]

int getDateTime(
)

Returns the unformatted date

[ Top ]

getHitcounter [line 438]

int getHitcounter(
)

Returns the hitcount

[ Top ]

getParentID [line 421]

string getParentID(
)

Returns the partent id

[ Top ]

getShow [line 455]

bool getShow(
)

Returns true published

[ Top ]

getTags [line 478]

string getTags(
)

Returns the tag data

[ Top ]

getTitle [line 405]

string getTitle(
)

Returns the title

[ Top ]

hasTag [line 501]

bool hasTag(
string
$checktag 
)

Checks if an object has a tag assigned.

Parameters:

string

$checktag:

tag to check for

[ Top ]

isMyItem [line 646]

void isMyItem(
bit
$action 
)

Checks basic access rights of an object

Parameters:

bit

$action:

what the caller wants to do

Redefined in descendants as:

Album::isMyItem() : checks access to the album
_Image::isMyItem()
ZenpageCategory::isMyItem()
ZenpageNews::isMyItem() : Checks if user is news author
ZenpagePage::isMyItem() : Checks if user is author of page

[ Top ]

setCodeblock [line 541]

void setCodeblock(

$cb 
)

set the codeblocks as an serialized array

Parameters:

$cb:

[ Top ]

setCommentsAllowed [line 573]

void setCommentsAllowed(
bool
$commentson 
)

Sets the comments allowed flag

Parameters:

bool

$commentson:

true if they are allowed

[ Top ]

setCustomData [line 559]

void setCustomData(
string
$val 
)

Sets the custom data field

Parameters:

string

$val:

the value to be put in custom_data

[ Top ]

setDateTime [line 518]

void setDateTime(
string
$datetime 
)

Stores the date

Parameters:

string

$datetime:

formatted date

[ Top ]

setParentID [line 429]

void setParentID(
$v
$v 
)

Sets the ParentID field

Parameters:

$v:

id of the parent

[ Top ]

setShow [line 464]

void setShow(
bool
$show 
)

Stores the published value

Parameters:

bool

$show:

True if the album is published

[ Top ]

setTags [line 487]

void setTags(
string
$tags 
)

Stores tag information

Parameters:

string

$tags:

the tag list

[ Top ]

setTitle [line 414]

void setTitle(
string
$title 
)

Stores the title

Parameters:

string

$title:

the title

[ Top ]

classes

Packages:

core
admin
classes
functions
GoogleMapAPI
JSMin
OpenID
PHPMailer
plugins
Services_JSON

Files:

class-album.php
class-comment.php
class-gallery.php
class-image.php
class-search.php
class-transientimage.php
class-video.php
classes.php
lib-auth.php

Classes:

Album
Comment
Gallery
MediaObject
PersistentObject
SearchEngine
ThemeObject
Transientimage
Video
VideoObject_Options
Zenphoto_Administrator
Zenphoto_Authority
_Image

Documentation generated on Tue, 20 Dec 2011 16:07:03 +0100 by phpDocumentor 1.4.3

RSS feeds!

Social networks

Join the Google Groups!

zenphoto-announce
Release announcements and security alerts only (no support)
Subscribe right here:

Email:
Zenphoto Translate
Support and discussion for translators only

Zenphoto

Class: ThemeObject