XOOPS 2.5.6  Final
 All Classes Namespaces Files Functions Variables Pages
Public Member Functions | Public Attributes | List of all members
XoopsBlock Class Reference
Inheritance diagram for XoopsBlock:
Inheritance graph

Public Member Functions

 bcachetime ($format= '')
 
 bid ($format= '')
 
 block_type ($format= '')
 
 buildBlock ()
 
 buildContent ($position, $content="", $contentdb="")
 
 buildTitle ($originaltitle, $newtitle= '')
 
 c_type ($format= '')
 
 content ($format= '')
 
 countSimilarBlocks ($moduleId, $funcNum, $showFunc=null)
 
 delete ()
 
 dirname ($format= '')
 
 edit_func ($format= '')
 
 func_file ($format= '')
 
 func_num ($format= '')
 
 getAllBlocks ($rettype="object", $side=null, $visible=null, $orderby="side,weight,bid", $isactive=1)
 
 getAllBlocksByGroup ($groupid, $asobject=true, $side=null, $visible=null, $orderby="b.weight,b.bid", $isactive=1)
 
 getAllByGroupModule ($groupid, $module_id=0, $toponlyblock=false, $visible=null, $orderby= 'b.weight, m.block_id', $isactive=1)
 
 getByModule ($moduleid, $asobject=true)
 
 getContent ($format= 's', $c_type= 't')
 
 getContent ($format= 's', $c_type= 'T')
 
 getNonGroupedBlocks ($module_id=0, $toponlyblock=false, $visible=null, $orderby= 'b.weight, m.block_id', $isactive=1)
 
 getOptions ()
 
 getOptions ()
 
 id ($format= 'n')
 
 isactive ($format= '')
 
 isCustom ()
 
 isCustom ()
 
 last_modified ($format= '')
 
 load ($id)
 
 mid ($format= '')
 
 name ($format= '')
 
 options ($format= '')
 
 show_func ($format= '')
 
 side ($format= '')
 
 store ()
 
 template ($format= '')
 
 title ($format= '')
 
 visible ($format= '')
 
 weight ($format= '')
 
 XoopsBlock ($id=null)
 
 XoopsBlock ($id=null)
 
- Public Member Functions inherited from XoopsObject
 _loadFilters ()
 
 assignVar ($key, $value)
 
 assignVars ($var_arr)
 
 cleanVars ()
 
 destoryVars ($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= '', $enumerations= '')
 
 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 ()
 
 XoopsObject ()
 

Public Attributes

 $db
 
- Public Attributes inherited from XoopsObject
 $_errors = array()
 
 $_filters = array()
 
 $_isDirty = false
 
 $_isNew = false
 
 $cleanVars = array()
 
 $vars = array()
 

Detailed Description

Definition at line 26 of file xoopsblock.php.

Member Function Documentation

XoopsBlock::bcachetime (   $format = '')

Returns Class Base Variable avatar_id

Definition at line 228 of file block.php.

XoopsBlock::bid (   $format = '')

Returns Class Base Variable bid

Definition at line 85 of file block.php.

XoopsBlock::block_type (   $format = '')

Returns Class Base Variable block_type

Definition at line 164 of file block.php.

XoopsBlock::buildBlock ( )

Build Block

Returns
unknown

Definition at line 185 of file xoopsblock.php.

References $GLOBALS, $options, $xoopsConfig, $xoopsOption, $xoTheme, and xoops_loadLanguage().

Here is the call graph for this function:

XoopsBlock::buildContent (   $position,
  $content = "",
  $contentdb = "" 
)

Definition at line 230 of file xoopsblock.php.

References $content, and $ret.

XoopsBlock::buildTitle (   $originaltitle,
  $newtitle = '' 
)

Enter description here...

Parameters
string$originaltitle
string$newtitle
Returns
string title

Definition at line 247 of file xoopsblock.php.

References $ret.

XoopsBlock::c_type (   $format = '')

Returns Class Base Variable c_type

