ilForumPostingDraftsBlockGUI Class Reference

Class ilForumPostingDraftsBlockGUI. More...

Inheritance diagram for ilForumPostingDraftsBlockGUI:

Collaboration diagram for ilForumPostingDraftsBlockGUI:

Public Member Functions
	__construct ()
	Constructor. More...
	executeCommand ()
	getBlockType ()
	getHTML ()
	{} More...
	fillRow ($draft)
	{} More...
	fillDataSection ()
	{} More...
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 = 'pdfrmpostdraft'

Protected Member Functions
	isRepositoryObject ()
	getOverview ()
	Get overview. More...
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...

Private Attributes
	$settings

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

Class ilForumPostingDraftsBlockGUI.

Author

Michael Jansen mjans.nosp@m.en@d.nosp@m.ataba.nosp@m.y.de

ilForumPostingDraftsBlockGUI: ilColumnGUI

Definition at line 10 of file class.ilForumPostingDraftsBlockGUI.php.

Constructor & Destructor Documentation

__construct()

ilForumPostingDraftsBlockGUI::__construct

(

)

Constructor.

Definition at line 25 of file class.ilForumPostingDraftsBlockGUI.php.

References $DIC, ilUtil\getImagePath(), ilBlockGUI\setAvailableDetailLevels(), ilBlockGUI\setImage(), ilBlockGUI\setLimit(), settings(), and ilBlockGUI\setTitle().

    {
        global $DIC;

        parent::__construct();
        
        $this->settings = $DIC->settings();
        
        $this->lng->loadLanguageModule('forum');

        $this->setLimit(5);
        $this->setImage(ilUtil::getImagePath('icon_frm.svg'));
        $this->setTitle($this->lng->txt('frm_my_posting_drafts'));
        $this->setAvailableDetailLevels(3);
        $this->allow_moving = true;
    }

Here is the call graph for this function:

Member Function Documentation

executeCommand()

ilForumPostingDraftsBlockGUI::executeCommand

(

)

Returns

string

Definition at line 45 of file class.ilForumPostingDraftsBlockGUI.php.

    {
        $cmd = $this->ctrl->getCmd('getHTML');
        return $this->$cmd();
    }

fillDataSection()

ilForumPostingDraftsBlockGUI::fillDataSection

(

)

{}

Definition at line 95 of file class.ilForumPostingDraftsBlockGUI.php.

References ilBlockGUI\$data, PHPMailer\PHPMailer\$params, ilObject\_getAllReferences(), ilLink\_getLink(), ilForum\_lookupObjIdForForumId(), ilForumUtil\collectPostInformationByPostId(), data, ilBlockGUI\getCurrentDetailLevel(), ilForumPostDraft\getDraftInstancesByUserId(), getOverview(), ilBlockGUI\setColSpan(), ilBlockGUI\setData(), ilBlockGUI\setDataSection(), ilBlockGUI\setEnableDetailRow(), ilBlockGUI\setEnableNumInfo(), ilBlockGUI\setRowTemplate(), and user().

    {
        $drafts_instances = ilForumPostDraft::getDraftInstancesByUserId($this->user->getId());
        
        $draft_as_array = array();
        $data = array();
        if (is_array($drafts_instances) && count($drafts_instances) > 0) {
            foreach ($drafts_instances as $draft) {
                $is_thread = false;
                if ((int) $draft->getThreadId() == 0) {
                    $is_thread = true;
                }
                
                $draft_as_array['subject'] = $draft->getPostSubject();
                $draft_as_array['draft_id'] = $draft->getDraftId();
                
                $information = ilForumUtil::collectPostInformationByPostId($draft->getPostId());
                $draft_as_array['source'] = implode('/', $information);
                $draft_as_array['create_date'] = $draft->getPostDate();
                
                $obj_id = ilForum::_lookupObjIdForForumId($draft->getForumId());
                $ref_id = end(ilObject::_getAllReferences($obj_id));
                
                if ($is_thread) {
                    $params['cmd'] = 'editThreadDraft';
                    $params['draft_id'] = $draft->getDraftId();
                    $draft_as_array['href'] = ilLink::_getLink($ref_id, 'frm', $params);
                } else {
                    $params['thr_pk'] = $draft->getThreadId();
                    $params['pos_pk'] = $draft->getPostId();
                    $params['cmd'] = 'viewThread';
                    $draft_as_array['href'] = ilLink::_getLink($ref_id, 'frm', $params) . '#draft_' . $draft->getDraftId();
                }
                
                $data[] = $draft_as_array;
            }
        }
        $this->setData($data);

        if ($this->getCurrentDetailLevel() > 1 && count($this->data) > 0) {
            $this->setRowTemplate('tpl.pd_frm_posting_drafts_row.html', 'Modules/Forum');
            if ($this->getCurrentDetailLevel() > 2) {
                $this->setColSpan(2);
            }
            parent::fillDataSection();
        } else {
            $this->setEnableNumInfo(false);
            if (count($this->data) == 0) {
                $this->setEnableDetailRow(false);
            }
            $this->setDataSection($this->getOverview());
        }
    }

