ilWebDAVUriBuilder Class Reference

Collaboration diagram for ilWebDAVUriBuilder:

Public Member Functions
	__construct (\Psr\Http\Message\RequestInterface $a_request)
	getWebDavDefaultUri (int $a_ref_id)
	getWebDavNautilusUri (int $a_ref_id)
	getWebDavKonquerorUri (int $a_ref_id)
	getUriToMountInstructionModalByRef (int $a_ref_id)
	getUriToMountInstructionModalByLanguage (string $language)

Protected Member Functions
	changePathToWebDavScript (string $a_original_path)
	getWebDavPathToRef (int $a_ref_id)
	getWebDavPathToLanguageTemplate (string $language)
	getWebDavUriByPlaceholderName (string $placeholder_name, int $a_ref_id)

Protected Attributes
	$request
	$schemas
	$mount_instructions_query = 'mount-instructions'
	$webdav_script_name = 'webdav.php'

Detailed Description

Definition at line 4 of file class.ilWebDAVUriBuilder.php.

Constructor & Destructor Documentation

__construct()

ilWebDAVUriBuilder::__construct

(

\Psr\Http\Message\RequestInterface

$a_request

)

Definition at line 20 of file class.ilWebDAVUriBuilder.php.

References changePathToWebDavScript(), and CLIENT_ID.

    {
        $this->request = $a_request;

        $this->uri = $a_request->getUri();
        $this->host = $this->uri->getHost();

        $this->client_id = CLIENT_ID;
        $this->web_path_to_script = $this->changePathToWebDavScript($this->uri->getPath());
    }

Here is the call graph for this function:

Member Function Documentation

changePathToWebDavScript()

ilWebDAVUriBuilder::changePathToWebDavScript ( string  $a_original_path )

protected

Parameters

string

$a_original_path

Returns

string

Definition at line 37 of file class.ilWebDAVUriBuilder.php.

References $webdav_script_name.

Referenced by __construct().

    {
        $exploded_path = explode('/', $a_original_path);
        
        if (in_array($this->webdav_script_name, $exploded_path)) {
            return implode('/', array_splice($exploded_path, 0, -2));
        }
                
        return implode('/', array_splice($exploded_path, 0, -1)) . '/' . $this->webdav_script_name;
    }

Here is the caller graph for this function:

getUriToMountInstructionModalByLanguage()

ilWebDAVUriBuilder::getUriToMountInstructionModalByLanguage

(

string

$language

)

Parameters

string

$language

Returns

string

Definition at line 120 of file class.ilWebDAVUriBuilder.php.

References $mount_instructions_query, and getWebDavPathToLanguageTemplate().

    {
        return $this->getWebDavPathToLanguageTemplate($language) . '?' . $this->mount_instructions_query;
    }

Here is the call graph for this function:

getUriToMountInstructionModalByRef()

ilWebDAVUriBuilder::getUriToMountInstructionModalByRef

(

int

$a_ref_id

)

Parameters

int

$a_ref_id

Returns

string

Definition at line 111 of file class.ilWebDAVUriBuilder.php.

References $mount_instructions_query, and getWebDavPathToRef().

Referenced by ilObjGroupListGUI\getCommandLink(), ilObjFolderListGUI\getCommandLink(), ilObjCategoryListGUI\getCommandLink(), ilObjectListGUI\getCommandLink(), and ilContainerGUI\showPasswordInstructionObject().

    {
        return $this->getWebDavPathToRef($a_ref_id) . '?' . $this->mount_instructions_query;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getWebDavDefaultUri()

ilWebDAVUriBuilder::getWebDavDefaultUri

(

int

$a_ref_id

)

Parameters

int

$a_ref_id

Returns

string

Definition at line 84 of file class.ilWebDAVUriBuilder.php.

References getWebDavUriByPlaceholderName().

    {
        return $this->getWebDavUriByPlaceholderName('default', $a_ref_id);
    }

Here is the call graph for this function:

getWebDavKonquerorUri()

ilWebDAVUriBuilder::getWebDavKonquerorUri

(

int

$a_ref_id

)

Parameters

int

$a_ref_id

Returns

string

Definition at line 102 of file class.ilWebDAVUriBuilder.php.

References getWebDavUriByPlaceholderName().

    {
        return $this->getWebDavUriByPlaceholderName('konqueror', $a_ref_id);
    }

Here is the call graph for this function:

getWebDavNautilusUri()

ilWebDAVUriBuilder::getWebDavNautilusUri

(

int

$a_ref_id

)

Parameters

int

$a_ref_id

Returns

string

Definition at line 93 of file class.ilWebDAVUriBuilder.php.

References getWebDavUriByPlaceholderName().

    {
        return $this->getWebDavUriByPlaceholderName('nautilus', $a_ref_id);
    }

Here is the call graph for this function:

getWebDavPathToLanguageTemplate()

ilWebDAVUriBuilder::getWebDavPathToLanguageTemplate ( string  $language )

protected

Parameters

string

$language

Returns

string

Definition at line 61 of file class.ilWebDAVUriBuilder.php.

Referenced by getUriToMountInstructionModalByLanguage().

    {
        return "$this->web_path_to_script/$this->client_id/$language";
    }

Here is the caller graph for this function:

getWebDavPathToRef()

ilWebDAVUriBuilder::getWebDavPathToRef ( int  $a_ref_id )

protected

Parameters

int

$a_ref_id

Returns

string

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

Referenced by getUriToMountInstructionModalByRef(), and getWebDavUriByPlaceholderName().

    {
        return "$this->web_path_to_script/$this->client_id/ref_$a_ref_id";
    }

Here is the caller graph for this function:

getWebDavUriByPlaceholderName()

ilWebDAVUriBuilder::getWebDavUriByPlaceholderName ( string  $placeholder_name, int  $a_ref_id  )

protected

Parameters

string	$placeholder_name
int	$a_ref_id

Returns

string

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

References getWebDavPathToRef().

Referenced by getWebDavDefaultUri(), getWebDavKonquerorUri(), and getWebDavNautilusUri().

    {
        $scheme = $this->schemas[$placeholder_name];
        if ($this->uri->getScheme() == 'https') {
            $scheme .= 's';
        }
        return $scheme . '://' . $this->host . $this->getWebDavPathToRef($a_ref_id);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$mount_instructions_query

ilWebDAVUriBuilder::$mount_instructions_query = 'mount-instructions'

protected

Definition at line 16 of file class.ilWebDAVUriBuilder.php.

Referenced by getUriToMountInstructionModalByLanguage(), and getUriToMountInstructionModalByRef().

$request

ilWebDAVUriBuilder::$request

protected

Definition at line 7 of file class.ilWebDAVUriBuilder.php.

$schemas

ilWebDAVUriBuilder::$schemas

protected

Initial value:

= array(
            'default' => 'http',
            'konqueror' => 'webdav',
            'nautilus' => 'dav'
        )

Definition at line 10 of file class.ilWebDAVUriBuilder.php.

$webdav_script_name

ilWebDAVUriBuilder::$webdav_script_name = 'webdav.php'

protected

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

Referenced by changePathToWebDavScript().

---

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

• Services/WebDAV/classes/mount_instructions/class.ilWebDAVUriBuilder.php