ACTIONS Class Reference

Inheritance diagram for ACTIONS:

List of all members.

Public Member Functions

ACTIONS ($type)

setSkin (&$skin)

setParser (&$parser)

doForm ($filename)

checkCondition ($field, $name='', $value= '')

_ifHasPlugin ($name, $value)

_ifPlugin ($name, $key= '', $value= '')

_ifCategory ($name= '', $value='')

_ifOnTeam ($blogName= '')

_ifAdmin ($blogName= '')

_link ($url, $linktext= '')

_searchlink ($maxresults, $startpos, $direction, $linktext= '')

_itemlink ($id, $linktext= '')

_archivelink ($id, $linktext= '')

_setBlogCategory (&$blog, $catname)

_preBlogContent ($type, &$blog)

_postBlogContent ($type, &$blog)

parse_additemform ()

parse_adminurl ()

parse_archive ($template, $category= '')

parse_archivedate ($locale= '-def-')

parse_archivedaylist ($template, $category= 'all', $limit=0)

parse_archivelink ($linktext= '')

parse_archivelist ($template, $category= 'all', $limit=0)

parse_archivetype ()

parse_blog ($template, $amount=10, $category= '')

parse_bloglist ($template, $bnametype= '')

parse_blogsetting ($which)

parse_callback ($eventName, $type)

parse_category ($type= 'name')

parse_categorylist ($template, $blogname= '')

parse_charset ()

parse_commentform ($destinationurl= '')

parse_comments ($template)

parse_errordiv ()

parse_errormessage ()

parse_formdata ($what)

parse_ifcat ($text= '')

parse_image ($what= 'imgtag')

parse_imagetext ()

parse_item ($template)

parse_itemid ()

parse_itemlink ($linktext= '')

parse_itemtitle ($format= '')

parse_loginform ()

parse_member ($what)

parse_membermailform ($rows=10, $cols=40, $desturl= '')

parse_nextarchive ()

parse_nextitem ()

parse_nextitemtitle ($format= '')

parse_nextlink ($linktext= '', $amount=10)

parse_nucleusbutton ($imgurl= '', $imgwidth= '85', $imgheight= '31')

parse_otherarchive ($blogname, $template, $category= '')

parse_otherarchivedaylist ($blogname, $template, $category= 'all', $limit=0)

parse_otherarchivelist ($blogname, $template, $category= 'all', $limit=0)

parse_otherblog ($blogname, $template, $amount=10, $category= '')

parse_othersearchresults ($blogname, $template, $maxresults=50)

parse_plugin ($pluginName)

parse_prevarchive ()

parse_preview ($template)

parse_previtem ()

parse_previtemtitle ($format= '')

parse_prevlink ($linktext= '', $amount=10)

parse_query ()

parse_referer ()

parse_searchform ($blogname= '')

parse_searchresults ($template, $maxresults=50)

parse_self ()

parse_sitevar ($which)

parse_skinname ()

parse_skintype ()

parse_text ($which)

parse_ticket ()

parse_todaylink ($linktext= '')

parse_vars ()

parse_version ()

Public Attributes

$skintype

$linkparams

$skin

$formdata

$amountfound

Detailed Description

This class contains the functions that get called by using the special tags in the skins

The allowed tags for a type of skinpart are defined by the SKIN::getAllowedActionsForType($type) method

Version:

Id: ACTIONS.php 1141 2007-05-10 08:10:26Z kimitake

Version:

NucleusJP: ACTIONS.php,v 1.8.2.1 2007/08/08 05:17:54 kimitake Exp

Definition at line 25 of file ACTIONS.php.

Member Function Documentation

ACTIONS::ACTIONS ( $ type )

Constructor for a new ACTIONS object

Definition at line 49 of file ACTIONS.php.

References $catid, and BaseActions::BaseActions().

ACTIONS::setSkin ( &$ skin )

Set the skin

Definition at line 63 of file ACTIONS.php.

References $skin.

ACTIONS::setParser ( &$ parser )

Set the parser

Definition at line 70 of file ACTIONS.php.

References BaseActions::$parser.

ACTIONS::doForm ( $ filename )

Forms get parsedincluded now, using an extra <formdata> skinvar

Definition at line 77 of file ACTIONS.php.

