Docs For Class Blog

Class Overview

Blog

Blog object with params

Located in /blogs/inc/MODEL/collections/_blog.class.php [line 56]

DataObject
   |
   --Blog

Author(s):

Information Tags:

Version:

beta

Properties

Methods

[ Top ]

Inherited Properties, Constants, and Methods

Inherited Properties	Inherited Methods	Inherited Constants
Inherited From DataObject DataObject::$delete_cascades DataObject::$delete_restrictions DataObject::$ID	Inherited From DataObject DataObject::DataObject() Constructor DataObject::check_delete() Check relations for restrictions before deleting DataObject::check_relations() Check relations for restrictions or cascades DataObject::confirm_delete() Displays form to confirm deletion of this object DataObject::dbchange() Records a change that will need to be updated in the db DataObject::dbdelete() Delete object from DB. DataObject::dbinsert() Insert object into DB based on previously recorded changes. DataObject::dbsave() Inserts or Updates depending on object state. DataObject::dbupdate() Update the DB based on previously recorded changes DataObject::dget() Get a ready-to-display member param by its name DataObject::disp() Display a member param by its name DataObject::get() Get a member param by its name DataObject::history_info_icon() Create icon with dataobject history DataObject::ID() Template function: Displays object ID. DataObject::set() Set param value DataObject::set_from_Request() Set a parameter from a Request form value. DataObject::set_param() Set param value.

Inherited Properties

Inherited Methods

Inherited Constants

Inherited From DataObject

DataObject::$delete_cascades

DataObject::$delete_restrictions

DataObject::$ID

Inherited From DataObject

DataObject::DataObject()

Constructor

DataObject::check_delete()

Check relations for restrictions before deleting

DataObject::check_relations()

Check relations for restrictions or cascades

DataObject::confirm_delete()

Displays form to confirm deletion of this object

DataObject::dbchange()

Records a change that will need to be updated in the db

DataObject::dbdelete()

Delete object from DB.

DataObject::dbinsert()

Insert object into DB based on previously recorded changes.

DataObject::dbsave()

Inserts or Updates depending on object state.

DataObject::dbupdate()

Update the DB based on previously recorded changes

DataObject::dget()

Get a ready-to-display member param by its name

DataObject::disp()

Display a member param by its name

DataObject::get()

Get a member param by its name

DataObject::history_info_icon()

Create icon with dataobject history

DataObject::ID()

Template function: Displays object ID.

DataObject::set()

Set param value

DataObject::set_from_Request()

Set a parameter from a Request form value.

DataObject::set_param()

Set param value.

[ Top ]

Property Summary

mixed	$access_type
mixed	$allowblogcss
mixed	$allowcomments
mixed	$allowpingbacks
mixed	$allowtrackbacks
mixed	$allowusercss
CollectionSettings	$CollectionSettings	Additional settings for the collection
mixed	$default_skin
mixed	$disp_bloglist
mixed	$force_skin
mixed	$in_bloglist
mixed	$keywords
mixed	$links_blog_ID
mixed	$locale
mixed	$longdesc
mixed	$media_fullpath
mixed	$media_location
mixed	$media_subdir
mixed	$media_url
string	$name	Complete name
mixed	$notes
mixed	$pingb2evonet
mixed	$pingblodotgs
mixed	$pingtechnorati
mixed	$pingweblogs
mixed	$shortdesc
string	$shortname	Short name for use in navigation menus
mixed	$siteurl
mixed	$staticfilename
mixed	$stub
string	$tagline	Tagline to be displayed on template
mixed	$UID
mixed	$urlname

[ Top ]

Method Summary

Blog	Blog()	Constructor
void	dbdelete()	Delete a blog and dependencies from database
void	dbupdate()	Update the DB based on previously recorded changes
void	gen_blogurl()	Generate blog URL
false\|string	get()	Get a param.
mixed	get_media_dir()	Get the blog's media directory (and create it if necessary).
string	get_media_url()	Get the URL to the media folder
string\|false\|NULL	get_setting()	Get a setting.
void	load_CollectionSettings()
void	name()	Template function: display name of blog
void	name_return()	Template function: return name of item
boolean	set()	Set param value
void	setMediaFullPath()	Set the full path of the media folder
void	setMediaSubDir()	Set the media folder's subdir
void	setMediaUrl()	Set the full URL of the media folder
boolean	set_setting()	Set a setting.

[ Top ]

Properties

mixed $access_type [line 79]

[ Top ]

mixed $allowblogcss = 0 [line 90]

[ Top ]

mixed $allowcomments = 'post_by_post' [line 87]

[ Top ]

mixed $allowpingbacks = 0 [line 89]

[ Top ]

mixed $allowtrackbacks = 0 [line 88]

[ Top ]

mixed $allowusercss = 0 [line 91]

[ Top ]

CollectionSettings $CollectionSettings [line 113]

Additional settings for the collection

Any non vital params should go into there (this includes many of the above).

[ Top ]

mixed $default_skin [line 96]

[ Top ]

mixed $disp_bloglist = 1 [line 98]

[ Top ]

mixed $force_skin = 0 [line 97]

[ Top ]

mixed $in_bloglist = 1 [line 99]

