ilPCBlogGUI Class Reference

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...

Inheritance diagram for ilPCBlogGUI:

Collaboration diagram for ilPCBlogGUI:

Public Member Functions
	__construct (ilPageObject $a_pg_obj, ?ilPageContent $a_content_obj, string $a_hier_id, string $a_pc_id="")
	executeCommand ()
	execute command More...
	insert (?ilPropertyFormGUI $a_form=null)
	edit (?ilPropertyFormGUI $a_form=null)
	create ()
	Create new blog. More...
	update ()
	Update blog. More...
	insertPosting (int $a_blog_id, ?ilPropertyFormGUI $a_form=null)
	Insert new blog posting form. More...
	editPosting (int $a_blog_id, ?ilPropertyFormGUI $a_form=null)
	Edit blog posting form. More...
Public Member Functions inherited from ilPageContentGUI
	__construct (ilPageObject $a_pg_obj, ?ilPageContent $a_content_obj, string $a_hier_id="", string $a_pc_id="0")
	setContentObject (ilPageContent $a_val)
	getContentObject ()
	setPage (ilPageObject $a_val)
	getPage ()
	setPageConfig (ilPageConfig $a_val)
	getPageConfig ()
	setStyleId (int $a_styleid)
	getStyleId ()
	getStyle ()
	getCharacteristicsOfCurrentStyle (array $a_type)
	Get characteristics of current style and call setCharacteristics, if style is given. More...
	setCharacteristics (array $a_chars)
	getCharacteristics ()
	getHierId ()
	setHierId (string $a_hier_id)
	set hierarchical id in dom object More...
	delete ()
	displayValidationError ()
	cancelCreate ()
	cancel creating page content More...
	cancelUpdate ()
	cancel update More...
	cancel ()
	Cancel. More...
	deactivate ()
	gui function set enabled if is not enabled and vice versa More...
	cut ()
	Cut single element. More...
	copy ()
	Copy single element. More...
	getTemplateOptions (string $a_type="")
	Get table templates. More...

Protected Member Functions
	initForm (bool $a_insert=false)
	initPostingForm (int $a_blog_id, bool $a_insert=false)
	Init blog posting form. More...
Protected Member Functions inherited from ilPageContentGUI
	redirectToParent (string $hier_id="")
	getParentReturn (string $hier_id="")
	updateAndReturn ()
	setCurrentTextLang (string $lang_key)
	getCurrentTextLang ()
	setEditorToolContext ()
	initEditor ()
	getEditorScriptTag (string $form_pc_id="", string $form_cname="")

Protected Attributes
int	$requested_blog
int	$requested_blog_id
ilObjUser	$user
Protected Attributes inherited from ilPageContentGUI
ILIAS COPage Editor GUIService	$editor_gui
ILIAS COPage InternalGUIService	$gui
EditSessionRepository	$edit_repo
string	$pc_id = ""
array	$chars
ilObjStyleSheet	$style = null
LOMServices	$lom_services
ilLogger	$log
int	$styleid = 0
EditGUIRequest	$request
string	$sub_command = ""
int	$requested_ref_id = 0
ILIAS GlobalScreen ScreenContext ContextServices	$tool_context
Style Content CharacteristicManager	$char_manager

Additional Inherited Members
Static Public Member Functions inherited from ilPageContentGUI
static	_getCommonBBButtons ()
Data Fields inherited from ilPageContentGUI
ilPageContent	$content_obj
ilGlobalTemplateInterface	$tpl
ilLanguage	$lng
ilCtrl	$ctrl
ilPageObject	$pg_obj
string	$hier_id = ""
DOMDocument	$dom
	$updated
string	$target_script = ""
string	$return_location = ""
ilPageConfig	$page_config = null
Static Public Attributes inherited from ilPageContentGUI
static string	$style_selector_reset = "margin-top:2px; margin-bottom:2px; text-indent:0px; position:static; float:none; width: auto;"
Static Protected Attributes inherited from ilPageContentGUI
static array	$common_bb_buttons

Detailed Description

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V.

ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too.

If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning Class ilPCBlogGUI Handles user commands on blog data

Author

Jörg Lützenkirchen luetz.nosp@m.enki.nosp@m.rchen.nosp@m.@lei.nosp@m.fos.c.nosp@m.om

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

Constructor & Destructor Documentation

__construct()

ilPCBlogGUI::__construct	(	ilPageObject	$a_pg_obj,
		?ilPageContent	$a_content_obj,
		string	$a_hier_id,
		string	$a_pc_id = ""
	)

Definition at line 31 of file class.ilPCBlogGUI.php.

References $DIC, ILIAS\GlobalScreen\Provider\__construct(), ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), and ILIAS\Repository\user().

      {
        global $DIC;

        $this->tpl = $DIC["tpl"];
        $this->ctrl = $DIC->ctrl();
        $this->user = $DIC->user();
        $this->lng = $DIC->language();
        parent::__construct($a_pg_obj, $a_content_obj, $a_hier_id, $a_pc_id);

        // ... not sure why different ids are used for this...
        $this->requested_blog_id = $this->request->getInt("blog_id");
        $this->requested_blog = $this->request->getInt("blog");
    }