References $DIR_NUCLEUS, PARSER::getProperty(), BaseActions::parse_parsedinclude(), and PARSER::setProperty().

Referenced by parse_additemform(), parse_commentform(), parse_loginform(), parse_membermailform(), parse_nucleusbutton(), and parse_searchform().

ACTIONS::checkCondition	(	$	field,
		$	name = `''`,
		$	value = `''`
	)

Checks conditions for if statements

Parameters:

	string	$field type of <if%>
	string	$name property of field
	string	$value value of property

Definition at line 101 of file ACTIONS.php.

References $catid, $manager, $member, _ifAdmin(), _ifCategory(), _ifHasPlugin(), _ifOnTeam(), and _ifPlugin().

ACTIONS::_ifHasPlugin	(	$	name,
		$	value
	)

hasplugin,PlugName -> checks if plugin exists hasplugin,PlugName,OptionName -> checks if the option OptionName from plugin PlugName is not set to 'no' hasplugin,PlugName,OptionName=value -> checks if the option OptionName from plugin PlugName is set to value

Definition at line 154 of file ACTIONS.php.

References $manager.

Referenced by checkCondition().

ACTIONS::_ifPlugin	(	$	name,
		$	key = `''`,
		$	value = `''`
	)

Checks if a plugin exists and call its doIf function

Definition at line 179 of file ACTIONS.php.

References $manager.

Referenced by checkCondition().

ACTIONS::_ifCategory	(	$	name = `''`,
		$	value = `''`
	)

Different checks for a category

Definition at line 194 of file ACTIONS.php.

References $catid.

Referenced by checkCondition().

ACTIONS::_ifOnTeam ( $ blogName = '' )

Checks if a member is on the team of a blog and return his rights

Definition at line 218 of file ACTIONS.php.

References $blogid, $manager, $member, and getBlogIDFromName().

Referenced by checkCondition().

ACTIONS::_ifAdmin ( $ blogName = '' )

Checks if a member is admin of a blog

Definition at line 239 of file ACTIONS.php.

References $blogid, $manager, $member, and getBlogIDFromName().

Referenced by checkCondition().

ACTIONS::_link	(	$	url,
		$	linktext = `''`
	)

returns either

a raw link (html/xml encoded) when no linktext is provided
a (x)html <a href... link when a text is present (text htmlencoded)

Definition at line 262 of file ACTIONS.php.

Referenced by _archivelink(), _itemlink(), _searchlink(), parse_archivelink(), and parse_todaylink().

ACTIONS::_searchlink	(	$	maxresults,
		$	startpos,
		$	direction,
		$	linktext = `''`
	)

Outputs a next/prev link

Parameters:

	$maxresults	The maximum amount of items shown per page (e.g. 10)
	$startpos	Current start position (requestVar('startpos'))
	$direction	either 'prev' or 'next'
	$linktext	When present, the output will be a full <a href...> link. When empty, only a raw link will be outputted

Definition at line 286 of file ACTIONS.php.

References $amount, $CONF, $maxresults, $query, $startpos, _link(), alterQueryStr(), quickQuery(), and serverVar().

Referenced by parse_nextlink(), and parse_prevlink().

ACTIONS::_itemlink	(	$	id,
		$	linktext = `''`
	)

Creates an item link and if no id is given a todaylink

Definition at line 335 of file ACTIONS.php.

References $CONF, _link(), createItemLink(), and parse_todaylink().

Referenced by parse_itemlink(), parse_nextlink(), and parse_prevlink().

ACTIONS::_archivelink	(	$	id,
		$	linktext = `''`
	)

Creates an archive link and if no id is given a todaylink

Definition at line 346 of file ACTIONS.php.

References $CONF, _link(), createArchiveLink(), and parse_todaylink().

Referenced by parse_nextlink(), and parse_prevlink().

ACTIONS::_setBlogCategory	(	&$	blog,
		$	catname
	)

Helper function that sets the category that a blog will need to use

Parameters:

	$blog	An object of the blog class, passed by reference (we want to make changes to it)
	$catname	The name of the category to use

Definition at line 362 of file ACTIONS.php.

References $catid.

