ilProblemInfoFileDAV Class Reference

Inheritance diagram for ilProblemInfoFileDAV:

Collaboration diagram for ilProblemInfoFileDAV:

Public Member Functions
	__construct (ilObjContainerDAV $a_dav_container, ilWebDAVRepositoryHelper $a_repo_helper, ilWebDAVObjDAVHelper $a_dav_helper)
	put ($data)
	Since this is a virtual file, put is not possible. More...
	get ()
	Get the information about problems in the DAV directory. More...
	getName ()
	Returns the title of the problem info file. More...
	getContentType ()
	Returns the mime-type for a file which is 'txt/plain'. More...
	getETag ()
	Returns the ETag for a file. More...
	getSize ()
	Returns the size of the node, in bytes. More...
	setName ($a_name)
	delete ()
	Deleted the current node. More...
	getLastModified ()
	Returns the last modification time, as a unix timestamp. More...

Data Fields
const	PROBLEM_INFO_FILE_NAME = '#!_WEBDAV_INFORMATION.txt'
const	PROBLEM_DUPLICATE_OBJECTNAME = 'duplicate'
const	PROBLEM_FORBIDDEN_CHARACTERS = 'forbidden_characters'
const	PROBLEM_INFO_NAME_DUPLICATE = 'info_name_duplicate'

Protected Member Functions
	analyseObjectsOfDAVContainer ()
	Analyses objects of the in the constructor given DAV container. More...
	createMessageStringFromProblemInfoArray (array $problem_infos)
	Creates a message string out of the found problems in the DAV container. More...

Protected Attributes
	$dav_container
	$repo_helper
	$dav_helper

Detailed Description

Definition at line 5 of file class.ilProblemInfoFileDAV.php.

Constructor & Destructor Documentation

__construct()

ilProblemInfoFileDAV::__construct	(	ilObjContainerDAV	$a_dav_container,
		ilWebDAVRepositoryHelper	$a_repo_helper,
		ilWebDAVObjDAVHelper	$a_dav_helper
	)

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

      {
        $this->dav_container = $a_dav_container;
        $this->repo_helper = $a_repo_helper;
        $this->dav_helper = $a_dav_helper;
    }

Member Function Documentation

analyseObjectsOfDAVContainer()

ilProblemInfoFileDAV::analyseObjectsOfDAVContainer ( )

protected

Analyses objects of the in the constructor given DAV container.

Returns

array

Definition at line 118 of file class.ilProblemInfoFileDAV.php.

References $type.

Referenced by get().

                                                      : array
    {
        // list of titles that were already checked (used for duplicate checking)
        $already_seen_titles = array();

        // Array with 3 different problem topics
        $problem_infos = array(
            self::PROBLEM_DUPLICATE_OBJECTNAME => array(),
            self::PROBLEM_FORBIDDEN_CHARACTERS => array(),
            self::PROBLEM_INFO_NAME_DUPLICATE => false // if a file is already named #!_WEBDAV_INFORMATION.txt (should not be the case)
        );

        // Loop to check every child of the container
        foreach ($this->repo_helper->getChildrenOfRefId($this->dav_container->getRefId()) as $ref_id) {
            $type = $this->repo_helper->getObjectTypeFromRefId($ref_id);
            if ($this->dav_helper->isDAVableObjType($type) && $this->repo_helper->checkAccess('read', $ref_id)) {
                $title = $this->repo_helper->getObjectTitleFromRefId($ref_id);
                if (!$this->dav_helper->hasInvalidPrefixInTitle($title)) {
                    // Check if object is a file with the same name as this info file
                    if ($title == self::PROBLEM_INFO_FILE_NAME) {
                        $problem_infos[self::PROBLEM_INFO_NAME_DUPLICATE] = true;
                    }
                    // Check if title contains forbidden characters
                    elseif ($this->dav_helper->hasTitleForbiddenChars($title)) {
                        $problem_infos[self::PROBLEM_FORBIDDEN_CHARACTERS][] = $title;
                    }
                    // Check for duplicates
                    elseif (in_array($title, $already_seen_titles)) {
                        $problem_infos[self::PROBLEM_DUPLICATE_OBJECTNAME][] = $title;
                    } else {
                        $already_seen_titles[] = $title;
                    }
                }
            }
        }

        return $problem_infos;
    }

Here is the caller graph for this function:

createMessageStringFromProblemInfoArray()

ilProblemInfoFileDAV::createMessageStringFromProblemInfoArray ( array  $problem_infos )

protected

Creates a message string out of the found problems in the DAV container.

Parameters

array

$problem_infos

Returns

string

Definition at line 163 of file class.ilProblemInfoFileDAV.php.

References $DIC, and $lng.

