Virtual text file shown in every container that lists ILIAS objects which cannot be exposed via WebDAV (forbidden characters, duplicate titles, info-file name collisions). More...

Inheritance diagram for ILIAS\WebDAV\Entity\ProblemInfoFile:

Collaboration diagram for ILIAS\WebDAV\Entity\ProblemInfoFile:

Public Member Functions
	hasProblems ()

	getName ()

	setName ($name)

	getLastModified ()

	put ($data)

	get ()

	getSize ()

	getContentType ()

	getETag ()

	delete ()

Data Fields
const string	FILE_NAME = '#!_WEBDAV_INFORMATION.txt'

Detailed Description

Virtual text file shown in every container that lists ILIAS objects which cannot be exposed via WebDAV (forbidden characters, duplicate titles, info-file name collisions).

Read-only; cannot be written, renamed, deleted.

Author: Fabian Schmid fabia.nosp@m.n@sr.nosp@m..solu.nosp@m.tion.nosp@m.s

Definition at line 34 of file ProblemInfoFile.php.

Member Function Documentation

◆ delete()

ILIAS\WebDAV\Entity\ProblemInfoFile::delete ( )

Definition at line 121 of file ProblemInfoFile.php.

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

◆ get()

ILIAS\WebDAV\Entity\ProblemInfoFile::get ( )

Definition at line 75 of file ProblemInfoFile.php.

                         : string
    {
        $message = '';
 
        if ($this->info_name_collision) {
            $message .= '# ' . $this->lang->txt('webdav_problem_info_duplicate') . "\n\n";
        }
 
        if ($this->duplicate_titles !== []) {
            $message .= '# ' . $this->lang->txt('webdav_duplicate_detected_title') . "\n";
            foreach ($this->duplicate_titles as $title) {
                $message .= $title . "\n";
            }
            $message .= "\n";
        }
 
        if ($this->forbidden_titles !== []) {
            $message .= '# ' . $this->lang->txt('webdav_forbidden_chars_title') . "\n";
            foreach ($this->forbidden_titles as $title) {
                $message .= $title . "\n";
            }
            $message .= "\n";
        }
 
        if ($message === '') {
            return $this->lang->txt('webdav_problem_free_container');
        }
 
        return $message;
    }

◆ getContentType()

ILIAS\WebDAV\Entity\ProblemInfoFile::getContentType ( )

Definition at line 111 of file ProblemInfoFile.php.

                                    : string
    {
        return 'text/plain';
    }

◆ getETag()

ILIAS\WebDAV\Entity\ProblemInfoFile::getETag ( )

Definition at line 116 of file ProblemInfoFile.php.

                             : ?string
    {
        return null;
    }

◆ getLastModified()

ILIAS\WebDAV\Entity\ProblemInfoFile::getLastModified ( )

Definition at line 65 of file ProblemInfoFile.php.

                                     : int
    {
        return time();
    }

◆ getName()

ILIAS\WebDAV\Entity\ProblemInfoFile::getName ( )

Definition at line 55 of file ProblemInfoFile.php.

                             : string
    {
        return self::FILE_NAME;
    }

References ILIAS\WebDAV\Entity\ProblemInfoFile\FILE_NAME.

◆ getSize()

ILIAS\WebDAV\Entity\ProblemInfoFile::getSize ( )

Definition at line 106 of file ProblemInfoFile.php.

                             : int
    {
        return strlen($this->get());
    }

◆ hasProblems()

ILIAS\WebDAV\Entity\ProblemInfoFile::hasProblems ( )

Definition at line 48 of file ProblemInfoFile.php.

                                 : bool
    {
        return $this->info_name_collision
            || $this->duplicate_titles !== []
            || $this->forbidden_titles !== [];
    }

◆ put()

ILIAS\WebDAV\Entity\ProblemInfoFile::put ( $data )

Definition at line 70 of file ProblemInfoFile.php.

                              : void
    {
        throw new Forbidden('The error info file is virtual and cannot be overwritten');
    }

◆ setName()

ILIAS\WebDAV\Entity\ProblemInfoFile::setName ( $name )

Definition at line 60 of file ProblemInfoFile.php.

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

Field Documentation

◆ FILE_NAME

const string ILIAS\WebDAV\Entity\ProblemInfoFile::FILE_NAME = '#!_WEBDAV_INFORMATION.txt'

Definition at line 36 of file ProblemInfoFile.php.

Referenced by ILIAS\WebDAV\Objects\TreeProxyRepository\analyseProblems(), ILIAS\WebDAV\Entity\Container\getChild(), and ILIAS\WebDAV\Entity\ProblemInfoFile\getName().

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

components/ILIAS/WebDAV/src/Entity/ProblemInfoFile.php

Public Member Functions

Data Fields