Here is the call graph for this function:

Member Function Documentation

create()

ilPCBlogGUI::create

(

)

Create new blog.

Definition at line 135 of file class.ilPCBlogGUI.php.

References ILIAS\Repository\ctrl(), ilPageContentGUI\getPage(), initForm(), initPostingForm(), insert(), and insertPosting().

                            : void
    {
        if ($this->requested_blog_id == 0) {
            $form = $this->initForm(true);
            if ($form->checkInput()) {
                $this->insertPosting($this->requested_blog);
                return;
            }

            $form->setValuesByPost();
            $this->insert($form);
        } else {
            $form = $this->initPostingForm($this->requested_blog_id, true);
            if ($form->checkInput()) {
                $this->content_obj = new ilPCBlog($this->getPage());
                $this->content_obj->create($this->pg_obj, $this->hier_id, $this->pc_id);
                $this->content_obj->setData($form->getInput("blog_id"), $form->getInput("posting"));
                $this->updated = $this->pg_obj->update();
                if ($this->updated === true) {
                    $this->ctrl->returnToParent($this, "jump" . $this->hier_id);
                }
            }

            $form->setValuesByPost();
            $this->insertPosting($this->requested_blog_id, $form);
        }
    }

Here is the call graph for this function:

edit()

ilPCBlogGUI::edit

(

?ilPropertyFormGUI

$a_form = null

)

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

References ilPageContentGUI\$tpl, ilPageContentGUI\displayValidationError(), initForm(), and ILIAS\UICore\GlobalTemplate\setContent().

Referenced by update().

                                                           : void
    {
        $tpl = $this->tpl;

        $this->displayValidationError();

        if (!$a_form) {
            $a_form = $this->initForm();
        }
        $tpl->setContent($a_form->getHTML());
    }

Here is the call graph for this function:

Here is the caller graph for this function:

editPosting()

ilPCBlogGUI::editPosting	(	int	$a_blog_id,
		?ilPropertyFormGUI	$a_form = null
	)

Edit blog posting form.

Definition at line 215 of file class.ilPCBlogGUI.php.

References ilPageContentGUI\$tpl, ilPageContentGUI\displayValidationError(), initPostingForm(), and ILIAS\UICore\GlobalTemplate\setContent().

Referenced by update().

     : void {
        $tpl = $this->tpl;

        $this->displayValidationError();

        if (!$a_form) {
            $a_form = $this->initPostingForm($a_blog_id);
        }
        $tpl->setContent($a_form->getHTML());
    }

Here is the call graph for this function:

Here is the caller graph for this function:

executeCommand()

ilPCBlogGUI::executeCommand

(

)

execute command

Definition at line 53 of file class.ilPCBlogGUI.php.

References ILIAS\Repository\ctrl().

                                    : string
    {
        // get next class that processes or forwards current command
        $next_class = $this->ctrl->getNextClass($this);

        // get current command
        $cmd = $this->ctrl->getCmd();

        switch ($next_class) {
            default:
                $ret = $this->$cmd();
                break;
        }

        return (string) $ret;
    }

Here is the call graph for this function:

initForm()

ilPCBlogGUI::initForm ( bool  $a_insert = false )

protected

Definition at line 94 of file class.ilPCBlogGUI.php.

References ilPageContentGUI\$ctrl, $user, ilObject\_lookupTitle(), ILIAS\Repository\lng(), ilBlogPosting\searchBlogsByAuthor(), and ilFormPropertyGUI\setRequired().

