ilWebDAVRepositoryHelper Class Reference

Class ilWebDAVRepositoryHelper. More...

Collaboration diagram for ilWebDAVRepositoryHelper:

Public Member Functions
	__construct (ilAccessHandler $access, ilTree $tree)
	ilWebDAVRepositoryHelper constructor. More...
	deleteObject (int $a_ref_id)
	I stole this method of deleting objects from ilObjectGUI->confirmedDeleteObject() More...
	checkAccess (string $a_permission, int $a_ref_id)
	Just a redirect to the checkAccess method of ilAccess. More...
	checkCreateAccessForType (int $a_ref_id, string $a_type)
	Just a redirect to the checkAccess method of ilAccess to check for creation of certain obj types. More...
	objectWithRefIdExists (int $a_ref_id)
	Just a redirect to the ilObject::_exists. More...
	getObjectIdFromRefId (int $a_ref_id)
	Just a redirect to the ilObject::_lookupObjectId function. More...
	getObjectTitleFromObjId (int $a_obj_id, bool $escape_forbidden_fileextension=false)
	Just a redirect to the ilObject::_lookupTitle function. More...
	getFilenameWithSanitizedFileExtension (int $a_obj_id)
	Wraps the static call to ilObject::_lookupTitle. More...
	getObjectTypeFromObjId (int $a_obj_id)
	Just a redirect to the ilObject::_lookupType function. More...
	getObjectTitleFromRefId (int $a_ref_id, bool $escape_forbidden_fileextension=false)
	Just a shortcut and redirect to get a title from a given ref_id. More...
	getObjectTypeFromRefId (int $a_ref_id)
	Just a redirect to the ilObject::_lookupType function. More...
	getChildrenOfRefId (int $a_ref_id)
	Just a redirect to getChildIds of ilTree. More...

Protected Member Functions
	getRawObjectTitleFromObjId (int $a_obj_id)
	Wraps the static call to ilObject::_lookupTitle. More...

Protected Attributes
	$access
	$tree

Detailed Description

Class ilWebDAVRepositoryHelper.

This is a helper class and mostly also a wrapper class for repository actions. It is used by ilObj*DAV objects and makes them more unit testable. This is really helpful since static calls like ilObject::_exists() are not mockable

Author

Raphael Heer rapha.nosp@m.el.h.nosp@m.eer@h.nosp@m.slu..nosp@m.ch $Id$

Definition at line 12 of file class.ilWebDAVRepositoryHelper.php.

Constructor & Destructor Documentation

__construct()

ilWebDAVRepositoryHelper::__construct	(	ilAccessHandler	$access,
		ilTree	$tree
	)

ilWebDAVRepositoryHelper constructor.

Parameters

ilAccessHandler	$access
ilTree	$tree

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

    {
        $this->access = $access;
        $this->tree = $tree;
    }

References $access, and $tree.

Member Function Documentation

checkAccess()

ilWebDAVRepositoryHelper::checkAccess	(	string	$a_permission,
		int	$a_ref_id
	)

Just a redirect to the checkAccess method of ilAccess.

Parameters

$a_permission
$a_ref_id

Returns

bool

Definition at line 52 of file class.ilWebDAVRepositoryHelper.php.

                                                                     : bool
    {
        return $this->access->checkAccess($a_permission, '', $a_ref_id);
    }

checkCreateAccessForType()

ilWebDAVRepositoryHelper::checkCreateAccessForType	(	int	$a_ref_id,
		string	$a_type
	)

Just a redirect to the checkAccess method of ilAccess to check for creation of certain obj types.

Parameters

int	$a_ref_id
string	$a_type

Returns

bool

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

                                                                            : bool
    {
        return $this->access->checkAccess('create', '', $a_ref_id, $a_type);
    }

deleteObject()

ilWebDAVRepositoryHelper::deleteObject

(

int

$a_ref_id

)

I stole this method of deleting objects from ilObjectGUI->confirmedDeleteObject()

Parameters

$a_ref_id

ref_id of object to delete

Exceptions

ilRepositoryException

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

    {
        $repository_util = new ilRepUtil($this);
        $parent = $this->tree->getParentId($a_ref_id);
        $repository_util->deleteObjects($parent, array($a_ref_id));
    }

getChildrenOfRefId()

ilWebDAVRepositoryHelper::getChildrenOfRefId

(

int

$a_ref_id

)

Just a redirect to getChildIds of ilTree.

Parameters

$a_ref_id

Returns

mixed

Definition at line 185 of file class.ilWebDAVRepositoryHelper.php.

    {
        return $this->tree->getChildIds($a_ref_id);
    }

getFilenameWithSanitizedFileExtension()

ilWebDAVRepositoryHelper::getFilenameWithSanitizedFileExtension

(

int

$a_obj_id

)

Wraps the static call to ilObject::_lookupTitle.

This is on one hand necessary to create unit tests. And on the other hand, it guarantees the return of a string, which ilObject::_lookupTitle() doesn't.

Parameters

int

$a_obj_id

Returns

string

Exceptions

ilFileUtilsException

Definition at line 115 of file class.ilWebDAVRepositoryHelper.php.

                                                                         : string
    {
        $unescaped_title = $this->getRawObjectTitleFromObjId($a_obj_id);
 
        try {
            $escaped_title = ilFileUtils::getValidFilename($unescaped_title);
        } catch (ilFileUtilsException $e) {
            $escaped_title = "";
        }
 
        return is_string($escaped_title) ? $escaped_title : '';
    }

