ilObjForumAccess Class Reference

Class ilObjForumAccess. More...

Inheritance diagram for ilObjForumAccess:

Collaboration diagram for ilObjForumAccess:

Static Public Member Functions
static	_getCommands ()
	get commands More...
static	_checkGoto (string $target)
	check whether goto script will succeed More...
static	_getThreadForPosting (int $a_pos_id)
static	prepareMessageForLists (string $text)
static	_preloadData (array $obj_ids, array $ref_ids)
	Preload data. More...
static	getLastPostByRefId (int $ref_id)
static	getStatisticsByRefId (int $ref_id)
static	getCachedUserInstance (int $usr_id)
Static Public Member Functions inherited from ilObjectAccess
static	_getCommands ()
	get commands More...
static	_checkGoto (string $target)
	check whether goto script will succeed More...
static	_isOffline (int $obj_id)
	Type-specific implementation of general status, has to be overwritten if object type does not support centralized offline handling. More...
static	_preloadData (array $obj_ids, array $ref_ids)
	Preload data. More...

Static Protected Attributes
static array	$userInstanceCache = []

Additional Inherited Members
Public Member Functions inherited from ilObjectAccess
	_checkAccess (string $cmd, string $permission, int $ref_id, int $obj_id, ?int $user_id=null)
	Checks whether a user may invoke a command or not (this method is called by ilAccessHandler::checkAccess) More...
	canBeDelivered (ilWACPath $ilWACPath)
	canBeDelivered (ilWACPath $ilWACPath)

Detailed Description

Class ilObjForumAccess.

Author

Alex Killing alex..nosp@m.kill.nosp@m.ing@g.nosp@m.mx.d.nosp@m.e \

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

Member Function Documentation

_checkGoto()

static ilObjForumAccess::_checkGoto ( string  $target )

static

check whether goto script will succeed

Reimplemented from ilObjectAccess.

Definition at line 48 of file class.ilObjForumAccess.php.

                                                     : bool
    {
        global $DIC;
 
        $t_arr = explode('_', $target);
 
        if ($t_arr[0] !== 'frm' || ((int) $t_arr[1]) <= 0) {
            return false;
        }
 
        return (
            $DIC->access()->checkAccess('read', '', (int) $t_arr[1]) ||
            $DIC->access()->checkAccess('visible', '', (int) $t_arr[1])
        );
    }

References $DIC.

_getCommands()

static ilObjForumAccess::_getCommands ( )

static

get commands

this method returns an array of all possible commands/permission combinations

example: $commands = array ( array("permission" => "read", "cmd" => "view", "lang_var" => "show"), array("permission" => "write", "cmd" => "edit", "lang_var" => "edit"), );

Returns

array{permission?:string, cmd?:string, lang_var?:string, default?:bool}[]

Reimplemented from ilObjectAccess.

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

                                         : array
    {
        return [
            [
                'permission' => 'read',
                'cmd' => 'showThreads',
                'lang_var' => 'show',
                'default' => true
            ],
            [
                'permission' => 'write',
                'cmd' => 'edit',
                'lang_var' => 'settings'
            ],
        ];
    }

References true.

Referenced by ilObjForumListGUI\init().

Here is the caller graph for this function:

_getThreadForPosting()

static ilObjForumAccess::_getThreadForPosting ( int  $a_pos_id )

static

Definition at line 64 of file class.ilObjForumAccess.php.

                                                              : int
    {
        global $DIC;
        $ilDB = $DIC->database();
 
        $res = $ilDB->queryF(
            'SELECT pos_thr_fk FROM frm_posts WHERE pos_pk = %s',
            ['integer'],
            [$a_pos_id]
        );
 
        $row = $ilDB->fetchAssoc($res);
 
        return (int) $row['pos_thr_fk'];
    }

References $DIC, $ilDB, and $res.

Referenced by ilObjectFeedWriter\__construct(), ilUserFeedWriter\__construct(), ilPDNewsTableGUI\fillRow(), ilForumNewsRendererGUI\getObjectLink(), and ilNewsForContextBlockGUI\showNews().

Here is the caller graph for this function:

_preloadData()

static ilObjForumAccess::_preloadData ( array  $obj_ids, array  $ref_ids  )

static

Preload data.

Reimplemented from ilObjectAccess.

Definition at line 92 of file class.ilObjForumAccess.php.

                                                                       : void
    {
        /*
        We are only able to preload the top_pk values for the forum ref_ids.
        Other data like statistics and last posts require permission checks per reference, so there is no added value for using an SQL IN() function in the queries
        */
        ilObjForum::preloadForumIdsByRefIds($ref_ids);
    }

References ilObjForum\preloadForumIdsByRefIds().

Here is the call graph for this function:

getCachedUserInstance()

static ilObjForumAccess::getCachedUserInstance ( int  $usr_id )

static

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

                                                             : ?ilObjUser
    {
        if (!isset(self::$userInstanceCache[$usr_id]) && ilObjUser::userExists([$usr_id])) {
            $user = ilObjectFactory::getInstanceByObjId($usr_id, false);
            if ($user instanceof ilObjUser) {
                self::$userInstanceCache[$usr_id] = $user;
            }
        }
 
        return self::$userInstanceCache[$usr_id] ?? null;
    }

References ilObjectFactory\getInstanceByObjId(), and ilObjUser\userExists().

Referenced by ilForumAuthorInformation\initUserInstance().

Here is the call graph for this function:

Here is the caller graph for this function:

getLastPostByRefId()

static ilObjForumAccess::getLastPostByRefId ( int  $ref_id )

static

Definition at line 101 of file class.ilObjForumAccess.php.

                                                          : ?array
    {
        return ilObjForum::lookupLastPostByRefId($ref_id);
    }

References $ref_id, and ilObjForum\lookupLastPostByRefId().

Referenced by ilObjForumListGUI\getProperties().

Here is the call graph for this function:

Here is the caller graph for this function:

getStatisticsByRefId()

static ilObjForumAccess::getStatisticsByRefId ( int  $ref_id )

static

Returns

array{num_posts: int, num_unread_posts: int}

Definition at line 109 of file class.ilObjForumAccess.php.

                                                            : array
    {
        return ilObjForum::lookupStatisticsByRefId($ref_id);
    }

References $ref_id, and ilObjForum\lookupStatisticsByRefId().

Referenced by ilObjForumListGUI\getProperties().

Here is the call graph for this function:

Here is the caller graph for this function:

prepareMessageForLists()

static ilObjForumAccess::prepareMessageForLists ( string  $text )

static

Definition at line 80 of file class.ilObjForumAccess.php.

                                                               : string
    {
        $text = str_replace('<br />', ' ', $text);
        $text = strip_tags($text);
        $text = preg_replace('/\[(\/)?quote\]/', '', $text);
        if (ilStr::strLen($text) > 40) {
            $text = ilStr::subStr($text, 0, 37) . '...';
        }
 
        return $text;
    }

References ilStr\strLen(), and ilStr\subStr().

Referenced by ilObjForumListGUI\getProperties().

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$userInstanceCache

array ilObjForumAccess::$userInstanceCache = []

staticprotected

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

---

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

• components/ILIAS/Forum/classes/class.ilObjForumAccess.php