Definition at line 172 of file block.php.

XoopsBlock::content (   $format = '')

Returns Class Base Variable content

Definition at line 132 of file block.php.

XoopsBlock::countSimilarBlocks (   $moduleId,
  $funcNum,
  $showFunc = null 
)

XoopsBlock::countSimilarBlocks()

Parameters
mixed$moduleId
mixed$funcNum
mixed$showFunc
Returns

Definition at line 593 of file xoopsblock.php.

References $result, $sql, and XoopsDatabaseFactory\getDatabaseConnection().

Here is the call graph for this function:

XoopsBlock::delete ( )

Delete a ID from the database

Returns
bool

Definition at line 124 of file xoopsblock.php.

References $sql.

XoopsBlock::dirname (   $format = '')

Returns Class Base Variable dirname

Definition at line 188 of file block.php.

XoopsBlock::edit_func (   $format = '')

Returns Class Base Variable edit_func

Definition at line 212 of file block.php.

XoopsBlock::func_file (   $format = '')

Returns Class Base Variable func_file

Definition at line 196 of file block.php.

XoopsBlock::func_num (   $format = '')

Returns Class Base Variable func_num

Definition at line 101 of file block.php.

XoopsBlock::getAllBlocks (   $rettype = "object",
  $side = null,
  $visible = null,
  $orderby = "side,weight,bid",
  $isactive = 1 
)

XoopsBlock::getAllBlocks()

Parameters
string$rettype
mixed$side
mixed$visible
string$orderby
integer$isactive
Returns

Definition at line 380 of file xoopsblock.php.

References $result, $ret, $sql, $title, and XoopsDatabaseFactory\getDatabaseConnection().

Here is the call graph for this function:

XoopsBlock::getAllBlocksByGroup (   $groupid,
  $asobject = true,
  $side = null,
  $visible = null,
  $orderby = "b.weight,b.bid",
  $isactive = 1 
)

get all the blocks that match the supplied parameters

Parameters
$side0: sideblock - left 1: sideblock - right 2: sideblock - left and right 3: centerblock - left 4: centerblock - right 5: centerblock - center 6: centerblock - left, right, center
$groupidgroupid (can be an array)
$visible0: not visible 1: visible
$orderbyorder of the blocks
Returns
array of block objects

Definition at line 317 of file xoopsblock.php.

References $i, $result, $ret, $sql, XoopsDatabaseFactory\getDatabaseConnection(), XOOPS_CENTERBLOCK_ALL, and XOOPS_SIDEBLOCK_BOTH.

Referenced by smarty_function_block().

Here is the call graph for this function:

Here is the caller graph for this function:

XoopsBlock::getAllByGroupModule (   $groupid,
  $module_id = 0,
  $toponlyblock = false,
  $visible = null,
  $orderby = 'b.weight,
m.block_id'  ,
  $isactive = 1 
)

XoopsBlock::getAllByGroupModule()

Parameters
mixed$groupid
integer$module_id
mixed$toponlyblock
mixed$visible
string$orderby
integer$isactive
Returns

Definition at line 469 of file xoopsblock.php.

References $module_id, $result, $ret, $sql, and XoopsDatabaseFactory\getDatabaseConnection().

Here is the call graph for this function:

XoopsBlock::getByModule (   $moduleid,
  $asobject = true 
)

XoopsBlock::getByModule()

Parameters
mixed$moduleid
mixed$asobject
Returns

Definition at line 437 of file xoopsblock.php.

References $result, $ret, $sql, and XoopsDatabaseFactory\getDatabaseConnection().

Referenced by xoops_module_activate(), xoops_module_deactivate(), xoops_module_install(), xoops_module_uninstall(), and xoops_template_clear_module_cache().

Here is the call graph for this function:

Here is the caller graph for this function:

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

do stripslashes/htmlspecialchars according to the needed output

Parameters
$formatoutput use: S for Show and E for Edit
$c_typetype of block content
Returns
string

