Class XoopsBlock

XoopsBlock

Xoops\Core\Kernel\XoopsObject implements ArrayAccess

Xoops\Core\Kernel\Handlers\XoopsBlock

Direct known subclasses

Namespace: Xoops\Core\Kernel\Handlers
Package: Xoops\Core\Kernel
Category: Xoops\Core\Kernel\Handlers\XoopsBlock
Copyright: 2000-2015 XOOPS Project (http://xoops.org)
License: GPL 2 or later (http://www.gnu.org/licenses/gpl-2.0.html)
Author: Kazumi Ono (AKA onokazu) http://www.myweb.ne.jp/, http://jp.xoops.org/
Author: Gregory Mage (AKA Mage)
Author: trabis lusopoemas@gmail.com
Link: http://xoops.org
Located at oops_lib/Xoops/Core/Kernel/Handlers/XoopsBlock.php

Methods summary
`public`	# `__construct( integer\|array $id = null )` Constructor Constructor Parameters `$id` object id
`public mixed`	# `id( string $format = 'n' )` getter getter Parameters `$format` Dtype::FORMAT_xxxx constant Returns mixed
`public mixed`	# `bid( string $format = '' )` getter getter Parameters `$format` Dtype::FORMAT_xxxx constant Returns mixed
`public mixed`	# `mid( string $format = '' )` getter getter Parameters `$format` Dtype::FORMAT_xxxx constant Returns mixed
`public mixed`	# `func_num( string $format = '' )` getter getter Parameters `$format` Dtype::FORMAT_xxxx constant Returns mixed
`public mixed`	# `options( string $format = '' )` getter getter Parameters `$format` Dtype::FORMAT_xxxx constant Returns mixed
`public mixed`	# `name( string $format = '' )` getter getter Parameters `$format` Dtype::FORMAT_xxxx constant Returns mixed
`public mixed`	# `title( string $format = '' )` getter getter Parameters `$format` Dtype::FORMAT_xxxx constant Returns mixed
`public mixed`	# `content( string $format = '' )` getter getter Parameters `$format` Dtype::FORMAT_xxxx constant Returns mixed
`public mixed`	# `side( string $format = '' )` getter getter Parameters `$format` Dtype::FORMAT_xxxx constant Returns mixed
`public mixed`	# `weight( string $format = '' )` getter getter Parameters `$format` Dtype::FORMAT_xxxx constant Returns mixed
`public mixed`	# `visible( string $format = '' )` getter getter Parameters `$format` Dtype::FORMAT_xxxx constant Returns mixed
`public mixed`	# `block_type( string $format = '' )` getter getter Parameters `$format` Dtype::FORMAT_xxxx constant Returns mixed
`public mixed`	# `c_type( string $format = '' )` getter custom block type XoopsBlock::CUSTOM_xxxx constant getter custom block type XoopsBlock::CUSTOM_xxxx constant Parameters `$format` Dtype::FORMAT_xxxx constant Returns mixed
`public mixed`	# `isactive( string $format = '' )` getter getter Parameters `$format` Dtype::FORMAT_xxxx constant Returns mixed
`public mixed`	# `dirname( string $format = '' )` getter getter Parameters `$format` Dtype::FORMAT_xxxx constant Returns mixed
`public mixed`	# `func_file( string $format = '' )` getter getter Parameters `$format` Dtype::FORMAT_xxxx constant Returns mixed
`public mixed`	# `show_func( string $format = '' )` getter getter Parameters `$format` Dtype::FORMAT_xxxx constant Returns mixed
`public mixed`	# `edit_func( string $format = '' )` getter getter Parameters `$format` Dtype::FORMAT_xxxx constant Returns mixed
`public mixed`	# `template( string $format = '' )` getter getter Parameters `$format` Dtype::FORMAT_xxxx constant Returns mixed
`public mixed`	# `bcachetime( string $format = '' )` getter getter Parameters `$format` Dtype::FORMAT_xxxx constant Returns mixed
`public mixed`	# `last_modified( string $format = '' )` getter getter Parameters `$format` Dtype::FORMAT_xxxx constant Returns mixed
`public string`	# `getContent( string $format = 's', string $c_type = 'T' )` return the content of the block for output return the content of the block for output Parameters `$format` Dtype::FORMAT_xxxx constant `$c_type` type of custom content, a XoopsBlock::CUSTOM_xxxx constant H : custom HTML block P : custom PHP block S : use text sanitizer (smilies enabled) T : use text sanitizer (smilies disabled) Returns string content for output
`protected string`	# `convertSiteURL( string $content )` Convert {X_SITEURL} to actual site URL in content Convert {X_SITEURL} to actual site URL in content Parameters `$content` content to convert Returns string
`public string\|false`	# `getOptions( )` (HTML-) form for setting the options of the block (HTML-) form for setting the options of the block Returns string\|false HTML for the form, FALSE if not defined for this block
`public boolean`	# `isCustom( )` Determine if this is a custom block Determine if this is a custom block Returns boolean true if this is a custom block
`public array\|boolean`	# `buildBlock( )` Build Block Build Block Returns array\|boolean

Methods inherited from Xoops\Core\Kernel\XoopsObject
`__clone(), assignVar(), assignVars(), cleanVars(), destroyVars(), getErrors(), getHtmlErrors(), getValues(), getVar(), getVars(), initVar(), isDirty(), isNew(), loadFilters(), offsetExists(), offsetGet(), offsetSet(), offsetUnset(), registerFilter(), setDirty(), setErrors(), setFormVars(), setNew(), setVar(), setVars(), toArray(), unsetDirty(), unsetNew(), xoopsClone()`

Constants summary
`string`	`CUSTOM_HTML`	# `'H'`
`string`	`CUSTOM_PHP`	# `'P'`
`string`	`CUSTOM_SMILIE`	# `'S'`
`string`	`CUSTOM_TEXT`	# `'T'`
`string`	`BLOCK_TYPE_SYSTEM`	# `'S'`
`string`	`BLOCK_TYPE_MODULE`	# `'M'`
`string`	`BLOCK_TYPE_CUSTOM`	# `'C'`
`string`	`BLOCK_TYPE_CLONED`	# `'D'`

Properties inherited from Xoops\Core\Kernel\XoopsObject
`$cleanVars, $plugin_path, $vars`

Namespaces

Classes

Class XoopsBlock

Direct known subclasses

Parameters

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Returns

Returns

Returns