Here is the call graph for this function:

fillRow()

ilForumPostingDraftsBlockGUI::fillRow

(

$draft

)

{}

Definition at line 82 of file class.ilForumPostingDraftsBlockGUI.php.

References ilDatePresentation\formatDate(), ilBlockGUI\getCurrentDetailLevel(), and IL_CAL_DATETIME.

    {
        $this->tpl->setVariable('SUBJECT', $draft['subject']);
        $this->tpl->setVariable('SOURCE', $draft['source']);
        $this->tpl->setVariable("HREF", $draft['href']);
        if ($this->getCurrentDetailLevel() > 2) {
            $this->tpl->setVariable('CREATE_DATE', ilDatePresentation::formatDate(new ilDateTime($draft['create_date'], IL_CAL_DATETIME)));
        }
    }

Here is the call graph for this function:

getBlockType()

ilForumPostingDraftsBlockGUI::getBlockType

(

)

Definition at line 54 of file class.ilForumPostingDraftsBlockGUI.php.

                                   : string
    {
        return self::$block_type;
    }

getHTML()

ilForumPostingDraftsBlockGUI::getHTML

(

)

{}

Definition at line 70 of file class.ilForumPostingDraftsBlockGUI.php.

References ilBlockGUI\getCurrentDetailLevel(), and settings().

    {
        if ($this->getCurrentDetailLevel() == 0 || !$this->settings->get('save_post_drafts', 0) || !$this->settings->get('block_activated_pdfrmpostdraft', 0)) {
            return '';
        } else {
            return parent::getHTML();
        }
    }

Here is the call graph for this function:

getOverview()

ilForumPostingDraftsBlockGUI::getOverview ( )

protected

Get overview.

Definition at line 152 of file class.ilForumPostingDraftsBlockGUI.php.

References ilBlockGUI\$tpl, and data.

Referenced by fillDataSection().

    {
        $tpl = new ilTemplate('tpl.pd_frm_posting_drafts_row.html', true, true, 'Modules/Forum');
        $tpl->setCurrentBlock('overview');
        $tpl->setVariable('NUM_FRM_POSTING_DRAFTS', count($this->data));
        if (count($this->data) == 1) {
            $tpl->setVariable('TXT_FRM_POSTING_DRAFTS', $this->lng->txt('frm_posting_draft'));
        } else {
            $tpl->setVariable('TXT_FRM_POSTING_DRAFTS', $this->lng->txt('frm_posting_drafts'));
        }
        $tpl->parseCurrentBlock();

        return $tpl->get();
    }

Here is the caller graph for this function:

isRepositoryObject()

ilForumPostingDraftsBlockGUI::isRepositoryObject ( )

protected

Definition at line 62 of file class.ilForumPostingDraftsBlockGUI.php.

                                            : bool
    {
        return false;
    }

Field Documentation

$block_type

ilForumPostingDraftsBlockGUI::$block_type = 'pdfrmpostdraft'

static

Definition at line 15 of file class.ilForumPostingDraftsBlockGUI.php.

$settings

ilForumPostingDraftsBlockGUI::$settings

private

Definition at line 20 of file class.ilForumPostingDraftsBlockGUI.php.

---

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

• Modules/Forum/classes/class.ilForumPostingDraftsBlockGUI.php