References Vendor\Package\$e, getRawObjectTitleFromObjId(), and ilFileUtils\getValidFilename().

Referenced by getObjectTitleFromObjId().

Here is the call graph for this function:

Here is the caller graph for this function:

getObjectIdFromRefId()

ilWebDAVRepositoryHelper::getObjectIdFromRefId

(

int

$a_ref_id

)

Just a redirect to the ilObject::_lookupObjectId function.

Parameters

$a_ref_id

Returns

int+

Definition at line 86 of file class.ilWebDAVRepositoryHelper.php.

                                                        : int
    {
        return ilObject::_lookupObjectId($a_ref_id);
    }

References ilObject\_lookupObjectId().

Referenced by getObjectTitleFromRefId().

Here is the call graph for this function:

Here is the caller graph for this function:

getObjectTitleFromObjId()

ilWebDAVRepositoryHelper::getObjectTitleFromObjId	(	int	$a_obj_id,
		bool	$escape_forbidden_fileextension = false
	)

Just a redirect to the ilObject::_lookupTitle function.

Parameters

$a_obj_id

Returns

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

                                                                                                         : string
    {
        if ($escape_forbidden_fileextension && ilObject::_lookupType($a_obj_id) == 'file') {
            $title = $this->getFilenameWithSanitizedFileExtension($a_obj_id);
        } else {
            $title = $this->getRawObjectTitleFromObjId($a_obj_id);
        }
 
        return is_string($title)? $title : '';
    }

References ilObject\_lookupType(), getFilenameWithSanitizedFileExtension(), and getRawObjectTitleFromObjId().

Referenced by getObjectTitleFromRefId().

Here is the call graph for this function:

Here is the caller graph for this function:

getObjectTitleFromRefId()

ilWebDAVRepositoryHelper::getObjectTitleFromRefId	(	int	$a_ref_id,
		bool	$escape_forbidden_fileextension = false
	)

Just a shortcut and redirect to get a title from a given ref_id.

Parameters

$a_ref_id

Returns

mixed

Definition at line 160 of file class.ilWebDAVRepositoryHelper.php.

                                                                                                         : string
    {
        $obj_id = $this->getObjectIdFromRefId($a_ref_id);
 
        return $this->getObjectTitleFromObjId($obj_id, $escape_forbidden_fileextension);
    }

References getObjectIdFromRefId(), and getObjectTitleFromObjId().

Here is the call graph for this function:

getObjectTypeFromObjId()

ilWebDAVRepositoryHelper::getObjectTypeFromObjId

(

int

$a_obj_id

)

Just a redirect to the ilObject::_lookupType function.

Parameters

$a_ref_id

Returns

mixed

Definition at line 147 of file class.ilWebDAVRepositoryHelper.php.

                                                          : string
    {
        $type = ilObject::_lookupType($a_obj_id, false);
        return $type === null ? '' : $type;
    }

References $type, and ilObject\_lookupType().

Here is the call graph for this function:

getObjectTypeFromRefId()

ilWebDAVRepositoryHelper::getObjectTypeFromRefId

(

int

$a_ref_id

)

Just a redirect to the ilObject::_lookupType function.

Parameters

$a_ref_id

Returns

mixed

Definition at line 173 of file class.ilWebDAVRepositoryHelper.php.

                                                          : string
    {
        $type = ilObject::_lookupType($a_ref_id, true);
        return is_string($type) ? $type : '';
    }

References $type, and ilObject\_lookupType().

Here is the call graph for this function:

getRawObjectTitleFromObjId()

ilWebDAVRepositoryHelper::getRawObjectTitleFromObjId ( int  $a_obj_id )

protected

Wraps the static call to ilObject::_lookupTitle.

This is on one hand necessary to create unit tests. And on the other hand, it guarantees the return of a string, which ilObject::_lookupTitle() doesn't.

Parameters

int

$a_obj_id

Returns

string

Definition at line 135 of file class.ilWebDAVRepositoryHelper.php.

                                                                 : string
    {
        $title = ilObject::_lookupTitle($a_obj_id);
        return is_string($title) ? $title : '';
    }

References ilObject\_lookupTitle().

Referenced by getFilenameWithSanitizedFileExtension(), and getObjectTitleFromObjId().

Here is the call graph for this function:

Here is the caller graph for this function:

objectWithRefIdExists()

ilWebDAVRepositoryHelper::objectWithRefIdExists

(

int

$a_ref_id

)

Just a redirect to the ilObject::_exists.

Parameters

$a_ref_id

Returns

bool

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

                                                         : int
    {
        return ilObject::_exists($a_ref_id, true);
    }

References ilObject\_exists().

Here is the call graph for this function:

Field Documentation

$access

ilAccess ilWebDAVRepositoryHelper::$access

protected

Definition at line 15 of file class.ilWebDAVRepositoryHelper.php.

Referenced by __construct().

$tree

ilTree ilWebDAVRepositoryHelper::$tree

protected

Definition at line 18 of file class.ilWebDAVRepositoryHelper.php.

Referenced by __construct().

---

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

• Services/WebDAV/classes/class.ilWebDAVRepositoryHelper.php