Referenced by parse_archive(), parse_archivedaylist(), parse_archivelist(), parse_blog(), parse_item(), parse_otherarchive(), parse_otherarchivedaylist(), parse_otherarchivelist(), parse_otherblog(), parse_othersearchresults(), and parse_searchresults().

ACTIONS::_preBlogContent	(	$	type,
		&$	blog
	)

Notifies the Manager that a PreBlogContent event occurs

Definition at line 373 of file ACTIONS.php.

References $manager.

Referenced by parse_archive(), parse_archivedaylist(), parse_archivelist(), parse_blog(), parse_categorylist(), parse_item(), parse_otherarchive(), parse_otherarchivedaylist(), parse_otherarchivelist(), parse_otherblog(), parse_othersearchresults(), and parse_searchresults().

ACTIONS::_postBlogContent	(	$	type,
		&$	blog
	)

Notifies the Manager that a PostBlogContent event occurs

Definition at line 381 of file ACTIONS.php.

References $manager.

Referenced by parse_archive(), parse_archivedaylist(), parse_archivelist(), parse_blog(), parse_categorylist(), parse_item(), parse_otherarchive(), parse_otherarchivedaylist(), parse_otherarchivelist(), parse_otherblog(), parse_othersearchresults(), and parse_searchresults().

ACTIONS::parse_additemform ( )

Parse skinvar additemform

Definition at line 389 of file ACTIONS.php.

References $CONF, and doForm().

ACTIONS::parse_adminurl ( )

Parse skinvar adminurl (shortcut for admin url)

Definition at line 403 of file ACTIONS.php.

References parse_sitevar().

ACTIONS::parse_archive	(	$	template,
		$	category = `''`
	)

Parse skinvar archive

Definition at line 410 of file ACTIONS.php.

References $archive, _postBlogContent(), _preBlogContent(), and _setBlogCategory().

ACTIONS::parse_archivedate ( $ locale = '-def-' )

archivedate(locale,date format)%

Definition at line 424 of file ACTIONS.php.

References $archive.

ACTIONS::parse_archivedaylist	(	$	template,
		$	category = `'all'`,
		$	limit = `0`
	)

Parse skinvar archivedaylist

Definition at line 455 of file ACTIONS.php.

References _postBlogContent(), _preBlogContent(), and _setBlogCategory().

ACTIONS::parse_archivelink ( $ linktext = '' )

A link to the archives for the current blog (or for default blog)

Definition at line 467 of file ACTIONS.php.

References $CONF, _link(), and createArchiveListLink().

ACTIONS::parse_archivelist	(	$	template,
		$	category = `'all'`,
		$	limit = `0`
	)

Definition at line 475 of file ACTIONS.php.

References _postBlogContent(), _preBlogContent(), and _setBlogCategory().

ACTIONS::parse_archivetype ( )

Parse skinvar archivetype

Definition at line 487 of file ACTIONS.php.

ACTIONS::parse_blog	(	$	template,
		$	amount = `10`,
		$	category = `''`
	)

Parse skinvar blog

Definition at line 495 of file ACTIONS.php.

References $amount, $startpos, _postBlogContent(), _preBlogContent(), and _setBlogCategory().

ACTIONS::parse_bloglist	(	$	template,
		$	bnametype = `''`
	)

Definition at line 510 of file ACTIONS.php.

References BLOG::showBlogList().

ACTIONS::parse_blogsetting ( $ which )

Parse skinvar blogsetting

Definition at line 517 of file ACTIONS.php.

ACTIONS::parse_callback	(	$	eventName,
		$	type
	)

Parse callback

Definition at line 541 of file ACTIONS.php.

References $manager.

ACTIONS::parse_category ( $ type = 'name' )

Parse skinvar category

Definition at line 550 of file ACTIONS.php.

References $catid.

ACTIONS::parse_categorylist	(	$	template,
		$	blogname = `''`
	)

Parse categorylist

Definition at line 571 of file ACTIONS.php.

References $manager, _postBlogContent(), _preBlogContent(), and getBlogIDFromName().

ACTIONS::parse_charset ( )

Parse skinvar charset

Definition at line 589 of file ACTIONS.php.

ACTIONS::parse_commentform ( $ destinationurl = '' )

Parse skinvar commentform

Definition at line 596 of file ACTIONS.php.

