Class: XoopsBlock

Source Location: /class/xoopsblock.php

Class XoopsBlock

Class Overview

Base class for all objects in the Xoops kernel (and beyond)

Located in /class/xoopsblock.php [line 37]

XoopsObject
   |
   --XoopsBlock
Author(s):
  • Kazumi Ono (AKA onokazu)
Information Tags:
Copyright:  copyright © 2000 XOOPS.org

Properties

Methods

[ Top ]
Inherited Properties, Constants, and Methods
Inherited Properties Inherited Methods Inherited Constants

Inherited From XoopsObject

XoopsObject::$cleanVars
XoopsObject::$vars

Inherited From XoopsObject

XoopsObject::XoopsObject()
constructor
XoopsObject::assignVar()
assign a value to a variable
XoopsObject::cleanVars()
clean values of all variables of the object for storage.
XoopsObject::getErrors()
return the errors for this object as an array
XoopsObject::getHtmlErrors()
return the errors for this object as html
XoopsObject::getValues()
Returns the values of the specified variables
XoopsObject::getVar()
returns a specific variable for the object in a proper format
XoopsObject::getVars()
returns all variables for the object
XoopsObject::initVar()
initialize variables for the object
XoopsObject::isDirty()
mark modified objects as dirty
XoopsObject::isNew()
used for new/clone objects
XoopsObject::registerFilter()
dynamically register additional filter for the object
XoopsObject::setDirty()
mark modified objects as dirty
XoopsObject::setErrors()
add an error
XoopsObject::setNew()
used for new/clone objects
XoopsObject::setVar()
assign a value to a variable
XoopsObject::unsetDirty()
mark modified objects as dirty
XoopsObject::unsetNew()
used for new/clone objects
XoopsObject::xoopsClone()
create a clone(copy) of the current object

[ Top ]
Property Summary
mixed   $db  

[ Top ]
Method Summary
XoopsBlock   XoopsBlock()  
void   buildBlock()  
void   buildContent()  
void   buildTitle()  
void   countSimilarBlocks()  
void   delete()  
void   getAllBlocks()  
array   getAllBlocksByGroup()   get all the blocks that match the supplied parameters
void   getAllByGroupModule()  
void   getBlockPositions()  
void   getByModule()  
string   getContent()   do stripslashes/htmlspecialchars according to the needed output
void   getNonGroupedBlocks()  
void   getOptions()   gets html form for editting block options
void   isCustom()  
void   load()  
void   store()  

[ Top ]
Properties
mixed   $db [line 39]

[ Top ]
Methods
Constructor XoopsBlock  [line 41]

  XoopsBlock XoopsBlock( [ $id = null]  )

Parameters:
   $id: 


[ Top ]
buildBlock  [line 172]

  void buildBlock( )



[ Top ]
buildContent  [line 221]

  void buildContent( $position, [ $content = ""], [ $contentdb = ""]  )

Parameters:
   $position: 
   $content: 
   $contentdb: 


[ Top ]
buildTitle  [line 231]

  void buildTitle( $originaltitle, [ $newtitle = ""]  )

Parameters:
   $originaltitle: 
   $newtitle: 


[ Top ]
countSimilarBlocks  [line 570]

  void countSimilarBlocks( $moduleId, $funcNum, [ $showFunc = null]  )

Parameters:
   $moduleId: 
   $funcNum: 
   $showFunc: 


[ Top ]
delete  [line 114]

  void delete( )



[ Top ]
getAllBlocks  [line 371]

  void getAllBlocks( [ $rettype = "object"], [ $side = null], [ $visible = null], [ $orderby = "side,weight,bid"], [ $isactive = 1]  )

Parameters:
   $rettype: 
   $side: 
   $visible: 
   $orderby: 
   $isactive: 


[ Top ]
getAllBlocksByGroup  [line 296]

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

get all the blocks that match the supplied parameters

Parameters:
$side   $groupid:  0: sideblock - left 1: sideblock - right 2: sideblock - left and right 3: centerblock - left 4: centerblock - right 5: centerblock - center 6: centerblock - left, right, center
$groupid   $asobject:  groupid (can be an array)
$visible   $side:  0: not visible 1: visible
$orderby   $visible:  order of the blocks
   $orderby: 
   $isactive: 

API Tags:
Return:  of block objects


[ Top ]
getAllByGroupModule  [line 463]

  void getAllByGroupModule( $groupid, [ $module_id = '0-0'], [ $toponlyblock = false], [ $visible = null], [ $orderby = 'b.weight,b.bid'], [ $isactive = 1]  )

Parameters:
   $groupid: 
   $module_id: 
   $toponlyblock: 
   $visible: 
   $orderby: 
   $isactive: 


[ Top ]
getBlockPositions  [line 593]

  void getBlockPositions( [ $full = false]  )

Parameters:
   $full: 


[ Top ]
getByModule  [line 442]

  void getByModule( $moduleid, [ $asobject = true]  )

Parameters:
   $moduleid: 
   $asobject: 


[ Top ]
getContent  [line 134]

  string getContent( [$format $format = 'S'], [$c_type $c_type = 'T']  )

do stripslashes/htmlspecialchars according to the needed output

Parameters:
$format   $format:  output use: S for Show and E for Edit
$c_type   $c_type:  type of block content


[ Top ]
getNonGroupedBlocks  [line 519]

  void getNonGroupedBlocks( [ $module_id = 0], [ $toponlyblock = false], [ $visible = null], [ $orderby = 'b.weight,b.bid'], [ $isactive = 1]  )

Parameters:
   $module_id: 
   $toponlyblock: 
   $visible: 
   $orderby: 
   $isactive: 


[ Top ]
getOptions  [line 253]

  void getOptions( )

gets html form for editting block options



[ Top ]
isCustom  [line 241]

  void isCustom( )



[ Top ]
load  [line 77]

  void load( $id  )

Parameters:
   $id: 


[ Top ]
store  [line 85]

  void store( )



[ Top ]

Documentation generated on Sat, 15 Nov 2008 14:29:59 -0600 by phpDocumentor 1.4.1