ilWebDAVObjDAVHelper Class Reference

Class ilWebDAVObjDAVHelper. More...

Collaboration diagram for ilWebDAVObjDAVHelper:

Public Member Functions
	__construct (ilWebDAVRepositoryHelper $repo_helper)
	ilWebDAVObjDAVHelper constructor. More...
	isDAVableObject ($id, $is_reference=true, $do_name_check=true)
	Check if given object (either obj_id or ref_id) is compatible to be represented as a WebDAV object. More...
	isDAVableObjType (string $type)
	Check if the given object type is compatible to be represented as a WebDAV object. More...
	isDAVableObjTitle (string $title)
	Check if title is displayable in WebDAV. More...
	hasTitleForbiddenChars (string $title)
	Check for forbidden chars in title that are making trouble if displayed in WebDAV. More...
	hasInvalidPrefixInTitle (string $title)
	Forbidden are titles that begin with a single dot. More...
	createDAVObjectForRefId (int $ref_id, string $type='')
	Creates a DAV Object for the given ref id. More...
	isValidFileNameWithValidFileExtension (string $a_title)

Protected Attributes
	$repo_helper

Detailed Description

Class ilWebDAVObjDAVHelper.

This class is a helper class for WebDAV functionalities that are used from ilObj*DAV Objects. With this class, the behavior of the objects itself are unit testable.

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.ilWebDAVObjDAVHelper.php.

Constructor & Destructor Documentation

__construct()

ilWebDAVObjDAVHelper::__construct

(

ilWebDAVRepositoryHelper

$repo_helper

)

ilWebDAVObjDAVHelper constructor.

Parameters

ilWebDAVRepositoryHelper

$repo_helper

Definition at line 22 of file class.ilWebDAVObjDAVHelper.php.

References $repo_helper.

    {
        $this->repo_helper = $repo_helper;
    }

Member Function Documentation

createDAVObjectForRefId()

ilWebDAVObjDAVHelper::createDAVObjectForRefId	(	int	$ref_id,
		string	$type = ''
	)

Creates a DAV Object for the given ref id.

Parameters

integer	$ref_id
string	$type

Returns

ilObjectDAV

Definition at line 119 of file class.ilWebDAVObjDAVHelper.php.

References $type.

                                                                            : ilObjectDAV
    {
        if ($type == '') {
            $type = $this->repo_helper->getObjectTypeFromRefId($ref_id);
        }

        if ($this->repo_helper->objectWithRefIdExists($ref_id)) {
            switch ($type) {
                case 'cat':
                    return new ilObjCategoryDAV(new ilObjCategory($ref_id, true), $this->repo_helper, $this);

                case 'crs':
                    return new ilObjCourseDAV(new ilObjCourse($ref_id, true), $this->repo_helper, $this);

                case 'grp':
                    return new ilObjGroupDAV(new ilObjGroup($ref_id, true), $this->repo_helper, $this);

                case 'fold':
                    return new ilObjFolderDAV(new ilObjFolder($ref_id, true), $this->repo_helper, $this);

                case 'file':
                    return new ilObjFileDAV(new ilObjFile($ref_id, true), $this->repo_helper, $this);
            }
        }
        throw new BadRequest('Unknown filetype');
    }

hasInvalidPrefixInTitle()

ilWebDAVObjDAVHelper::hasInvalidPrefixInTitle

(

string

$title

)

Forbidden are titles that begin with a single dot.

There are also forbidden prefixes like '.$' or '..'. But since they both start with a single dot, we can aim only for that.

Parameters

$title

Returns

bool

Definition at line 106 of file class.ilWebDAVObjDAVHelper.php.

Referenced by isDAVableObjTitle().

    {
        $prefix = substr($title, 0, 1);
        return $prefix === '.';
    }

Here is the caller graph for this function:

hasTitleForbiddenChars()

ilWebDAVObjDAVHelper::hasTitleForbiddenChars

(

string

$title

)

Check for forbidden chars in title that are making trouble if displayed in WebDAV.

Parameters

$title

Returns

bool

Definition at line 88 of file class.ilWebDAVObjDAVHelper.php.

Referenced by isDAVableObjTitle().

                                                          : bool
    {
        foreach (str_split('\\<>/:*?"|#') as $forbidden_character) {
            if (strpos($title, $forbidden_character) !== false) {
                return true;
            }
        }

        return false;
    }

Here is the caller graph for this function:

isDAVableObject()

ilWebDAVObjDAVHelper::isDAVableObject	(		$id,
			$is_reference = true,
			$do_name_check = true
	)

Check if given object (either obj_id or ref_id) is compatible to be represented as a WebDAV object.

Parameters

	$id
bool	$is_reference
bool	$do_name_check

Returns

bool

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

References $id, $title, $type, isDAVableObjTitle(), and isDAVableObjType().

    {
        $obj_id = $is_reference ? $this->repo_helper->getObjectIdFromRefId($id) : $id;

        $type = $this->repo_helper->getObjectTypeFromObjId($obj_id);
        $title = $this->repo_helper->getObjectTitleFromObjId($obj_id);

        if($do_name_check) {
            $is_davable = $this->isDAVableObjType($type) && $this->isDAVableObjTitle($title);
        } else {
            $is_davable = $this->isDAVableObjType($type);
        }

        return $is_davable;
    }

Here is the call graph for this function:

isDAVableObjTitle()

ilWebDAVObjDAVHelper::isDAVableObjTitle

(

string

$title

)

Check if title is displayable in WebDAV.

Parameters

$title

Returns

bool

Definition at line 76 of file class.ilWebDAVObjDAVHelper.php.

References hasInvalidPrefixInTitle(), and hasTitleForbiddenChars().

Referenced by isDAVableObject(), and isValidFileNameWithValidFileExtension().

                                                     : bool
    {
        return ($this->hasTitleForbiddenChars($title) === false)
            && ($this->hasInvalidPrefixInTitle($title) === false);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

isDAVableObjType()

ilWebDAVObjDAVHelper::isDAVableObjType

(

string

$type

)

Check if the given object type is compatible to be represented as a WebDAV object.

Parameters

$type

Returns

bool

Definition at line 56 of file class.ilWebDAVObjDAVHelper.php.

Referenced by isDAVableObject().

                                                   : bool
    {
        switch ($type) {
            case 'cat':
            case 'crs':
            case 'grp':
            case 'fold':
            case 'file':
                return true;

            default:
                return false;
        }
    }

Here is the caller graph for this function:

isValidFileNameWithValidFileExtension()

ilWebDAVObjDAVHelper::isValidFileNameWithValidFileExtension

(

string

$a_title

)

Parameters

$a_title

Returns

bool

Exceptions

ilFileUtilsException

Definition at line 152 of file class.ilWebDAVObjDAVHelper.php.

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

                                                                           : bool
    {
        include_once("./Services/Utilities/classes/class.ilFileUtils.php");
        return $a_title == ilFileUtils::getValidFilename($a_title) && $this->isDAVableObjTitle($a_title);
    }

Here is the call graph for this function:

Field Documentation

$repo_helper

ilWebDAVObjDAVHelper::$repo_helper

protected

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

Referenced by __construct().

---

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

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