Definition at line 144 of file xoopsblock.php.

References $content, $myts, and MyTextSanitizer\getInstance().

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 253 of file block.php.

References $content, $myts, and MyTextSanitizer\getInstance().

Here is the call graph for this function:

XoopsBlock::getNonGroupedBlocks (   $module_id = 0,
  $toponlyblock = false,
  $visible = null,
  $orderby = 'b.weight,
m.block_id'  ,
  $isactive = 1 
)

XoopsBlock::getNonGroupedBlocks()

Parameters
integer$module_id
mixed$toponlyblock
mixed$visible
string$orderby
integer$isactive
Returns

Definition at line 534 of file xoopsblock.php.

References $module_id, $result, $ret, $sql, and XoopsDatabaseFactory\getDatabaseConnection().

Here is the call graph for this function:

XoopsBlock::getOptions ( )

XoopsBlock::getOptions()

Returns

Definition at line 274 of file xoopsblock.php.

References $file, $GLOBALS, $options, and $xoopsConfig.

XoopsBlock::getOptions ( )

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

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

Definition at line 291 of file block.php.

References $GLOBALS, and $options.

XoopsBlock::id (   $format = 'n')

Returns Class Base Variable bid

Definition at line 77 of file block.php.

XoopsBlock::isactive (   $format = '')

Returns Class Base Variable isactive

Definition at line 180 of file block.php.

XoopsBlock::isCustom ( )

XoopsBlock::isCustom()

Returns

Definition at line 262 of file xoopsblock.php.

XoopsBlock::isCustom ( )

Definition at line 319 of file block.php.

XoopsBlock::last_modified (   $format = '')

Returns Class Base Variable last_modified

Definition at line 236 of file block.php.

XoopsBlock::load (   $id)

Load $id

Parameters
int$id

Definition at line 77 of file xoopsblock.php.

References $sql.

XoopsBlock::mid (   $format = '')

Returns Class Base Variable mid

Definition at line 93 of file block.php.

XoopsBlock::name (   $format = '')

Returns Class Base Variable name

Definition at line 117 of file block.php.

XoopsBlock::options (   $format = '')

Returns Class Base Variable avatar_id

Definition at line 109 of file block.php.

XoopsBlock::show_func (   $format = '')

Returns Class Base Variable show_func

Definition at line 204 of file block.php.

XoopsBlock::side (   $format = '')

Returns Class Base Variable side

Definition at line 140 of file block.php.

XoopsBlock::store ( )

Store Block Data to Database

Returns
int $id

Definition at line 90 of file xoopsblock.php.

References $content, $dirname, $mid, $options, $sql, and $title.

XoopsBlock::template (   $format = '')

Returns Class Base Variable template

Definition at line 220 of file block.php.

XoopsBlock::title (   $format = '')

Returns Class Base Variable title

Definition at line 125 of file block.php.

XoopsBlock::visible (   $format = '')

Returns Class Base Variable visible

Definition at line 156 of file block.php.

XoopsBlock::weight (   $format = '')

Returns Class Base Variable weight

Definition at line 148 of file block.php.

XoopsBlock::XoopsBlock (   $id = null)

Definition at line 30 of file xoopsblock.php.

References XoopsDatabaseFactory\getDatabaseConnection(), XOBJ_DTYPE_INT, XOBJ_DTYPE_OTHER, XOBJ_DTYPE_TXTAREA, and XOBJ_DTYPE_TXTBOX.

Here is the call graph for this function:

XoopsBlock::XoopsBlock (   $id = null)

constructor

Parameters
mixed$id

Definition at line 35 of file block.php.

References $i, XOBJ_DTYPE_INT, XOBJ_DTYPE_OTHER, XOBJ_DTYPE_TXTAREA, XOBJ_DTYPE_TXTBOX, and xoops_gethandler().

Here is the call graph for this function:

Member Data Documentation

XoopsBlock::$db

Definition at line 28 of file xoopsblock.php.

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