Referenced by get().

    {
        global $DIC;

        $lng = $DIC->language();
        $message_string = "";

        // If there is a file with the same name of the problem info file -> print message about it
        if ($problem_infos[self::PROBLEM_INFO_NAME_DUPLICATE]) {
            $message_string .= "# " . $lng->txt('webdav_problem_info_duplicate') . "\n\n";
        }

        // Print list with duplicate file names
        $duplicates_list = $problem_infos[self::PROBLEM_DUPLICATE_OBJECTNAME];
        if (count($duplicates_list) > 0) {
            $message_string .= "# " . $lng->txt('webdav_duplicate_detected_title') . "\n";
            foreach ($duplicates_list as $duplicate_title) {
                $message_string .= $duplicate_title . "\n";
            }
            $message_string .= "\n";
        }

        // Print list of files with forbidden characters
        $forbidden_character_titles_list = $problem_infos[self::PROBLEM_FORBIDDEN_CHARACTERS];
        if (count($forbidden_character_titles_list) > 0) {
            $message_string .= "# " . $lng->txt('webdav_forbidden_chars_title') . "\n";
            foreach ($forbidden_character_titles_list as $forbidden_character_title) {
                $message_string .= $forbidden_character_title . "\n";
            }
            $message_string .= "\n";
        }

        // If no problems were found -> create a default message (this happens only if the file is called directly)
        if (strlen($message_string) == 0) {
            $message_string = $lng->txt('webdav_problem_free_container');
        }

        return $message_string;
    }

Here is the caller graph for this function:

delete()

ilProblemInfoFileDAV::delete

(

)

Deleted the current node.

Returns

void

Definition at line 208 of file class.ilProblemInfoFileDAV.php.

    {
        throw new \Sabre\DAV\Exception\Forbidden("It is not possible to delete this file since it is just virtual.");
    }

get()

ilProblemInfoFileDAV::get

(

)

Get the information about problems in the DAV directory.

Returns

mixed

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

References analyseObjectsOfDAVContainer(), and createMessageStringFromProblemInfoArray().

    {
        $problem_infos = $this->analyseObjectsOfDAVContainer();
        return $this->createMessageStringFromProblemInfoArray($problem_infos);
    }

Here is the call graph for this function:

getContentType()

ilProblemInfoFileDAV::getContentType

(

)

Returns the mime-type for a file which is 'txt/plain'.

Returns

string|null

Definition at line 70 of file class.ilProblemInfoFileDAV.php.

    {
        return 'text/plain';
    }

getETag()

ilProblemInfoFileDAV::getETag

(

)

Returns the ETag for a file.

An ETag is a unique identifier representing the current version of the file. If the file changes, the ETag MUST change.

Return null if the ETag can not effectively be determined.

The ETag must be surrounded by double-quotes, so something like this would make a valid ETag:

return '"someetag"';

Returns

string|null

Definition at line 89 of file class.ilProblemInfoFileDAV.php.

    {
        return null;
    }

getLastModified()

ilProblemInfoFileDAV::getLastModified

(

)

Returns the last modification time, as a unix timestamp.

Return null if the information is not available.

Returns

int|null

Definition at line 219 of file class.ilProblemInfoFileDAV.php.

    {
        return null;
    }

getName()

ilProblemInfoFileDAV::getName

(

)

Returns the title of the problem info file.

Returns

string

Definition at line 60 of file class.ilProblemInfoFileDAV.php.

    {
        return self::PROBLEM_INFO_FILE_NAME;
    }

getSize()

ilProblemInfoFileDAV::getSize

(

)

Returns the size of the node, in bytes.

Returns

int

Definition at line 99 of file class.ilProblemInfoFileDAV.php.

    {
        return 0;
    }

put()

ilProblemInfoFileDAV::put

(

$data

)

Since this is a virtual file, put is not possible.

Parameters

resource | string

$data

Returns

string|null

Exceptions

Forbidden

Definition at line 39 of file class.ilProblemInfoFileDAV.php.

    {
        throw new Forbidden("The error info file is virtual and can therefore not be overwritten");
    }

setName()

ilProblemInfoFileDAV::setName

(

$a_name

)

Parameters

string

$a_name

Exceptions

Forbidden

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

    {
        throw new Exception\Forbidden("The error info file cannot be renamed");
    }

Field Documentation

$dav_container

ilProblemInfoFileDAV::$dav_container

protected

Definition at line 14 of file class.ilProblemInfoFileDAV.php.

$dav_helper

ilProblemInfoFileDAV::$dav_helper

protected

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

$repo_helper

ilProblemInfoFileDAV::$repo_helper

protected

Definition at line 17 of file class.ilProblemInfoFileDAV.php.

PROBLEM_DUPLICATE_OBJECTNAME

const ilProblemInfoFileDAV::PROBLEM_DUPLICATE_OBJECTNAME = 'duplicate'

Definition at line 9 of file class.ilProblemInfoFileDAV.php.

PROBLEM_FORBIDDEN_CHARACTERS

const ilProblemInfoFileDAV::PROBLEM_FORBIDDEN_CHARACTERS = 'forbidden_characters'

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

PROBLEM_INFO_FILE_NAME

const ilProblemInfoFileDAV::PROBLEM_INFO_FILE_NAME = '#!_WEBDAV_INFORMATION.txt'

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

Referenced by ilObjContainerDAV\getChild().

PROBLEM_INFO_NAME_DUPLICATE

const ilProblemInfoFileDAV::PROBLEM_INFO_NAME_DUPLICATE = 'info_name_duplicate'

Definition at line 11 of file class.ilProblemInfoFileDAV.php.

---

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

• Services/WebDAV/classes/dav/class.ilProblemInfoFileDAV.php