ilPDContentBlockGUI Class Reference

BlockGUI class for (centered) Content on Personal Desktop. More...

Inheritance diagram for ilPDContentBlockGUI:

Collaboration diagram for ilPDContentBlockGUI:

Public Member Functions
	__construct ()
	Constructor. More...
	getBlockType ()
	setCurrentItemNumber ($a_currentitemnumber)
	Set Current Item Number. More...
	getCurrentItemNumber ()
	Get Current Item Number. More...
	getHTML ()
	getContent ()
	setContent ($a_content)
	fillDataSection ()
	Fill data section. More...
	fillFooter ()
	block footer More...
	fillPreviousNext ()
Public Member Functions inherited from ilBlockGUI
	getBlockType ()
	__construct ()
	Constructor. More...
	addHeaderLink ($a_href, $a_text, $status=true)
	getHeaderLinks ()
	setData ($a_data)
	Set Data. More...
	getData ()
	Get Data. More...
	setBigMode ($a_bigmode)
	Set Big Mode. More...
	getBigMode ()
	Get Big Mode. More...
	setBlockId ($a_block_id=0)
	Set Block Id. More...
	getBlockId ()
	Get Block Id. More...
	setAvailableDetailLevels ($a_max, $a_min=0)
	Set Available Detail Levels. More...
	setCurrentDetailLevel ($a_currentdetaillevel)
	Set Current Detail Level. More...
	setGuiObject (&$a_gui_object)
	Set GuiObject. More...
	getGuiObject ()
	Get GuiObject. More...
	getCurrentDetailLevel ()
	Get Current Detail Level. More...
	setTitle ($a_title)
	Set Title. More...
	getTitle ()
	Get Title. More...
	setImage ($a_image)
	Set Image. More...
	getImage ()
	Get Image. More...
	setOffset ($a_offset)
	Set Offset. More...
	getOffset ()
	Get Offset. More...
	correctOffset ()
	setLimit ($a_limit)
	Set Limit. More...
	getLimit ()
	Get Limit. More...
	setEnableEdit ($a_enableedit)
	Set EnableEdit. More...
	getEnableEdit ()
	Get EnableEdit. More...
	setRepositoryMode ($a_repositorymode)
	Set RepositoryMode. More...
	getRepositoryMode ()
	Get RepositoryMode. More...
	setFooterInfo ($a_footerinfo, $a_hide_and_icon=false)
	Set Footer Info. More...
	getFooterInfo ($a_hide_and_icon=false)
	Get Footer Info. More...
	setSubtitle ($a_subtitle)
	Set Subtitle. More...
	getSubtitle ()
	Get Subtitle. More...
	setRefId ($a_refid)
	Set Ref Id (only used if isRepositoryObject() is true). More...
	getRefId ()
	Get Ref Id (only used if isRepositoryObject() is true). More...
	setAdminCommands ($a_admincommands)
	Set Administration Commmands. More...
	getAdminCommands ()
	Get Administration Commmands. More...
	setColSpan ($a_colspan)
	Set Columns Span. More...
	getColSpan ()
	Get Columns Span. More...
	setEnableDetailRow ($a_enabledetailrow)
	Set EnableDetailRow. More...
	getEnableDetailRow ()
	Get EnableDetailRow. More...
	setEnableNumInfo ($a_enablenuminfo)
	Set Enable Item Number Info. More...
	getEnableNumInfo ()
	Get Enable Item Number Info. More...
	setProperties ($a_properties)
	This function is supposed to be used for block type specific properties, that should be inherited through ilColumnGUI->setBlockProperties. More...
	getProperty ($a_property)
	setProperty ($a_property, $a_value)
	setRowTemplate ($a_rowtemplatename, $a_rowtemplatedir="")
	Set Row Template Name. More...
	getNavParameter ()
	getDetailParameter ()
	getConfigParameter ()
	getMoveParameter ()
	getRowTemplateName ()
	Get Row Template Name. More...
	getRowTemplateDir ()
	Get Row Template Directory. More...
	addBlockCommand ( $a_href, $a_text, $a_target="", $a_img="", $a_right_aligned=false, $a_checked=false, $a_html="")
	Add Block Command. More...
	getBlockCommands ()
	Get Block commands. More...
	addHeaderCommand ($a_href, $a_text, $a_as_close=false)
	Add Header Block Command. More...
	getHeaderCommands ()
	Get Header Block commands. More...
	addFooterLink ( $a_text, $a_href="", $a_onclick="", $a_block_id="", $a_top=false, $a_omit_separator=false, $a_checked=false)
	Add a footer text/link. More...
	getFooterLinks ()
	Get footer links. More...
	clearFooterLinks ()
	Clear footer links. More...
	handleDetailLevel ()
	Handle read/write current detail level. More...
	getHTML ()
	Handle config status. More...
	fillHeaderCommands ()
	Fill header commands block. More...
	fillHeaderTitleBlock ()
	Fill header title block (title and. More...
	setDataSection ($a_content)
	Call this from overwritten fillDataSection(), if standard row based data is not used. More...
	fillDataSection ()
	Standard implementation for row based data. More...
	fillRow ($a_set)
	fillFooter ()
	fillPreviousNext ()
	Fill previous/next row. More...
	setPreviousNextLinks ()
	Get previous/next linkbar. More...
	fillFooterLinks ($a_top=false, $a_numinfo="")
	Fill footer links. More...
	fillDetailRow ()
	Fill Detail Setting Row. More...

Static Public Attributes
static	$block_type = "pdcontent"

Protected Member Functions
	isRepositoryObject ()
Protected Member Functions inherited from ilBlockGUI
	isRepositoryObject ()
	Returns whether block has a corresponding repository object. More...
	fillRowColor ($a_placeholder="CSS_ROW")
	preloadData (array $data)
	Can be overwritten in subclasses. More...

Additional Inherited Members
Static Public Member Functions inherited from ilBlockGUI
static	getScreenMode ()
	Get Screen Mode for current command. More...
Protected Attributes inherited from ilBlockGUI
	$data = array()
	$colspan = 1
	$enablenuminfo = true
	$detail_min = 0
	$detail_max = 0
	$bigmode = false
	$footer_links = array()
	$block_id = 0
	$header_commands = array()
	$allow_moving = true
	$move = array("left" => false, "right" => false, "up" => false, "down" => false)
	$enabledetailrow = true
	$header_links = array()
	$footerinfo = false
	$footerinfo_icon = false
	$block_commands = array()
	$max_count = false
	$close_command = false
	$image = false
	$property = false
	$nav_value = ""
	$css_row = ""
	$dropdown
	$tpl
	$main_tpl
	$user
	$ctrl
	$access
	$lng
	$obj_def

Detailed Description

BlockGUI class for (centered) Content on Personal Desktop.

Author

Alex Killing alex..nosp@m.kill.nosp@m.ing@g.nosp@m.mx.d.nosp@m.e

Version

$Id$

Definition at line 32 of file class.ilPDContentBlockGUI.php.

Constructor & Destructor Documentation

__construct()

ilPDContentBlockGUI::__construct

(

)

Constructor.

Definition at line 39 of file class.ilPDContentBlockGUI.php.

References $DIC, ilBlockGUI\setBigMode(), ilBlockGUI\setEnableNumInfo(), ilBlockGUI\setLimit(), and user().

    {
        global $DIC;

        $this->ctrl = $DIC->ctrl();
        $this->lng = $DIC->language();
        $this->user = $DIC->user();

        parent::__construct();
        
        $this->setEnableNumInfo(false);
        $this->setLimit(99999);
        $this->setBigMode(true);
        $this->allow_moving = false;
    }

Here is the call graph for this function:

Member Function Documentation

fillDataSection()

ilPDContentBlockGUI::fillDataSection

(

)

Fill data section.

Definition at line 109 of file class.ilPDContentBlockGUI.php.

References getContent().

    {
        $this->tpl->setVariable("BLOCK_ROW", $this->getContent());
    }

Here is the call graph for this function:

fillFooter()

ilPDContentBlockGUI::fillFooter

(

)

block footer

Definition at line 117 of file class.ilPDContentBlockGUI.php.

References ilBlockGUI\$lng, data, ilBlockGUI\fillFooterLinks(), getCurrentItemNumber(), and ilBlockGUI\getEnableNumInfo().

    {
        //$this->fillFooterLinks();
        $lng = $this->lng;

        if (is_array($this->data)) {
            $this->max_count = count($this->data);
        }
                
        // table footer numinfo
        if ($this->getEnableNumInfo()) {
            $numinfo = "(" . $this->getCurrentItemNumber() . " " .
                strtolower($lng->txt("of")) . " " . $this->max_count . ")";
    
            if ($this->max_count > 0) {
                $this->tpl->setVariable("NUMINFO", $numinfo);
            }
            $this->fillFooterLinks(true, $numinfo);
        }
    }

Here is the call graph for this function:

fillPreviousNext()

ilPDContentBlockGUI::fillPreviousNext

(

)

Definition at line 138 of file class.ilPDContentBlockGUI.php.

    {
    }

getBlockType()

ilPDContentBlockGUI::getBlockType

(

)

Definition at line 58 of file class.ilPDContentBlockGUI.php.

                                   : string
    {
        return self::$block_type;
    }

getContent()

ilPDContentBlockGUI::getContent

(

)

Definition at line 96 of file class.ilPDContentBlockGUI.php.

Referenced by fillDataSection().

    {
        return $this->content;
    }

Here is the caller graph for this function:

getCurrentItemNumber()

ilPDContentBlockGUI::getCurrentItemNumber

(

)

Get Current Item Number.

Returns

int Current Item Number

Definition at line 78 of file class.ilPDContentBlockGUI.php.

Referenced by fillFooter().

    {
        return $this->currentitemnumber;
    }

Here is the caller graph for this function:

getHTML()

ilPDContentBlockGUI::getHTML

(

)

Definition at line 91 of file class.ilPDContentBlockGUI.php.

    {
        return parent::getHTML();
    }

isRepositoryObject()

ilPDContentBlockGUI::isRepositoryObject ( )

protected

Definition at line 86 of file class.ilPDContentBlockGUI.php.

                                            : bool
    {
        return false;
    }

setContent()

ilPDContentBlockGUI::setContent

(

$a_content

)

Definition at line 101 of file class.ilPDContentBlockGUI.php.

References $a_content.

    {
        $this->content = $a_content;
    }

setCurrentItemNumber()

ilPDContentBlockGUI::setCurrentItemNumber

(

$a_currentitemnumber

)

Set Current Item Number.

Parameters

int

$a_currentitemnumber

Current Item Number

Definition at line 68 of file class.ilPDContentBlockGUI.php.

    {
        $this->currentitemnumber = $a_currentitemnumber;
    }

Field Documentation

$block_type

ilPDContentBlockGUI::$block_type = "pdcontent"

static

Definition at line 34 of file class.ilPDContentBlockGUI.php.

---

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

• Services/PersonalDesktop/classes/class.ilPDContentBlockGUI.php