ilWebDAVRepositoryHelper Class Reference

Collaboration diagram for ilWebDAVRepositoryHelper:

Public Member Functions
	__construct (protected ilAccessHandler $access, protected ilTree $tree, protected ilRepUtil $repository_util, protected ilWebDAVLocksRepository $locks_repository, protected ilObjFileInfoRepository $file_info_repository)
	deleteObject (int $ref_id)
	checkAccess (string $permission, int $ref_id)
	checkCreateAccessForType (int $ref_id, string $type)
	objectWithRefIdExists (int $ref_id)
	getObjectIdFromRefId (int $ref_id)
	getObjectTitleFromObjId (int $obj_id, bool $escape_forbidden_fileextension=false)
	getFilenameWithSanitizedFileExtension (int $obj_id)
	getParentOfRefId (int $ref_id)
	getObjectTypeFromObjId (int $obj_id)
	getObjectTitleFromRefId (int $ref_id, bool $escape_forbidden_fileextension=false)
	getObjectTypeFromRefId (int $ref_id)
	getChildrenOfRefId (int $ref_id)
	updateLocksAfterResettingObject (int $old_obj_id, int $new_obj_id)
	getFileInfo (int $obj_id)
	locks ()

Protected Member Functions
	getRawObjectTitleFromObjId (int $obj_id)

Detailed Description

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

Constructor & Destructor Documentation

__construct()

ilWebDAVRepositoryHelper::__construct	(	protected ilAccessHandler	$access,
		protected ilTree	$tree,
		protected ilRepUtil	$repository_util,
		protected ilWebDAVLocksRepository	$locks_repository,
		protected ilObjFileInfoRepository	$file_info_repository
	)

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

      {
    }

Member Function Documentation

checkAccess()

ilWebDAVRepositoryHelper::checkAccess	(	string	$permission,
		int	$ref_id
	)

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

References ILIAS\Repository\access().

Referenced by deleteObject().

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

Here is the call graph for this function:

Here is the caller graph for this function:

checkCreateAccessForType()

ilWebDAVRepositoryHelper::checkCreateAccessForType	(	int	$ref_id,
		string	$type
	)

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

References ILIAS\Repository\access().

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

Here is the call graph for this function:

deleteObject()

ilWebDAVRepositoryHelper::deleteObject

(

int

$ref_id

)

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

References checkAccess().

                                             : void
    {
        if (!$this->checkAccess('delete', $ref_id)) {
            throw new Forbidden("Permission denied");
        }

        $parent = $this->tree->getParentId($ref_id);
        $this->repository_util->deleteObjects($parent, [$ref_id]);
    }

Here is the call graph for this function:

getChildrenOfRefId()

ilWebDAVRepositoryHelper::getChildrenOfRefId

(

int

$ref_id

)

Returns

int[]

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

                                                   : array
    {
        return array_map(
            'intval',
            $this->tree->getChildIds($ref_id)
        );
    }

getFileInfo()

ilWebDAVRepositoryHelper::getFileInfo

(

int

$obj_id

)

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

                                            : ilObjFileInfo
    {
        return $this->file_info_repository->getByObjectId($obj_id);
    }

getFilenameWithSanitizedFileExtension()

ilWebDAVRepositoryHelper::getFilenameWithSanitizedFileExtension

(

int

$obj_id

)

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

References getRawObjectTitleFromObjId(), and ilFileUtils\getValidFilename().

Referenced by getObjectTitleFromObjId().

                                                                      : string
    {
        $unescaped_title = $this->getRawObjectTitleFromObjId($obj_id);

        try {
            $escaped_title = ilFileUtils::getValidFilename($unescaped_title);
        } catch (ilFileUtilsException) {
            $escaped_title = '';
        }

        return $escaped_title;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getObjectIdFromRefId()

ilWebDAVRepositoryHelper::getObjectIdFromRefId

(

int

$ref_id

)

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

References ilObject\_lookupObjectId().

Referenced by getObjectTitleFromRefId().

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

Here is the call graph for this function:

Here is the caller graph for this function:

getObjectTitleFromObjId()

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

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

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

Referenced by getObjectTitleFromRefId().

                                                                                                      : string
    {
        if ($escape_forbidden_fileextension && ilObject::_lookupType($obj_id) === 'file') {
            return $this->getFilenameWithSanitizedFileExtension($obj_id);
        }

        return $this->getRawObjectTitleFromObjId($obj_id);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getObjectTitleFromRefId()

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

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

References getObjectIdFromRefId(), and getObjectTitleFromObjId().

                                                                                                      : string
    {
        $obj_id = $this->getObjectIdFromRefId($ref_id);

        return $this->getObjectTitleFromObjId($obj_id, $escape_forbidden_fileextension);
    }

Here is the call graph for this function:

getObjectTypeFromObjId()

ilWebDAVRepositoryHelper::getObjectTypeFromObjId

(

int

$obj_id

)

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

References ilObject\_lookupType().

                                                       : string
    {
        return ilObject::_lookupType($obj_id);
    }

Here is the call graph for this function:

getObjectTypeFromRefId()

ilWebDAVRepositoryHelper::getObjectTypeFromRefId

(

int

$ref_id

)

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

References ilObject\_lookupType().

                                                       : string
    {
        return ilObject::_lookupType($ref_id, true);
    }

Here is the call graph for this function:

getParentOfRefId()

ilWebDAVRepositoryHelper::getParentOfRefId

(

int

$ref_id

)

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

                                                 : int
    {
        return $this->tree->getParentId($ref_id);
    }

getRawObjectTitleFromObjId()

ilWebDAVRepositoryHelper::getRawObjectTitleFromObjId ( int  $obj_id )

protected

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

References ilObject\_lookupTitle().

Referenced by getFilenameWithSanitizedFileExtension(), and getObjectTitleFromObjId().

                                                              : string
    {
        return ilObject::_lookupTitle($obj_id);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

locks()

ilWebDAVRepositoryHelper::locks

(

)

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

                           : ilWebDAVLocksRepository
    {
        return $this->locks_repository;
    }

objectWithRefIdExists()

ilWebDAVRepositoryHelper::objectWithRefIdExists

(

int

$ref_id

)

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

References ilObject\_exists().

                                                      : bool
    {
        return ilObject::_exists($ref_id, true);
    }

Here is the call graph for this function:

updateLocksAfterResettingObject()

ilWebDAVRepositoryHelper::updateLocksAfterResettingObject	(	int	$old_obj_id,
		int	$new_obj_id
	)

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

                                                                                     : void
    {
        $this->locks_repository->updateLocks($old_obj_id, $new_obj_id);
    }

---

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

• components/ILIAS/WebDAV/classes/class.ilWebDAVRepositoryHelper.php