IP.Board  3.3.0
contentBlocks Class Reference
Inheritance diagram for contentBlocks:
cb_active_users cb_admin_block cb_albums cb_calendar cb_categories cb_custom cb_friends cb_google_shared_items cb_last_comments cb_last_entries cb_mybloglog cb_mypicture cb_rand_album_image cb_search cb_tags cb_twitter cb_visitors

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:
objectRegistry
arrayBlog 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:
intBlog ID
boolForce refresh from DB
Returns:
array
fetchUsedContentBlocks ( blogData = array(),
forceFresh = false 
)

Fetch cBlogs data

public

Parameters:
intBlog ID
boolForce 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:
integerCblock 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:
intBlog id
recacheBlogAllBlocks ( blogId,
contentBlocks = array() 
)

Recache blog all blocks

public

Parameters:
intBlog ID
array[Content block data ]
Returns:
array Content blocks
recacheBlogUsedBlocks ( blogId,
contentBlocks = array() 
)

Recache blog used blocks

public

Parameters:
intBlog ID
array[Content block data ]
Returns:
array Content blocks
show_blocks ( position)

show_blocks

Parameters:
string$positionShould be either 'right' or 'left'
Returns:
string
wrapPluginOutput ( plugin,
cblock_html_content = '',
xml = 0 
)

Wraps plugin output for ajax return

Parameters:
object$pluginPlugin that generated the content
string$cblock_html_contentThe content to wrap
int$xmlWhether request is ajax replace request
Returns:
object

Field Documentation


The documentation for this class was generated from the following file:
 All Data Structures Functions Variables