ilUserClipboard Class Reference

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

Collaboration diagram for ilUserClipboard:

Public Member Functions
	hasContent ()
	Check if clipboard has content. More...
	get ()
	Get clipboard content. More...
	getValidatedContent ()
	Get validated content of clipboard. More...
	add (array $a_usr_ids)
	Add entries to clipboard. More...
	delete (array $a_usr_ids)
	User ids to delete. More...
	replace (array $a_usr_ids)
	Replace clipboard content. More...
	clear ()
	save ()
	Save clipboard content in session. More...

Static Public Member Functions
static	getInstance (int $a_usr_id)

Data Fields
const	SESSION_KEYWORD = 'usr_clipboard'

Protected Member Functions
	__construct (int $a_user_id)
	read ()
	Read from session. More...

Private Attributes
array	$clipboard = []

Static Private Attributes
static ilUserClipboard	$instance = null

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 User clipboard

Author

Stefan Meyer smeye.nosp@m.r.il.nosp@m.ias@g.nosp@m.mx.d.nosp@m.e

Definition at line 23 of file class.ilUserClipboard.php.

Constructor & Destructor Documentation

__construct()

ilUserClipboard::__construct ( int  $a_user_id )

protected

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

References read().

    {
        $this->read();
    }

Here is the call graph for this function:

Member Function Documentation

add()

ilUserClipboard::add

(

array

$a_usr_ids

)

Add entries to clipboard.

Definition at line 75 of file class.ilUserClipboard.php.

                                         : void // Missing array type.
    {
        $this->clipboard = array_unique(array_merge($this->clipboard, $a_usr_ids));
    }

clear()

ilUserClipboard::clear

(

)

Definition at line 102 of file class.ilUserClipboard.php.

                           : void
    {
        $this->clipboard = [];
    }

delete()

ilUserClipboard::delete

(

array

$a_usr_ids

)

User ids to delete.

Definition at line 83 of file class.ilUserClipboard.php.

References replace().

                                            : void // Missing array type.
    {
        $remaining = [];
        foreach ($this->get() as $usr_id) {
            if (!in_array($usr_id, $a_usr_ids)) {
                $remaining[] = $usr_id;
            }
        }
        $this->replace($remaining);
    }

Here is the call graph for this function:

get()

ilUserClipboard::get

(

)

Get clipboard content.

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

References $clipboard.

                         : array // Missing array type.
    {
        return $this->clipboard;
    }

getInstance()

static ilUserClipboard::getInstance ( int  $a_usr_id )

static

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

Referenced by ilUserClipboardTableGUI\__construct(), ilLPTableBaseGUI\addToClipboard(), ilMembershipGUI\addToClipboard(), ilObjRoleGUI\addToClipboardObject(), ilObjUserFolderGUI\addToClipboardObject(), ilRepositorySearchGUI\emptyClipboard(), ilRepositorySearchGUI\fillAutoCompleteToolbar(), and ilRepositorySearchGUI\removeFromClipboard().

                                                     : self
    {
        if (!self::$instance) {
            self::$instance = new self($a_usr_id);
        }
        return self::$instance;
    }

Here is the caller graph for this function:

getValidatedContent()

ilUserClipboard::getValidatedContent

(

)

Get validated content of clipboard.

Definition at line 61 of file class.ilUserClipboard.php.

References $valid, and ilObjUser\_lookupLogin().

                                         : array // Missing array type.
    {
        $valid = [];
        foreach ($this->clipboard as $usr_id) {
            if (strlen(ilObjUser::_lookupLogin($usr_id))) {
                $valid[] = $usr_id;
            }
        }
        return $valid;
    }

Here is the call graph for this function:

hasContent()

ilUserClipboard::hasContent

(

)

Check if clipboard has content.

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

                                : bool
    {
        return (bool) count($this->clipboard);
    }

read()

ilUserClipboard::read ( )

protected

Read from session.

Definition at line 118 of file class.ilUserClipboard.php.

References ilSession\get().

Referenced by __construct().

                             : void
    {
        $this->clipboard = (array) ilSession::get(self::SESSION_KEYWORD);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

replace()

ilUserClipboard::replace

(

array

$a_usr_ids

)

Replace clipboard content.

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

Referenced by delete().

                                             : void // Missing array type.
    {
        $this->clipboard = $a_usr_ids;
    }

Here is the caller graph for this function:

save()

ilUserClipboard::save

(

)

Save clipboard content in session.

Definition at line 110 of file class.ilUserClipboard.php.

References ilSession\set().

                          : void
    {
        ilSession::set(self::SESSION_KEYWORD, $this->clipboard);
    }

Here is the call graph for this function:

Field Documentation

$clipboard

array ilUserClipboard::$clipboard = []

private

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

Referenced by get().

$instance

ilUserClipboard ilUserClipboard::$instance = null

staticprivate

Definition at line 26 of file class.ilUserClipboard.php.

SESSION_KEYWORD

const ilUserClipboard::SESSION_KEYWORD = 'usr_clipboard'

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

---

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

• components/ILIAS/User/classes/class.ilUserClipboard.php