References $CONF, $DIR_LIBS, $errormessage, $itemid, $manager, $member, ACTIONLOG::add(), cookieVar(), createLink(), doForm(), and postVar().

ACTIONS::parse_comments ( $ template )

Parse skinvar comments include comments for one item

Definition at line 667 of file ACTIONS.php.

References $actions, $highlight, $itemid, $manager, BaseActions::$parser, and ITEM::getitem().

ACTIONS::parse_errordiv ( )

Parse errordiv

Definition at line 687 of file ACTIONS.php.

References $errormessage.

ACTIONS::parse_errormessage ( )

Parse skinvar errormessage

Definition at line 696 of file ACTIONS.php.

References $errormessage.

ACTIONS::parse_formdata ( $ what )

Parse formdata

Definition at line 704 of file ACTIONS.php.

ACTIONS::parse_ifcat ( $ text = '' )

Parse ifcat

Definition at line 711 of file ACTIONS.php.

References $catid, and BaseActions::parse_if().

ACTIONS::parse_image ( $ what = 'imgtag' )

Parse skinvar image

Definition at line 726 of file ACTIONS.php.

References $CONF, $imagepopup, intRequestVar(), and requestVar().

ACTIONS::parse_imagetext ( )

Parse skinvar imagetext

Definition at line 760 of file ACTIONS.php.

References requestVar().

ACTIONS::parse_item ( $ template )

Parse skinvar item include one item (no comments)

Definition at line 768 of file ACTIONS.php.

References $highlight, $itemid, _postBlogContent(), _preBlogContent(), and _setBlogCategory().

ACTIONS::parse_itemid ( )

Parse skinvar itemid

Definition at line 781 of file ACTIONS.php.

References $itemid.

ACTIONS::parse_itemlink ( $ linktext = '' )

Parse skinvar itemlink

Definition at line 789 of file ACTIONS.php.

References $itemid, and _itemlink().

ACTIONS::parse_itemtitle ( $ format = '' )

Parse itemtitle

Definition at line 797 of file ACTIONS.php.

References $itemid, $manager, stringToAttribute(), and stringToXML().

ACTIONS::parse_loginform ( )

Parse skinvar loginform

Definition at line 820 of file ACTIONS.php.

References $CONF, $member, and doForm().

ACTIONS::parse_member ( $ what )

Parse skinvar member (includes a member info thingie)

Definition at line 838 of file ACTIONS.php.

References $member.

ACTIONS::parse_membermailform	(	$	rows = `10`,
		$	cols = `40`,
		$	desturl = `''`
	)

Parse skinvar membermailform

Definition at line 896 of file ACTIONS.php.

References $CONF, $member, $memberid, createMemberLink(), doForm(), and postVar().

ACTIONS::parse_nextarchive ( )

Parse skinvar nextarchive

Definition at line 931 of file ACTIONS.php.

ACTIONS::parse_nextitem ( )

Parse skinvar nextitem (include itemid of next item)

Definition at line 940 of file ACTIONS.php.

ACTIONS::parse_nextitemtitle ( $ format = '' )

Parse skinvar nextitemtitle (include itemtitle of next item)

Definition at line 949 of file ACTIONS.php.

References stringToAttribute(), and stringToXML().

ACTIONS::parse_nextlink	(	$	linktext = `''`,
		$	amount = `10`
	)

Parse skinvar nextlink

Definition at line 971 of file ACTIONS.php.

References $amount, $startpos, _archivelink(), _itemlink(), and _searchlink().

ACTIONS::parse_nucleusbutton	(	$	imgurl = `''`,
		$	imgwidth = `'85'`,
		$	imgheight = `'31'`
	)

Parse skinvar nucleusbutton

Definition at line 984 of file ACTIONS.php.

References $CONF, doForm(), and PARSER::getProperty().

ACTIONS::parse_otherarchive	(	$	blogname,
		$	template,
		$	category = `''`
	)

Parse skinvar otherarchive

Definition at line 1006 of file ACTIONS.php.

References $archive, $manager, _postBlogContent(), _preBlogContent(), _setBlogCategory(), and getBlogIDFromName().

ACTIONS::parse_otherarchivedaylist	(	$	blogname,
		$	template,
		$	category = `'all'`,
		$	limit = `0`
	)

