XOOPS  2.6.0
XoopsBlock Class Reference
Inheritance diagram for XoopsBlock:
Inheritance graph

Public Member Functions

 __construct ($id=null)
 
 bcachetime ($format= '')
 
 bid ($format= '')
 
 block_type ($format= '')
 
 buildBlock ()
 
 c_type ($format= '')
 
 content ($format= '')
 
 dirname ($format= '')
 
 edit_func ($format= '')
 
 func_file ($format= '')
 
 func_num ($format= '')
 
 getContent ($format= 's', $c_type= 'T')
 
 getOptions ()
 
 id ($format= 'n')
 
 isactive ($format= '')
 
 isCustom ()
 
 last_modified ($format= '')
 
 mid ($format= '')
 
 name ($format= '')
 
 options ($format= '')
 
 show_func ($format= '')
 
 side ($format= '')
 
 template ($format= '')
 
 title ($format= '')
 
 visible ($format= '')
 
 weight ($format= '')
 
- Public Member Functions inherited from Xoops\Core\Kernel\XoopsObject
 assignVar ($key, $value)
 
 assignVars ($var_arr)
 
 cleanVars ($quote=true)
 
 destroyVars ($var)
 
 getErrors ()
 
 getHtmlErrors ()
 
 getValues ($keys=null, $format= 's', $maxDepth=1)
 
 getVar ($key, $format= 's')
 
 getVars ()
 
 initVar ($key, $data_type, $value=null, $required=false, $maxlength=null, $options= '')
 
 isDirty ()
 
 isNew ()
 
 loadFilters ($method)
 
 registerFilter ($filtername)
 
 setDirty ()
 
 setErrors ($err_str)
 
 setFormVars ($var_arr=null, $pref= 'xo_', $not_gpc=false)
 
 setNew ()
 
 setVar ($key, $value, $not_gpc=false)
 
 setVars ($var_arr, $not_gpc=false)
 
 toArray ()
 
 unsetDirty ()
 
 unsetNew ()
 
 xoopsClone ()
 

Additional Inherited Members

- Public Attributes inherited from Xoops\Core\Kernel\XoopsObject
 $cleanVars = array()
 
 $plugin_path
 
 $vars = array()
 

Detailed Description

Definition at line 28 of file block.php.

Constructor & Destructor Documentation

Member Function Documentation

XoopsBlock::bcachetime (   $format = '')
Parameters
string$format
Returns
mixed

Definition at line 259 of file block.php.

References Xoops\Core\Kernel\XoopsObject\getVar().

Here is the call graph for this function:

XoopsBlock::bid (   $format = '')
Parameters
string$format
Returns
mixed

Definition at line 97 of file block.php.

References Xoops\Core\Kernel\XoopsObject\getVar().

Here is the call graph for this function:

XoopsBlock::block_type (   $format = '')
Parameters
string$format
Returns
mixed

Definition at line 187 of file block.php.

References Xoops\Core\Kernel\XoopsObject\getVar().

Here is the call graph for this function:

XoopsBlock::buildBlock ( )

Build Block

Returns
array|bool

Definition at line 375 of file block.php.

References $options, $xoops, XoopsLoad\fileExists(), getContent(), Xoops\getInstance(), Xoops\Core\Kernel\XoopsObject\getVar(), and isCustom().

Here is the call graph for this function:

XoopsBlock::c_type (   $format = '')
Parameters
string$format
Returns
mixed

Definition at line 196 of file block.php.

References Xoops\Core\Kernel\XoopsObject\getVar().

Here is the call graph for this function:

XoopsBlock::content (   $format = '')
Parameters
string$format
Returns
mixed

Definition at line 151 of file block.php.

References Xoops\Core\Kernel\XoopsObject\getVar().

Here is the call graph for this function:

XoopsBlock::dirname (   $format = '')
Parameters
string$format
Returns
mixed

Definition at line 214 of file block.php.

References Xoops\Core\Kernel\XoopsObject\getVar().

Here is the call graph for this function:

XoopsBlock::edit_func (   $format = '')
Parameters
string$format
Returns
mixed

Definition at line 241 of file block.php.

References Xoops\Core\Kernel\XoopsObject\getVar().

Here is the call graph for this function:

XoopsBlock::func_file (   $format = '')
Parameters
string$format
Returns
mixed