[ Top ]

mixed $keywords [line 86]

[ Top ]

mixed $links_blog_ID = 0 [line 84]

[ Top ]

mixed $locale [line 78]

[ Top ]

mixed $longdesc [line 77]

[ Top ]

mixed $media_fullpath = '' [line 103]

[ Top ]

mixed $media_location = 'default' [line 101]

[ Top ]

mixed $media_subdir = '' [line 102]

[ Top ]

mixed $media_url = '' [line 104]

[ Top ]

string $name [line 68]

Complete name

[ Top ]

mixed $notes [line 85]

[ Top ]

mixed $pingb2evonet = 0 [line 92]

[ Top ]

mixed $pingblodotgs = 0 [line 95]

[ Top ]

mixed $pingtechnorati = 0 [line 93]

[ Top ]

mixed $pingweblogs = 1 [line 94]

[ Top ]

mixed $shortdesc [line 76]

[ Top ]

string $shortname [line 62]

Short name for use in navigation menus

[ Top ]

mixed $siteurl [line 80]

[ Top ]

mixed $staticfilename [line 81]

[ Top ]

mixed $stub [line 82]

[ Top ]

string $tagline [line 74]

Tagline to be displayed on template

[ Top ]

mixed $UID [line 100]

[ Top ]

mixed $urlname [line 83]

[ Top ]

Methods

Constructor Blog [line 121]

Blog Blog(
[object DB
$db_row = NULL] 
)

Constructor

Parameters:

object DB

$db_row:

row

[ Top ]

dbdelete [line 666]

void dbdelete(
[boolean
$delete_stub_file = false], [boolean
$delete_static_file = false], [boolean
$echo = false] 
)

Delete a blog and dependencies from database

Includes WAY TOO MANY requests because we try to be compatible with MySQL 3.23, bleh!

Parameters:

boolean	$delete_stub_file:	true if you want to try to delete the stub file
boolean	$delete_static_file:	true if you want to try to delete the static file
boolean	$echo:	true if you want to echo progress

Redefinition of:

DataObject::dbdelete(): Delete object from DB.

[ Top ]

dbupdate [line 640]

void dbupdate(
)

Update the DB based on previously recorded changes

Redefinition of:

DataObject::dbupdate(): Update the DB based on previously recorded changes

[ Top ]

gen_blogurl [line 266]

void gen_blogurl(
[string
$type = 'default'], [boolean
$absolute = true] 
)

Generate blog URL

Parameters:

string	$type:	default\|dynamic\|static
boolean	$absolute:	should this be an absolute URL? (otherwise: relative to $baseurl)

[ Top ]

get [line 442]

false|string get(

$parname 
)

Get a param.

Parameters:

$parname:

API Tags:

Return:

The value as string or false in case of error (e.g. media dir is disabled).

Redefinition of:

DataObject::get(): Get a member param by its name

[ Top ]

get_media_dir [line 334]

mixed get_media_dir(
)

Get the blog's media directory (and create it if necessary).

If we're on an admin page, it adds status messages.

API Tags:

Return:

the path as string on success, false if the dir could not be created

Information Tags:

Todo:

These status messages should rather go to a "syslog" and not be displayed to a normal user

[ Top ]

get_media_url [line 407]

string get_media_url(
)

Get the URL to the media folder

API Tags:

Return:

the URL

[ Top ]

get_setting [line 607]

string|false|NULL get_setting(

$parname 
)

Get a setting.

Parameters:

$parname:

API Tags:

Return:

value as string on success; NULL if not found; false in case of error

[ Top ]

load_CollectionSettings [line 627]

void load_CollectionSettings(
)

[ Top ]

name [line 804]

void name(
[string
$format = 'htmlbody'], [
$disp = true] 
)

Template function: display name of blog

Parameters:

string	$format:	Output format, see format_to_output()
	$disp:

[ Top ]

name_return [line 822]

void name_return(
[string
$format = 'htmlbody'] 
)

Template function: return name of item

Parameters:

string

$format:

Output format, see format_to_output()

[ Top ]

set [line 227]

boolean set(
string
$parname, 
$parvalue 
)

Set param value

Parameters:

string	$parname:	Parameter name
	$parvalue:

API Tags:

Return:

true, if a value has been set; false if it has not changed

Redefinition of:

DataObject::set(): Set param value

[ Top ]

setMediaFullPath [line 204]

void setMediaFullPath(
string
$path 
)

Set the full path of the media folder

Parameters:

string

$path:

the full path

[ Top ]

setMediaSubDir [line 193]

void setMediaSubDir(
string
$path 
)

Set the media folder's subdir

Parameters:

string

$path:

the subdirectory

[ Top ]

setMediaUrl [line 215]

void setMediaUrl(
string
$url 
)

Set the full URL of the media folder

Parameters:

string

$url:

the full URL

[ Top ]

set_setting [line 619]

boolean set_setting(

$parname, 
$value 
)

Set a setting.

Parameters:

	$parname:
	$value:

API Tags:

Return:

true, if the value has been set, false if it has not changed.

[ Top ]

Multilingual multiuser multiblog engine

Class: Blog

Class Blog

Packages

Classes

Files