Parse skinvar otherarchivedaylist

Definition at line 1019 of file ACTIONS.php.

References $manager, _postBlogContent(), _preBlogContent(), _setBlogCategory(), and getBlogIDFromName().

ACTIONS::parse_otherarchivelist	(	$	blogname,
		$	template,
		$	category = `'all'`,
		$	limit = `0`
	)

Parse skinvar otherarchivelist

Definition at line 1032 of file ACTIONS.php.

References $manager, _postBlogContent(), _preBlogContent(), _setBlogCategory(), and getBlogIDFromName().

ACTIONS::parse_otherblog	(	$	blogname,
		$	template,
		$	amount = `10`,
		$	category = `''`
	)

Parse skinvar otherblog

Definition at line 1045 of file ACTIONS.php.

References $amount, $manager, _postBlogContent(), _preBlogContent(), _setBlogCategory(), and getBlogIDFromName().

ACTIONS::parse_othersearchresults	(	$	blogname,
		$	template,
		$	maxresults = `50`
	)

Parse skinvar othersearchresults

Definition at line 1060 of file ACTIONS.php.

References $amount, $manager, $maxresults, $query, $startpos, _postBlogContent(), _preBlogContent(), _setBlogCategory(), and getBlogIDFromName().

ACTIONS::parse_plugin ( $ pluginName )

Executes a plugin skinvar

Parameters:

pluginName

name of plugin (without the NP_)

extra parameters can be added

Definition at line 1076 of file ACTIONS.php.

References $manager.

ACTIONS::parse_prevarchive ( )

Parse skinvar prevarchive

Definition at line 1101 of file ACTIONS.php.

ACTIONS::parse_preview ( $ template )

Parse skinvar preview

Definition at line 1109 of file ACTIONS.php.

References $CONF, $manager, and TEMPLATE::fill().

ACTIONS::parse_previtem ( )

Definition at line 1127 of file ACTIONS.php.

ACTIONS::parse_previtemtitle ( $ format = '' )

Parse skinvar previtemtitle (include itemtitle of prev item)

Definition at line 1136 of file ACTIONS.php.

References stringToAttribute(), and stringToXML().

ACTIONS::parse_prevlink	(	$	linktext = `''`,
		$	amount = `10`
	)

Parse skinvar prevlink

Definition at line 1158 of file ACTIONS.php.

References $amount, $startpos, _archivelink(), _itemlink(), and _searchlink().

ACTIONS::parse_query ( )

Parse skinvar query (includes the search query)

Definition at line 1173 of file ACTIONS.php.

References $query.

ACTIONS::parse_referer ( )

Parse skinvar referer

Definition at line 1181 of file ACTIONS.php.

References serverVar().

ACTIONS::parse_searchform ( $ blogname = '' )

Parse skinvar searchform

Definition at line 1188 of file ACTIONS.php.

References $CONF, $manager, $maxresults, doForm(), getBlogIDFromName(), and getVar().

ACTIONS::parse_searchresults	(	$	template,
		$	maxresults = `50`
	)

Parse skinvar searchresults

Definition at line 1206 of file ACTIONS.php.

References $amount, $maxresults, $query, $startpos, _postBlogContent(), _preBlogContent(), and _setBlogCategory().

ACTIONS::parse_self ( )

Parse skinvar self

Definition at line 1218 of file ACTIONS.php.

References $CONF.

ACTIONS::parse_sitevar ( $ which )

Parse skinvar sitevar (include a sitevar)

Definition at line 1227 of file ACTIONS.php.

References $CONF.

Referenced by parse_adminurl().

ACTIONS::parse_skinname ( )

Parse skinname

Definition at line 1247 of file ACTIONS.php.

ACTIONS::parse_skintype ( )

Parse skintype (experimental)

Definition at line 1254 of file ACTIONS.php.

ACTIONS::parse_text ( $ which )

Parse text

Definition at line 1261 of file ACTIONS.php.

ACTIONS::parse_ticket ( )

Parse ticket

Definition at line 1271 of file ACTIONS.php.

References $manager.

ACTIONS::parse_todaylink ( $ linktext = '' )

Parse skinvar todaylink A link to the today page (depending on selected blog, etc...)

Definition at line 1280 of file ACTIONS.php.