Definition at line 223 of file block.php.

References Xoops\Core\Kernel\XoopsObject\getVar().

Here is the call graph for this function:

XoopsBlock::func_num (   $format = '')
Parameters
string$format
Returns
mixed

Definition at line 115 of file block.php.

References Xoops\Core\Kernel\XoopsObject\getVar().

Here is the call graph for this function:

XoopsBlock::getContent (   $format = 's',
  $c_type = 'T' 
)

return the content of the block for output

Parameters
string$format
string$c_typetype of content
Legal value for the type of content
  • H : custom HTML block
  • P : custom PHP block
  • S : use text sanitizater (smilies enabled)
  • T : use text sanitizater (smilies disabled)
Returns
string content for output

Definition at line 285 of file block.php.

References $content, $myts, XoopsBaseConfig\get(), MyTextSanitizer\getInstance(), and Xoops\Core\Kernel\XoopsObject\getVar().

Referenced by buildBlock().

Here is the call graph for this function:

Here is the caller graph for this function:

XoopsBlock::getOptions ( )

(HTML-) form for setting the options of the block

Returns
string|false HTML for the form, FALSE if not defined for this block

Definition at line 332 of file block.php.

References $options, $xoops, XoopsLoad\fileExists(), Xoops\getInstance(), Xoops\Core\Kernel\XoopsObject\getVar(), and isCustom().

Here is the call graph for this function:

XoopsBlock::id (   $format = 'n')
Parameters
string$format
Returns
mixed

Definition at line 88 of file block.php.

References Xoops\Core\Kernel\XoopsObject\getVar().

Here is the call graph for this function:

XoopsBlock::isactive (   $format = '')
Parameters
string$format
Returns
mixed

Definition at line 205 of file block.php.

References Xoops\Core\Kernel\XoopsObject\getVar().

Here is the call graph for this function:

XoopsBlock::isCustom ( )

Definition at line 362 of file block.php.

References Xoops\Core\Kernel\XoopsObject\getVar().

Referenced by buildBlock(), and getOptions().

Here is the call graph for this function:

Here is the caller graph for this function:

XoopsBlock::last_modified (   $format = '')
Parameters
string$format
Returns
mixed

Definition at line 268 of file block.php.

References Xoops\Core\Kernel\XoopsObject\getVar().

Here is the call graph for this function:

XoopsBlock::mid (   $format = '')
Parameters
string$format
Returns
mixed

Definition at line 106 of file block.php.

References Xoops\Core\Kernel\XoopsObject\getVar().

Here is the call graph for this function:

XoopsBlock::name (   $format = '')
Parameters
string$format
Returns
mixed

Definition at line 133 of file block.php.

References Xoops\Core\Kernel\XoopsObject\getVar().

Here is the call graph for this function:

XoopsBlock::options (   $format = '')
Parameters
string$format
Returns
mixed

Definition at line 124 of file block.php.

References Xoops\Core\Kernel\XoopsObject\getVar().

Here is the call graph for this function:

XoopsBlock::show_func (   $format = '')
Parameters
string$format
Returns
mixed

Definition at line 232 of file block.php.

References Xoops\Core\Kernel\XoopsObject\getVar().

Here is the call graph for this function:

XoopsBlock::side (   $format = '')
Parameters
string$format
Returns
mixed

Definition at line 160 of file block.php.

References Xoops\Core\Kernel\XoopsObject\getVar().

Here is the call graph for this function:

XoopsBlock::template (   $format = '')
Parameters
string$format
Returns
mixed

Definition at line 250 of file block.php.

References Xoops\Core\Kernel\XoopsObject\getVar().

Here is the call graph for this function:

XoopsBlock::title (   $format = '')
Parameters
string$format
Returns
mixed

Definition at line 142 of file block.php.

References Xoops\Core\Kernel\XoopsObject\getVar().

Here is the call graph for this function:

XoopsBlock::visible (   $format = '')
Parameters
string$format
Returns
mixed

Definition at line 178 of file block.php.

References Xoops\Core\Kernel\XoopsObject\getVar().

Here is the call graph for this function:

XoopsBlock::weight (   $format = '')
Parameters
string$format
Returns
mixed

Definition at line 169 of file block.php.

References Xoops\Core\Kernel\XoopsObject\getVar().

Here is the call graph for this function:


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