trait.ilObjFileNews.php File Reference

Go to the source code of this file.

Functions
	notifyCreation (int $obj_id, ?string $additional_message=null)
	enableNotification ()
	notifyUpdate (int $obj_id, ?string $additional_message=null)
	addNewsNotification (int $obj_id, string $a_lang_var, ?string $description=null)

Variables
trait	ilObjFileNews
	This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...
bool	$notify = false

Function Documentation

addNewsNotification()

addNewsNotification ( int  $obj_id, string  $a_lang_var, ?string  $description = null  )

protected

Definition at line 52 of file trait.ilObjFileNews.php.

                                                                                                        : void
    {
        global $DIC;
 
        // ilHistory::_createEntry($this->getId(), "create", $this->getFileName() . ",1" . ",1");
 
        // Add Notification to news
        $news_item = new ilNewsItem();
        $news_item->setContext($obj_id, 'file');
        $news_item->setPriority(NEWS_NOTICE);
        $news_item->setTitle($a_lang_var);
        $news_item->setContentIsLangVar(true);
        if ($description && $description !== '') {
            $news_item->setContent("<p>" . $description . "</p>");
        }
        $news_item->setUserId($DIC->user()->getId());
        $news_item->setVisibility(NEWS_USERS);
        $news_item->create();
    }

References $DIC, NEWS_NOTICE, and NEWS_USERS.

Referenced by notifyCreation().

Here is the caller graph for this function:

enableNotification()

enableNotification

(

)

Definition at line 34 of file trait.ilObjFileNews.php.

                                        : void
    {
        $this->notify = true;
    }

Referenced by ilObjFile\appendStream(), ilObjFile\appendUpload(), ilObjFile\replaceWithStream(), and ilObjFile\replaceWithUpload().

Here is the caller graph for this function:

notifyCreation()

notifyCreation	(	int	$obj_id,
		?string	$additional_message = null
	)

Definition at line 28 of file trait.ilObjFileNews.php.

                                                                                   : void
    {
        $this->addNewsNotification($obj_id, 'file_created', $additional_message);
        $this->just_notified = true;
    }

References addNewsNotification().

Referenced by ilObjFile\doCreate().

Here is the call graph for this function:

Here is the caller graph for this function:

notifyUpdate()

notifyUpdate	(	int	$obj_id,
		?string	$additional_message = null
	)

Definition at line 39 of file trait.ilObjFileNews.php.

     : void {
        if (!$this->notify) {
            return;
        }
        if (!$this->just_notified) {
            $this->addNewsNotification($obj_id, 'file_updated', $additional_message);
            $this->just_notified = true;
        }
    }

Referenced by ilObjFile\doUpdate().

Here is the caller graph for this function:

Variable Documentation

$notify

bool $notify = false

protected

Definition at line 26 of file trait.ilObjFileNews.php.

Referenced by ilIndividualAssessmentUserGradingTest\test_create_instance(), ilIndividualAssessmentUserGradingTest\test_with_finalized_changed(), and ilIndividualAssessmentUserGradingTest\testToFormInput().

ilObjFileNews

trait ilObjFileNews

Initial value:

{
    protected bool $just_notified = false

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 Trait ilObjFileNews

Author

Fabian Schmid fs@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch

Definition at line 23 of file trait.ilObjFileNews.php.