References $CONF, _link(), and createBlogidLink().

Referenced by _archivelink(), and _itemlink().

ACTIONS::parse_vars ( )

Parse vars When commentform is not used, to include a hidden field with itemid

Definition at line 1292 of file ACTIONS.php.

References $itemid.

ACTIONS::parse_version ( )

Parse skinvar version (include nucleus versionnumber)

Definition at line 1301 of file ACTIONS.php.

References $nucleus.

Member Data Documentation

ACTIONS::$skintype

Definition at line 29 of file ACTIONS.php.

ACTIONS::$linkparams

Definition at line 33 of file ACTIONS.php.

ACTIONS::$skin

Definition at line 36 of file ACTIONS.php.

Referenced by setSkin().

ACTIONS::$formdata

Definition at line 40 of file ACTIONS.php.

ACTIONS::$amountfound

Definition at line 44 of file ACTIONS.php.

The documentation for this class was generated from the following file:

ACTIONS.php


Public Member Functions
	ACTIONS ($type)
	setSkin (&$skin)
	setParser (&$parser)
	doForm ($filename)
	checkCondition ($field, $name='', $value= '')
	_ifHasPlugin ($name, $value)
	_ifPlugin ($name, $key= '', $value= '')
	_ifCategory ($name= '', $value='')
	_ifOnTeam ($blogName= '')
	_ifAdmin ($blogName= '')
	_link ($url, $linktext= '')
	_searchlink ($maxresults, $startpos, $direction, $linktext= '')
	_itemlink ($id, $linktext= '')
	_archivelink ($id, $linktext= '')
	_setBlogCategory (&$blog, $catname)
	_preBlogContent ($type, &$blog)
	_postBlogContent ($type, &$blog)
	parse_additemform ()
	parse_adminurl ()
	parse_archive ($template, $category= '')
	parse_archivedate ($locale= '-def-')
	parse_archivedaylist ($template, $category= 'all', $limit=0)
	parse_archivelink ($linktext= '')
	parse_archivelist ($template, $category= 'all', $limit=0)
	parse_archivetype ()
	parse_blog ($template, $amount=10, $category= '')
	parse_bloglist ($template, $bnametype= '')
	parse_blogsetting ($which)
	parse_callback ($eventName, $type)
	parse_category ($type= 'name')
	parse_categorylist ($template, $blogname= '')
	parse_charset ()
	parse_commentform ($destinationurl= '')
	parse_comments ($template)
	parse_errordiv ()
	parse_errormessage ()
	parse_formdata ($what)
	parse_ifcat ($text= '')
	parse_image ($what= 'imgtag')
	parse_imagetext ()
	parse_item ($template)
	parse_itemid ()
	parse_itemlink ($linktext= '')
	parse_itemtitle ($format= '')
	parse_loginform ()
	parse_member ($what)
	parse_membermailform ($rows=10, $cols=40, $desturl= '')
	parse_nextarchive ()
	parse_nextitem ()
	parse_nextitemtitle ($format= '')
	parse_nextlink ($linktext= '', $amount=10)
	parse_nucleusbutton ($imgurl= '', $imgwidth= '85', $imgheight= '31')
	parse_otherarchive ($blogname, $template, $category= '')
	parse_otherarchivedaylist ($blogname, $template, $category= 'all', $limit=0)
	parse_otherarchivelist ($blogname, $template, $category= 'all', $limit=0)
	parse_otherblog ($blogname, $template, $amount=10, $category= '')
	parse_othersearchresults ($blogname, $template, $maxresults=50)
	parse_plugin ($pluginName)
	parse_prevarchive ()
	parse_preview ($template)
	parse_previtem ()
	parse_previtemtitle ($format= '')
	parse_prevlink ($linktext= '', $amount=10)
	parse_query ()
	parse_referer ()
	parse_searchform ($blogname= '')
	parse_searchresults ($template, $maxresults=50)
	parse_self ()
	parse_sitevar ($which)
	parse_skinname ()
	parse_skintype ()
	parse_text ($which)
	parse_ticket ()
	parse_todaylink ($linktext= '')
	parse_vars ()
	parse_version ()
Public Attributes
	$skintype
	$linkparams
	$skin
	$formdata
	$amountfound