ilLikeGUI Class Reference

User interface for like feature. More...

Collaboration diagram for ilLikeGUI:

Public Member Functions
	__construct (\ilLikeData $data, ?\ilTemplate $main_tpl=null)
	setObject (int $a_obj_id, string $a_obj_type, int $a_sub_obj_id=0, string $a_sub_obj_type="", int $a_news_id=0)
	executeCommand ()
	getHTML ()
	renderEmoticons ()
	Render emoticons (asynch) More...
	renderModal ()
	Render modal (asynch) More...

Static Public Member Functions
static	getExpressionText (int $a_const)
	Get expression text for const. More...

Protected Member Functions
	initJavascript ()
	renderEmoCounters (?ILIAS\UI\Component\Signal $modal_signal=null, bool $unavailable=false)
	Render emo counters. More...
	getGlyphForConst (int $a_const, bool $unavailable=false)
	saveExpression ()
	Save expression (asynch) More...

Protected Attributes
ILIAS Like InternalGUIService	$gui
ilLikeData	$data
ILIAS DI UIServices	$ui
ilGlobalTemplateInterface	$main_tpl
StandardGUIRequest	$request
ilLanguage	$lng
ilCtrl	$ctrl
ilObjUser	$user
int	$obj_id
string	$obj_type
int	$sub_obj_id
string	$sub_obj_type
int	$news_id
string	$dom_id

Detailed Description

User interface for like feature.

Author

Alexander Killing killi.nosp@m.ng@l.nosp@m.eifos.nosp@m..de

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

Constructor & Destructor Documentation

__construct()

ilLikeGUI::__construct	(	\ilLikeData	$data,
		?\ilTemplate	$main_tpl = null
	)

Definition at line 42 of file class.ilLikeGUI.php.

References $data, $DIC, $main_tpl, ILIAS\Repository\ctrl(), initJavascript(), ILIAS\Repository\lng(), null, ILIAS\Repository\ui(), and ILIAS\Repository\user().

      {
        global $DIC;

        $this->main_tpl = ($main_tpl == null)
            ? $DIC->ui()->mainTemplate()
            : $main_tpl;

        $this->gui = $DIC->like()->internal()->gui();

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

        $this->data = $data;

        $this->lng->loadLanguageModule("like");
        $this->request = new StandardGUIRequest(
            $DIC->http(),
            $DIC->refinery()
        );

        $this->initJavascript();
    }

Here is the call graph for this function:

Member Function Documentation

executeCommand()

ilLikeGUI::executeCommand

(

)

Definition at line 97 of file class.ilLikeGUI.php.

References $ctrl, and ilCtrl\getNextClass().

                                    : string
    {
        $ilCtrl = $this->ctrl;

        $next_class = $ilCtrl->getNextClass($this);
        $cmd = $ilCtrl->getCmd("getHTML");

        switch ($next_class) {
            default:
                if (in_array($cmd, array("getHTML", "renderEmoticons", "renderModal", "saveExpression"))) {
                    return $this->$cmd();
                }
                break;
        }
        return "";
    }

Here is the call graph for this function:

getExpressionText()

static ilLikeGUI::getExpressionText ( int  $a_const )

static

Get expression text for const.

Definition at line 364 of file class.ilLikeGUI.php.

References $DIC, ilLanguage\txt(), ilLikeData\TYPE_ANGRY, ilLikeData\TYPE_ASTOUNDED, ilLikeData\TYPE_DISLIKE, ilLikeData\TYPE_LAUGH, ilLikeData\TYPE_LIKE, ilLikeData\TYPE_LOVE, and ilLikeData\TYPE_SAD.