Referenced by create(), edit(), insert(), and update().

                                                       : ilPropertyFormGUI
    {
        $ilCtrl = $this->ctrl;
        $ilUser = $this->user;

        $form = new ilPropertyFormGUI();
        $form->setFormAction($ilCtrl->getFormAction($this));
        if ($a_insert) {
            $form->setTitle($this->lng->txt("cont_insert_blog"));
        } else {
            $form->setTitle($this->lng->txt("cont_update_blog"));
        }

        $options = array();
        $blogs_ids = ilBlogPosting::searchBlogsByAuthor($ilUser->getId());
        if ($blogs_ids) {
            foreach ($blogs_ids as $blog_id) {
                $options[$blog_id] = ilObject::_lookupTitle($blog_id);
            }
            asort($options);
        }
        $obj = new ilSelectInputGUI($this->lng->txt("cont_pc_blog"), "blog");
        $obj->setRequired(true);
        $obj->setOptions($options);
        $form->addItem($obj);

        if ($a_insert) {
            $form->addCommandButton("create", $this->lng->txt("select"));
            $form->addCommandButton("cancelCreate", $this->lng->txt("cancel"));
        } else {
            $obj->setValue($this->content_obj->getBlogId());
            $form->addCommandButton("update", $this->lng->txt("select"));
            $form->addCommandButton("cancelUpdate", $this->lng->txt("cancel"));
        }

        return $form;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

initPostingForm()

ilPCBlogGUI::initPostingForm ( int  $a_blog_id, bool  $a_insert = false  )

protected

Init blog posting form.

Definition at line 232 of file class.ilPCBlogGUI.php.

References ilPageContentGUI\$ctrl, $post, $user, ilDatePresentation\formatDate(), ilBlogPosting\getAllPostings(), IL_CAL_DATETIME, ILIAS\Repository\lng(), and ilFormPropertyGUI\setRequired().

Referenced by create(), editPosting(), insertPosting(), and update().

     : ilPropertyFormGUI {
        $ilCtrl = $this->ctrl;
        $ilUser = $this->user;

        $form = new ilPropertyFormGUI();
        $form->setFormAction($ilCtrl->getFormAction($this));
        if ($a_insert) {
            $form->setTitle($this->lng->txt("cont_insert_blog"));
        } else {
            $form->setTitle($this->lng->txt("cont_update_blog"));
        }

        $options = array();
        $postings = ilBlogPosting::getAllPostings($a_blog_id);
        if ($postings) {
            foreach ($postings as $post) {
                // could be posting from someone else
                if ($post["author"] == $ilUser->getId()) {
                    $date = new ilDateTime($post["date"], IL_CAL_DATETIME);
                    $title = $post["title"] . " - " .
                        ilDatePresentation::formatDate($date);

                    $cbox = new ilCheckboxInputGUI($title, "posting");
                    $cbox->setValue($post["id"]);

                    $options[] = $cbox;
                }
            }
        }
        asort($options);
        $obj = new ilCheckboxGroupInputGUI($this->lng->txt("cont_pc_blog_posting"), "posting");
        $obj->setRequired(true);
        $obj->setOptions($options);
        $form->addItem($obj);

        $blog_id = new ilHiddenInputGUI("blog_id");
        $blog_id->setValue($a_blog_id);
        $form->addItem($blog_id);

        if ($a_insert) {
            $form->addCommandButton("create", $this->lng->txt("save"));
            $form->addCommandButton("cancelCreate", $this->lng->txt("cancel"));
        } else {
            $obj->setValue($this->content_obj->getPostings());
            $form->addCommandButton("update", $this->lng->txt("save"));
            $form->addCommandButton("cancelUpdate", $this->lng->txt("cancel"));
        }

        return $form;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

insert()

ilPCBlogGUI::insert

(

?ilPropertyFormGUI

$a_form = null

)

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

References ilPageContentGUI\$tpl, ilPageContentGUI\displayValidationError(), initForm(), and ILIAS\UICore\GlobalTemplate\setContent().

Referenced by create().

                                                             : void
    {
        $tpl = $this->tpl;

        $this->displayValidationError();

        if (!$a_form) {
            $a_form = $this->initForm(true);
        }
        $tpl->setContent($a_form->getHTML());
    }

Here is the call graph for this function:

Here is the caller graph for this function:

insertPosting()

ilPCBlogGUI::insertPosting	(	int	$a_blog_id,
		?ilPropertyFormGUI	$a_form = null
	)

Insert new blog posting form.

Definition at line 198 of file class.ilPCBlogGUI.php.

References ilPageContentGUI\$tpl, ilPageContentGUI\displayValidationError(), initPostingForm(), and ILIAS\UICore\GlobalTemplate\setContent().

Referenced by create().

     : void {
        $tpl = $this->tpl;

        $this->displayValidationError();

        if (!$a_form) {
            $a_form = $this->initPostingForm($a_blog_id, true);
        }
        $tpl->setContent($a_form->getHTML());
    }

Here is the call graph for this function:

Here is the caller graph for this function:

update()

ilPCBlogGUI::update

(

)

Update blog.

Definition at line 166 of file class.ilPCBlogGUI.php.

References ILIAS\Repository\ctrl(), edit(), editPosting(), initForm(), and initPostingForm().

                            : void
    {
        if ($this->requested_blog_id == 0) {
            $form = $this->initForm();
            if ($form->checkInput()) {
                $this->editPosting($this->requested_blog);
                return;
            }

            $this->pg_obj->addHierIDs();
            $form->setValuesByPost();
            $this->edit($form);
        } else {
            $form = $this->initPostingForm($this->requested_blog_id);
            if ($form->checkInput()) {
                $this->content_obj->setData($form->getInput("blog_id"), $form->getInput("posting"));
                $this->updated = $this->pg_obj->update();
                if ($this->updated === true) {
                    $this->ctrl->returnToParent($this, "jump" . $this->hier_id);
                }
            }

            $this->pg_obj->addHierIDs();
            $form->setValuesByPost();
            $this->editPosting($this->requested_blog_id, $form);
        }
    }

Here is the call graph for this function:

Field Documentation

$requested_blog

int ilPCBlogGUI::$requested_blog

protected

Definition at line 27 of file class.ilPCBlogGUI.php.

$requested_blog_id

int ilPCBlogGUI::$requested_blog_id

protected

Definition at line 28 of file class.ilPCBlogGUI.php.

$user

ilObjUser ilPCBlogGUI::$user

protected

Definition at line 29 of file class.ilPCBlogGUI.php.

Referenced by initForm(), and initPostingForm().

---

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

• components/ILIAS/COPage/PC/Blog/class.ilPCBlogGUI.php