ilObjForumAccess Class Reference

Class ilObjForumAccess. More...

Inheritance diagram for ilObjForumAccess:

Collaboration diagram for ilObjForumAccess:

Static Public Member Functions
static	_getCommands ()
	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"), ); Comment mjansen: Cannot make this static because parent method is not static ... More...
static	_checkGoto ($a_target)
	Check whether goto script will succeed Comment mjansen: Cannot make this static because parent method is not static ... More...
static	_getThreadForPosting ($a_pos_id)
	Get thread id for posting. More...
static	_lookupDiskUsage ($a_obj_id)
	Returns the number of bytes used on the harddisk by the specified forum. More...
static	prepareMessageForLists ($text)
	Prepare message for container view. More...
static	_preloadData ($obj_ids, $ref_ids)
static	getLastPostByRefId ($ref_id)
static	getStatisticsByRefId ($ref_id)
static	getCachedUserInstance ($usr_id)
Static Public Member Functions inherited from ilObjectAccess
static	_getCommands ()
	get commands More...
static	_checkGoto ($a_target)
	check whether goto script will succeed More...
static	_isOffline ($a_obj_id)
	Type-specific implementation of general status, has to be overwritten. More...
static	_preloadData ($a_obj_ids, $a_ref_ids)
	Preload data. More...

Static Protected Attributes
static	$userInstanceCache = array()

Additional Inherited Members
Public Member Functions inherited from ilObjectAccess
	_checkAccess ($a_cmd, $a_permission, $a_ref_id, $a_obj_id, $a_user_id="")
	Checks wether a user may invoke a command or not (this method is called by ilAccessHandler::checkAccess) More...
	_checkCondition ($a_obj_id, $a_operator, $a_value, $a_usr_id)
	check condition More...

Detailed Description

Class ilObjForumAccess.

Author

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

Version

$Id$

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

Member Function Documentation

_checkGoto()

static ilObjForumAccess::_checkGoto (   $a_target )

static

Check whether goto script will succeed Comment mjansen: Cannot make this static because parent method is not static ...

Parameters

string

$a_target

Returns

bool

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

References $DIC.

    {
        global $DIC;

        $t_arr = explode('_', $a_target);

        if ($t_arr[0] != 'frm' || ((int) $t_arr[1]) <= 0) {
            return false;
        }

        if ($DIC->access()->checkAccess('read', '', $t_arr[1])) {
            return true;
        }

        return false;
    }

_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"), ); Comment mjansen: Cannot make this static because parent method is not static ...

Returns

array

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

References array.

Referenced by ilObjForumListGUI\init().

    {
        $commands = array(
            array(
                'permission'=> 'read',
                'cmd'       => 'showThreads',
                'lang_var'  => 'show',
                'default'   => true
            ),
            array(
                'permission'=> 'write',
                'cmd'       => 'edit',
                'lang_var'  => 'settings'
            ),
        );

        return $commands;
    }

Here is the caller graph for this function:

_getThreadForPosting()

static ilObjForumAccess::_getThreadForPosting (   $a_pos_id )

static

Get thread id for posting.

Parameters

int

$a_pos_id

Returns

int

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

References $DIC, $ilDB, $res, $row, and array.

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

    {
        global $DIC;
        $ilDB = $DIC->database();

        $res = $ilDB->queryF(
            'SELECT pos_thr_fk FROM frm_posts WHERE pos_pk = %s',
            array('integer'),
            array($a_pos_id)
        );

        $row = $ilDB->fetchAssoc($res);

        return $row['pos_thr_fk'];
    }

Here is the caller graph for this function:

_lookupDiskUsage()

static ilObjForumAccess::_lookupDiskUsage (   $a_obj_id )

static

Returns the number of bytes used on the harddisk by the specified forum.

Parameters

int

$a_obj_id

Returns

int

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

References $DIC, $ilDB, $res, $row, $size, and array.

Referenced by ilObjForum\getDiskUsage().

    {
        global $DIC;
        $ilDB = $DIC->database();

        require_once 'Modules/Forum/classes/class.ilFileDataForum.php';

        $res = $ilDB->queryf(
            'SELECT top_frm_fk, pos_pk FROM frm_posts p
                        JOIN frm_data d ON d.top_pk = p.pos_top_fk
                        WHERE top_frm_fk = %s',
            array('integer'),
            array($a_obj_id)
        );

        $size = 0;
        while ($row = $ilDB->fetchAssoc($res)) {
            $fileDataForum = new ilFileDataForum($row['top_frm_fk'], $row['pos_pk']);
            $filesOfPost   = $fileDataForum->getFilesOfPost();
            foreach ($filesOfPost as $attachment) {
                $size += $attachment['size'];
            }
            unset($fileDataForum);
            unset($filesOfPost);
        }

        return $size;
    }

Here is the caller graph for this function:

_preloadData()

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

static

Parameters

array	$obj_ids
array	$ref_ids

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

References array, and ilObjForum\preloadForumIdsByRefIds().

    {
        /*
        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((array) $ref_ids);
    }

Here is the call graph for this function:

getCachedUserInstance()

static ilObjForumAccess::getCachedUserInstance (   $usr_id )

static

Parameters

int

$usr_id

Returns

ilObjUser|boolean

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

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

Referenced by ilForumPost\getUserData(), and ilForumAuthorInformation\initUserInstance().

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

        return self::$userInstanceCache[$usr_id];
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getLastPostByRefId()

static ilObjForumAccess::getLastPostByRefId (   $ref_id )

static

Parameters

int

$ref_id

Returns

array

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

References ilObjForum\lookupLastPostByRefId().

Referenced by ilObjForumListGUI\getProperties().

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

Here is the call graph for this function:

Here is the caller graph for this function:

getStatisticsByRefId()

static ilObjForumAccess::getStatisticsByRefId (   $ref_id )

static

Parameters

int

$ref_id

Returns

array

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

References ilObjForum\lookupStatisticsByRefId().

Referenced by ilObjForumListGUI\getProperties().

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

Here is the call graph for this function:

Here is the caller graph for this function:

prepareMessageForLists()

static ilObjForumAccess::prepareMessageForLists (   $text )

static

Prepare message for container view.

Parameters

string

$text

Returns

string

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

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

Referenced by ilObjForumListGUI\getProperties().

    {
        include_once 'Services/Utilities/classes/class.ilStr.php';

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

        return $text;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$userInstanceCache

ilObjForumAccess::$userInstanceCache = array()

staticprotected

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

---

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

• Modules/Forum/classes/class.ilObjForumAccess.php