Referenced by ilMembershipCronNotifications\run().

     : string {
        global $DIC;

        $lng = $DIC->language();

        switch ($a_const) {
            case ilLikeData::TYPE_LIKE: return $lng->txt("like");
            case ilLikeData::TYPE_DISLIKE: return $lng->txt("dislike");
            case ilLikeData::TYPE_LOVE: return $lng->txt("love");
            case ilLikeData::TYPE_LAUGH: return $lng->txt("laugh");
            case ilLikeData::TYPE_ASTOUNDED: return $lng->txt("astounded");
            case ilLikeData::TYPE_SAD: return $lng->txt("sad");
            case ilLikeData::TYPE_ANGRY: return $lng->txt("angry");
        }
        return "";
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getGlyphForConst()

ilLikeGUI::getGlyphForConst ( int  $a_const, bool  $unavailable = false  )

protected

Definition at line 196 of file class.ilLikeGUI.php.

References Vendor\Package\$f, null, ilLikeData\TYPE_ANGRY, ilLikeData\TYPE_ASTOUNDED, ilLikeData\TYPE_DISLIKE, ilLikeData\TYPE_LAUGH, ilLikeData\TYPE_LIKE, ilLikeData\TYPE_LOVE, ilLikeData\TYPE_SAD, and ILIAS\Repository\ui().

Referenced by renderEmoCounters(), renderEmoticons(), and renderModal().

     : ?\ILIAS\UI\Component\Symbol\Glyph\Glyph {
        $f = $this->ui->factory();
        $like = null;
        switch ($a_const) {
            case ilLikeData::TYPE_LIKE: $like = $f->symbol()->glyph()->like();
                break;
            case ilLikeData::TYPE_DISLIKE: $like = $f->symbol()->glyph()->dislike();
                break;
            case ilLikeData::TYPE_LOVE: $like = $f->symbol()->glyph()->love();
                break;
            case ilLikeData::TYPE_LAUGH: $like = $f->symbol()->glyph()->laugh();
                break;
            case ilLikeData::TYPE_ASTOUNDED: $like = $f->symbol()->glyph()->astounded();
                break;
            case ilLikeData::TYPE_SAD: $like = $f->symbol()->glyph()->sad();
                break;
            case ilLikeData::TYPE_ANGRY: $like = $f->symbol()->glyph()->angry();
                break;
        }
        if ($unavailable) {
            $like = $like->withUnavailableAction();
        }
        return $like;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getHTML()

ilLikeGUI::getHTML

(

)

Definition at line 114 of file class.ilLikeGUI.php.

References $ctrl, Vendor\Package\$f, $lng, $r, ILIAS\Repository\ctrl(), ilCtrl\getLinkTarget(), renderEmoCounters(), ilCtrl\setParameter(), ilLanguage\txt(), ILIAS\Repository\ui(), and ILIAS\GlobalScreen\Scope\Footer\Factory\withTitle().

                             : string
    {
        $f = $this->ui->factory();
        $r = $this->ui->renderer();
        $ctrl = $this->ctrl;
        $lng = $this->lng;

        $tpl = new ilTemplate("tpl.like.html", true, true, "components/ILIAS/Like");

        // modal
        $modal_asyn_url = $ctrl->getLinkTarget($this, "renderModal", "", true, false);
        $modal = $f->modal()->roundtrip('', $f->legacy()->content(""))
            ->withAsyncRenderUrl($modal_asyn_url);

        $modal_show_sig_id = $modal->getShowSignal()->getId();
        $this->ctrl->setParameter($this, "modal_show_sig_id", $modal_show_sig_id);
        $emo_counters = $this->renderEmoCounters($modal->getShowSignal());
        $tpl->setVariable("EMO_COUNTERS", $emo_counters . $r->render($modal));



        // emoticon popover
        $popover = $f->popover()->standard($f->legacy()->content(''))->withTitle('');
        $ctrl->setParameter($this, "repl_sig", $popover->getReplaceContentSignal()->getId());
        $asyn_url = $ctrl->getLinkTarget($this, "renderEmoticons", "", true, false);
        $popover = $popover->withAsyncContentUrl($asyn_url);
        $button = $f->button()->shy($lng->txt("like"), '#')
            ->withOnClick($popover->getShowSignal());

        $tpl->setVariable("LIKE", $r->render([$popover, $button]));

        return $tpl->get();
    }

Here is the call graph for this function:

initJavascript()

ilLikeGUI::initJavascript ( )

protected

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

Referenced by __construct().

                                       : void
    {
        $debug = false;
        $this->gui->initFetch();
        if ($debug) {
            $this->main_tpl->addJavaScript("../components/ILIAS/Like/resources/Like.js");
        } else {
            $this->main_tpl->addJavaScript("assets/js/Like.js");
        }
    }

Here is the caller graph for this function:

renderEmoCounters()

ilLikeGUI::renderEmoCounters ( ?ILIAS\UI\Component\Signal  $modal_signal = null, bool  $unavailable = false  )

protected

Render emo counters.

Exceptions

ilLikeDataException

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

References $ctrl, Vendor\Package\$f, $r, $txt, getGlyphForConst(), null, and ILIAS\Repository\ui().

Referenced by getHTML(), renderModal(), and saveExpression().

     : string {
        $ilCtrl = $this->ctrl;

        $tpl = new ilTemplate("tpl.emo_counters.html", true, true, "components/ILIAS/Like");
        $f = $this->ui->factory();
        $r = $this->ui->renderer();

        $cnts = $this->data->getExpressionCounts(
            $this->obj_id,
            $this->obj_type,
            $this->sub_obj_id,
            $this->sub_obj_type,
            $this->news_id
        );
        $comps = array();
        foreach ($this->data->getExpressionTypes() as $k => $txt) {
            if ($cnts[$k] > 0) {
                $glyph = $this->getGlyphForConst($k, $unavailable);
                if ($modal_signal !== null) {
                    $glyph = $glyph->withOnClick($modal_signal);
                }
                $comps[] = $glyph->withCounter($f->counter()->status($cnts[$k]));
            }
        }

        if ($ilCtrl->isAsynch()) {
            $tpl->setVariable("MODAL_TRIGGER", $r->renderAsync($comps));
        } else {
            $tpl->setVariable("MODAL_TRIGGER", $r->render($comps));
        }
        if ($modal_signal !== null) {
            $tpl->setVariable("ID", $this->dom_id);
        }

        if (count($comps) > 0 && $modal_signal !== null) {
            $tpl->setVariable("SEP", $r->render($f->divider()->vertical()));
        }

        return $tpl->get();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

renderEmoticons()

ilLikeGUI::renderEmoticons

(

)

Render emoticons (asynch)

Definition at line 227 of file class.ilLikeGUI.php.

References $ctrl, $id, $news_id, $obj_id, $obj_type, $r, $sub_obj_id, $sub_obj_type, $txt, $url, exit, getGlyphForConst(), and ILIAS\Repository\ui().

                                     : void
    {
        $ilCtrl = $this->ctrl;
        $r = $this->ui->renderer();
        $glyphs = [];

        $ilCtrl->saveParameter($this, "modal_show_sig_id");

        $tpl = new ilTemplate("tpl.emoticons.html", true, true, "components/ILIAS/Like");
        $tpl->setVariable("ID", $this->dom_id);

        $url = $ilCtrl->getLinkTarget($this, "", "", true);
        foreach ($this->data->getExpressionTypes() as $k => $txt) {
            $g = $this->getGlyphForConst($k);

            if ($this->data->isExpressionSet(
                $this->user->getId(),
                $k,
                $this->obj_id,
                $this->obj_type,
                $this->sub_obj_id,
                $this->sub_obj_type,
                $this->news_id
            )) {
                $g = $g->withHighlight();
            }

            $g = $g->withAdditionalOnLoadCode(function ($id) use ($k, $url) {
                return
                    "$('#" . $id . "').click(function() { il.Like.toggle('" . $url . "','" . $id . "','" . $this->dom_id . "'," . $k . ");});";
            });
            $glyphs[] = $g;
        }

        $tpl->setVariable("GLYPHS", $r->renderAsync($glyphs));

        echo $tpl->get();
        exit;
    }

Here is the call graph for this function:

renderModal()

ilLikeGUI::renderModal

(

)

Render modal (asynch)

Exceptions

ilDateTimeException
ilLikeDataException
ilWACException

Definition at line 310 of file class.ilLikeGUI.php.

References Vendor\Package\$f, $r, $user, ilObjUser\_getPersonalPicturePath(), exit, ilDatePresentation\formatDate(), getGlyphForConst(), ilUserUtil\getNamePresentation(), IL_CAL_DATETIME, null, renderEmoCounters(), and ILIAS\Repository\ui().

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

        $f = $this->ui->factory();
        $r = $this->ui->renderer();


        $list_items = [];

        $glyph_renderings = [];
        foreach ($this->data->getExpressionEntries(
            $this->obj_id,
            $this->obj_type,
            $this->sub_obj_id,
            $this->sub_obj_type,
            $this->news_id
        ) as $exp) {
            $name = ilUserUtil::getNamePresentation($exp["user_id"]);

            $image = $f->image()->responsive(
                ilObjUser::_getPersonalPicturePath($exp["user_id"]),
                $name
            );

            $g = $this->getGlyphForConst($exp["expression"], true);
            $placeholder = "###" . $exp["expression"] . "###";
            $glyph_renderings[$placeholder] = $r->render($g);

            $list_items[] = $f->item()->standard($name)
                ->withDescription($placeholder . " " .
                    ilDatePresentation::formatDate(new ilDateTime($exp["timestamp"], IL_CAL_DATETIME)))
                ->withLeadImage($image);
        }

        $std_list = $f->panel()->listing()->standard("", array(
            $f->item()->group("", $list_items)
        ));

        $header = $f->legacy()->content($this->renderEmoCounters(null, true));
        //$header = $f->legacy("---");

        $modal = $f->modal()->roundtrip('', [$header, $std_list]);
        $html = $r->render($modal);
        foreach ($glyph_renderings as $pl => $gl) {
            $html = str_replace($pl, $gl, $html);
        }
        echo $html;
        exit;
    }

Here is the call graph for this function:

saveExpression()

ilLikeGUI::saveExpression ( )

protected

Save expression (asynch)

Exceptions

ilLikeDataException

Definition at line 271 of file class.ilLikeGUI.php.

References $news_id, $obj_id, $obj_type, $sub_obj_id, $sub_obj_type, exit, renderEmoCounters(), and ILIAS\Repository\user().

                                       : void
    {
        $exp_key = $this->request->getExpressionKey();
        $exp_val = $this->request->getValue();
        $modal_show_sig_id = $this->request->getModalSignalId();
        $show_signal = new \ILIAS\UI\Implementation\Component\Signal($modal_show_sig_id);

        if ($exp_val) {
            $this->data->addExpression(
                $this->user->getId(),
                $exp_key,
                $this->obj_id,
                $this->obj_type,
                $this->sub_obj_id,
                $this->sub_obj_type,
                $this->news_id
            );
        } else {
            $this->data->removeExpression(
                $this->user->getId(),
                $exp_key,
                $this->obj_id,
                $this->obj_type,
                $this->sub_obj_id,
                $this->sub_obj_type,
                $this->news_id
            );
        }
        echo $this->renderEmoCounters($show_signal);
        exit;
    }

Here is the call graph for this function:

setObject()

ilLikeGUI::setObject	(	int	$a_obj_id,
		string	$a_obj_type,
		int	$a_sub_obj_id = 0,
		string	$a_sub_obj_type = "",
		int	$a_news_id = 0
	)

Definition at line 81 of file class.ilLikeGUI.php.

References $news_id.

     : void {
        $this->obj_id = $a_obj_id;
        $this->obj_type = $a_obj_type;
        $this->sub_obj_id = $a_sub_obj_id;
        $this->sub_obj_type = $a_sub_obj_type;
        $this->news_id = $a_news_id;
        $this->dom_id = "like_" . $this->obj_id . "_" . $this->obj_type . "_" . $this->sub_obj_id . "_" .
            $this->sub_obj_type . "_" . $this->news_id;
    }

Field Documentation

$ctrl

ilCtrl ilLikeGUI::$ctrl

protected

Definition at line 33 of file class.ilLikeGUI.php.

Referenced by executeCommand(), getHTML(), renderEmoCounters(), and renderEmoticons().

$data

ilLikeData ilLikeGUI::$data

protected

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

Referenced by __construct().

$dom_id

string ilLikeGUI::$dom_id

protected

Definition at line 40 of file class.ilLikeGUI.php.

$gui

ILIAS Like InternalGUIService ilLikeGUI::$gui

protected

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

$lng

ilLanguage ilLikeGUI::$lng

protected

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

Referenced by getHTML().

$main_tpl

ilGlobalTemplateInterface ilLikeGUI::$main_tpl

protected

Definition at line 30 of file class.ilLikeGUI.php.

Referenced by __construct().

$news_id

int ilLikeGUI::$news_id

protected

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

Referenced by renderEmoticons(), saveExpression(), and setObject().

$obj_id

int ilLikeGUI::$obj_id

protected

Definition at line 35 of file class.ilLikeGUI.php.

Referenced by renderEmoticons(), and saveExpression().

$obj_type

string ilLikeGUI::$obj_type

protected

Definition at line 36 of file class.ilLikeGUI.php.

Referenced by renderEmoticons(), and saveExpression().

$request

StandardGUIRequest ilLikeGUI::$request

protected

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

$sub_obj_id

int ilLikeGUI::$sub_obj_id

protected

Definition at line 37 of file class.ilLikeGUI.php.

Referenced by renderEmoticons(), and saveExpression().

$sub_obj_type

string ilLikeGUI::$sub_obj_type

protected

Definition at line 38 of file class.ilLikeGUI.php.

Referenced by renderEmoticons(), and saveExpression().

$ui

ILIAS DI UIServices ilLikeGUI::$ui

protected

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

$user

ilObjUser ilLikeGUI::$user

protected

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

Referenced by renderModal().

---

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

• components/ILIAS/Like/classes/class.ilLikeGUI.php