ilDAVProblemInfoFile Class Reference

Inheritance diagram for ilDAVProblemInfoFile:

Collaboration diagram for ilDAVProblemInfoFile:

Public Member Functions
	__construct (protected int $container_ref_id, protected ilWebDAVRepositoryHelper $repo_helper, protected ilWebDAVObjFactory $dav_object_factory, protected ilLanguage $language)
	put ($data)
	get ()
	getName ()
	getContentType ()
	getETag ()
	getSize ()
	setName ($a_name)
	delete ()
	getLastModified ()

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 ()
	createMessageStringFromProblemInfoArray (array $problem_infos)

Detailed Description

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

Constructor & Destructor Documentation

__construct()

ilDAVProblemInfoFile::__construct	(	protected int	$container_ref_id,
		protected ilWebDAVRepositoryHelper	$repo_helper,
		protected ilWebDAVObjFactory	$dav_object_factory,
		protected ilLanguage	$language
	)

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

      {
    }

Member Function Documentation

analyseObjectsOfDAVContainer()

ilDAVProblemInfoFile::analyseObjectsOfDAVContainer ( )

protected

Returns

array<string, array<int, string>|bool>

Definition at line 80 of file class.ilDAVProblemInfoFile.php.

References Vendor\Package\$e, $ref_id, and ilWebDAVNotDavableException\OBJECT_TITLE_NOT_DAVABLE.

Referenced by get().

                                                     : array
    {
        $already_seen_titles = [];

        $problem_infos = [
            self::PROBLEM_DUPLICATE_OBJECTNAME => [],
            self::PROBLEM_FORBIDDEN_CHARACTERS => [],
            self::PROBLEM_INFO_NAME_DUPLICATE => false
        ];

        foreach ($this->repo_helper->getChildrenOfRefId($this->container_ref_id) as $ref_id) {
            try {
                $dav_object = $this->dav_object_factory->retrieveDAVObjectByRefID($ref_id);

                $title = $dav_object->getName();

                if ($title === self::PROBLEM_INFO_FILE_NAME) {
                    $problem_infos[self::PROBLEM_INFO_NAME_DUPLICATE] = true;
                } elseif (in_array($title, $already_seen_titles)) {
                    $problem_infos[self::PROBLEM_DUPLICATE_OBJECTNAME][] = $title;
                } else {
                    $already_seen_titles[] = $title;
                }
            } catch (ilWebDAVNotDavableException $e) {
                if ($e->getMessage() === ilWebDAVNotDavableException::OBJECT_TITLE_NOT_DAVABLE) {
                    $title = $this->repo_helper->getObjectTitleFromRefId($ref_id);
                    $problem_infos[self::PROBLEM_FORBIDDEN_CHARACTERS][] = $title;
                }
            } catch (Forbidden|NotFound|RuntimeException) {
            }
        }

        return $problem_infos;
    }

Here is the caller graph for this function:

createMessageStringFromProblemInfoArray()

ilDAVProblemInfoFile::createMessageStringFromProblemInfoArray ( array  $problem_infos )

protected

Parameters

array[]

$problem_infos

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

References ILIAS\UI\examples\Symbol\Glyph\Language\language().

Referenced by get().

                                                                                    : string
    {
        $message_string = "";

        if ($problem_infos[self::PROBLEM_INFO_NAME_DUPLICATE]) {
            $message_string .= "# " . $this->language->txt('webdav_problem_info_duplicate') . "\n\n";
        }

        $duplicates_list = $problem_infos[self::PROBLEM_DUPLICATE_OBJECTNAME];
        if (count($duplicates_list) > 0) {
            $message_string .= "# " . $this->language->txt('webdav_duplicate_detected_title') . "\n";
            foreach ($duplicates_list as $duplicate_title) {
                $message_string .= $duplicate_title . "\n";
            }
            $message_string .= "\n";
        }

        $forbidden_character_titles_list = $problem_infos[self::PROBLEM_FORBIDDEN_CHARACTERS];
        if (count($forbidden_character_titles_list) > 0) {
            $message_string .= "# " . $this->language->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 ($message_string === '') {
            return $this->language->txt('webdav_problem_free_container');
        }

        return $message_string;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

delete()

ilDAVProblemInfoFile::delete

(

)

Definition at line 151 of file class.ilDAVProblemInfoFile.php.

                            : void
    {
        throw new Forbidden("It is not possible to delete this file since it is just virtual.");
    }

get()

ilDAVProblemInfoFile::get

(

)

Definition at line 46 of file class.ilDAVProblemInfoFile.php.

References analyseObjectsOfDAVContainer(), and createMessageStringFromProblemInfoArray().

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

Here is the call graph for this function:

getContentType()

ilDAVProblemInfoFile::getContentType

(

)

Definition at line 57 of file class.ilDAVProblemInfoFile.php.

    {
        return 'text/plain';
    }

getETag()

ilDAVProblemInfoFile::getETag

(

)

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

References null.

    {
        return null;
    }

getLastModified()

ilDAVProblemInfoFile::getLastModified

(

)

Definition at line 156 of file class.ilDAVProblemInfoFile.php.

    {
        return time();
    }

getName()

ilDAVProblemInfoFile::getName

(

)

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

    {
        return self::PROBLEM_INFO_FILE_NAME;
    }

getSize()

ilDAVProblemInfoFile::getSize

(

)

Definition at line 67 of file class.ilDAVProblemInfoFile.php.

                             : int
    {
        return 0;
    }

put()

ilDAVProblemInfoFile::put

(

$data

)

Definition at line 41 of file class.ilDAVProblemInfoFile.php.

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

setName()

ilDAVProblemInfoFile::setName

(

$a_name

)

Definition at line 72 of file class.ilDAVProblemInfoFile.php.

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

Field Documentation

PROBLEM_DUPLICATE_OBJECTNAME

const ilDAVProblemInfoFile::PROBLEM_DUPLICATE_OBJECTNAME = 'duplicate'

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

PROBLEM_FORBIDDEN_CHARACTERS

const ilDAVProblemInfoFile::PROBLEM_FORBIDDEN_CHARACTERS = 'forbidden_characters'

Definition at line 30 of file class.ilDAVProblemInfoFile.php.

PROBLEM_INFO_FILE_NAME

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

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

PROBLEM_INFO_NAME_DUPLICATE

const ilDAVProblemInfoFile::PROBLEM_INFO_NAME_DUPLICATE = 'info_name_duplicate'

Definition at line 31 of file class.ilDAVProblemInfoFile.php.

---

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

• components/ILIAS/WebDAV/classes/dav/class.ilDAVProblemInfoFile.php