contentBlocks Class Reference

Inheritance diagram for contentBlocks:

Public Member Functions
	__construct (ipsRegistry $registry, $blog=array())
	dropCache ($blogId=0)
	fetchAllContentBlocks ($blogData=array(), $forceFresh=false)
	fetchUsedContentBlocks ($blogData=array(), $forceFresh=false)
	get_cblock_html ($cblock_id, $type='getBlock')
	getCblockName ($cblock_id)
	getPlugin ($cblock_id)
	recacheAllBlocks ($blogId)
	recacheBlogAllBlocks ($blogId, $contentBlocks=array())
	recacheBlogUsedBlocks ($blogId, $contentBlocks=array())
	show_blocks ($position)
	wrapPluginOutput ($plugin, $cblock_html_content='', $xml=0)
Data Fields
	$blog
	$blogFunctions
	$cblock_cache
	$content_blocks
	$legacy_blocks
	$use_cache = 0
Protected Attributes
	$cache
	$caches
	$DB
	$lang
	$member
	$memberData
	$registry
	$request
	$settings

---

Constructor & Destructor Documentation

__construct	(	ipsRegistry $	registry,
		$	blog = array()
	)

CONSTRUCTOR

Parameters:

object	Registry
array	Blog data

Returns:

void

---

Member Function Documentation

dropCache

(

$

blogId = 0

)

Drop cache

public

Parameters:

int	[blog ID, if nothing passed, will drop all]

fetchAllContentBlocks	(	$	blogData = array(),
		$	forceFresh = false
	)

Fetch all cBlogs data

public

Parameters:

int	Blog ID
bool	Force refresh from DB

Returns:

array

fetchUsedContentBlocks	(	$	blogData = array(),
		$	forceFresh = false
	)

Fetch cBlogs data

public

Parameters:

int	Blog ID
bool	Force refresh from DB

Returns:

array

get_cblock_html	(	$	cblock_id,
		$	type = 'getBlock'
	)

get_cblock_html

Legacy/Shortcut Function for outputting the html from a plugin block

Parameters:

integer	$cblock_id
	string	[$type] Type of output, either get_block or get_config_form

Returns:

string

getCblockName

(

$

cblock_id

)

Get content block name

public

Parameters:

integer

Cblock id

Returns:

string Cblock name HTML

getPlugin

(

$

cblock_id

)

Return a plug in object for the specified ID

Parameters:

integer

$cblock_id

Returns:

object

recacheAllBlocks

(

$

blogId

)

Recache all

public

Parameters:

int

Blog id

recacheBlogAllBlocks	(	$	blogId,
		$	contentBlocks = array()
	)

Recache blog all blocks

public

Parameters:

int	Blog ID
array	[Content block data ]

Returns:

array Content blocks

recacheBlogUsedBlocks	(	$	blogId,
		$	contentBlocks = array()
	)

Recache blog used blocks

public

Parameters:

int	Blog ID
array	[Content block data ]

Returns:

array Content blocks

show_blocks

(

$

position

)

show_blocks

Parameters:

string

$position

Should be either 'right' or 'left'

Returns:

string

wrapPluginOutput	(	$	plugin,
		$	cblock_html_content = '',
		$	xml = 0
	)

Wraps plugin output for ajax return

Parameters:

object	$plugin	Plugin that generated the content
string	$cblock_html_content	The content to wrap
int	$xml	Whether request is ajax replace request

Returns:

object

---

Field Documentation

$registry [protected]

Registry Object Shortcuts

Reimplemented in cb_last_comments, cb_last_entries, cb_calendar, cb_friends, cb_categories, cb_search, cb_tags, cb_mypicture, cb_rand_album_image, cb_custom, cb_google_shared_items, cb_mybloglog, cb_twitter, cb_visitors, cb_active_users, cb_admin_block, and cb_albums.

---

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

• admin/applications_addon/ips/blog/sources/classes/contentblocks/blocks.php