ilWebDAVLockUriPathResolver Class Reference

Collaboration diagram for ilWebDAVLockUriPathResolver:

Public Member Functions
	__construct (protected ilWebDAVRepositoryHelper $webdav_repository_helper)
	getRefIdForWebDAVPath (string $uri)

Protected Member Functions
	getRefIdFromPathInRepositoryMount (string $path_inside_of_mountpoint)
	getRefIdFromPathInRefMount (string $repository_mountpoint, string $path_inside_of_mountpoint)
	getRefIdFromGivenParentRefAndTitlePath (int $a_parent_ref, array $current_path_array)
	getChildRefIdByGivenTitle (int $a_parent_ref_id, string $a_searched_title)

Detailed Description

Author

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

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

Constructor & Destructor Documentation

__construct()

ilWebDAVLockUriPathResolver::__construct

(

protected ilWebDAVRepositoryHelper

$webdav_repository_helper

)

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

    {
    }

Member Function Documentation

getChildRefIdByGivenTitle()

ilWebDAVLockUriPathResolver::getChildRefIdByGivenTitle ( int  $a_parent_ref_id, string  $a_searched_title  )

protected

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

References null.

Referenced by getRefIdFromGivenParentRefAndTitlePath().

                                                                                                : int
    {
        $ref_to_return = null;

        foreach ($this->webdav_repository_helper->getChildrenOfRefId($a_parent_ref_id) as $child_ref) {
            $child_title = $this->webdav_repository_helper->getObjectTitleFromRefId($child_ref, true);
            if ($a_searched_title === $child_title) {
                $ref_to_return = $child_ref;
            }
        }

        if (!is_null($ref_to_return)) {
            return $ref_to_return;
        }

        throw new NotFound('Node not found');
    }

Here is the caller graph for this function:

getRefIdForWebDAVPath()

ilWebDAVLockUriPathResolver::getRefIdForWebDAVPath

(

string

$uri

)

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

References CLIENT_ID, getRefIdFromPathInRefMount(), and getRefIdFromPathInRepositoryMount().

                                                      : int
    {
        $uri = trim($uri, '/');

        $split_path = explode('/', $uri, 2);

        if (!isset($split_path[0])
            || $split_path[0] === ''
            || $split_path[0] !== CLIENT_ID) {
            throw new BadRequest('Invalid client id given');
        }

        $path_inside_of_mountpoint = $split_path[1] ?? '';
        $mountpoint = '';

        if ($path_inside_of_mountpoint !== ''
            && str_starts_with($path_inside_of_mountpoint, 'ref_')) {
            $split_path = explode('/', $path_inside_of_mountpoint, 2);
            $mountpoint = $split_path[0];
            $path_inside_of_mountpoint = $split_path[1] ?? '';
        }

        if ($mountpoint !== '') {
            return $this->getRefIdFromPathInRefMount($mountpoint, $path_inside_of_mountpoint);
        }

        return $this->getRefIdFromPathInRepositoryMount($path_inside_of_mountpoint);
    }

Here is the call graph for this function:

getRefIdFromGivenParentRefAndTitlePath()

ilWebDAVLockUriPathResolver::getRefIdFromGivenParentRefAndTitlePath ( int  $a_parent_ref, array  $current_path_array  )

protected

Parameters

string[]

$current_path_array

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

References getChildRefIdByGivenTitle().

Referenced by getRefIdFromPathInRefMount(), and getRefIdFromPathInRepositoryMount().

                                                                                                           : int
    {
        $current_ref_id = $a_parent_ref;
        while (count($current_path_array) >= 1) {
            $next_searched_title = array_shift($current_path_array);
            if ($next_searched_title !== '') {
                try {
                    $current_ref_id = $this->getChildRefIdByGivenTitle($current_ref_id, $next_searched_title);
                } catch (NotFound) {
                    if ($current_path_array === []) {
                        /* This is a really special case. It occurs, if the lock is meant for an object that does not
                           exist yet (so called NullRessources) since we can't and won't lock non existing objects, we
                           set the Exception code to -1. The receiving class SHOULD handle what to do with this value */
                        throw new NotFound('Last node not found', -1);
                    }

                    throw new NotFound('Node not found', 0);
                }
            }
        }
        return $current_ref_id;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getRefIdFromPathInRefMount()

ilWebDAVLockUriPathResolver::getRefIdFromPathInRefMount ( string  $repository_mountpoint, string  $path_inside_of_mountpoint  )

protected

Definition at line 71 of file class.ilWebDAVLockUriPathResolver.php.

References getRefIdFromGivenParentRefAndTitlePath(), and ILIAS\Repository\int().

Referenced by getRefIdForWebDAVPath().

                                                                                                                   : int
    {
        $relative_mountpoint_ref_id = (int) explode('_', $repository_mountpoint)[1];

        if ($relative_mountpoint_ref_id < 1) {
            throw new NotFound('Mount point not found');
        }

        if ($path_inside_of_mountpoint === '') {
            return $relative_mountpoint_ref_id;
        }

        return $this->getRefIdFromGivenParentRefAndTitlePath(
            $relative_mountpoint_ref_id,
            explode('/', $path_inside_of_mountpoint)
        );
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getRefIdFromPathInRepositoryMount()

ilWebDAVLockUriPathResolver::getRefIdFromPathInRepositoryMount ( string  $path_inside_of_mountpoint )

protected

Definition at line 62 of file class.ilWebDAVLockUriPathResolver.php.

References getRefIdFromGivenParentRefAndTitlePath(), and ROOT_FOLDER_ID.

Referenced by getRefIdForWebDAVPath().

                                                                                           : int
    {
        if ($path_inside_of_mountpoint === '') {
            return ROOT_FOLDER_ID;
        }

        return $this->getRefIdFromGivenParentRefAndTitlePath(ROOT_FOLDER_ID, explode('/', $path_inside_of_mountpoint));
    }

Here is the call graph for this function:

Here is the caller graph for this function:

---

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

• components/ILIAS/WebDAV/classes/lock/class.ilWebDAVLockUriPathResolver.php