ilDAVFile Class Reference

Inheritance diagram for ilDAVFile:

Collaboration diagram for ilDAVFile:

Public Member Functions
	__construct (ilObjFile $obj, ilWebDAVRepositoryHelper $repo_helper, Services $resource_storage, RequestInterface $request, ilWebDAVObjFactory $dav_factory, bool $versioning_enabled)
	put ($data)
	get ()
	getName ()
	getContentType ()
	getETag ()
	getSize ()
	noSizeCheckNeeded ()
	setName ($name)
	delete ()
	getLastModified ()

Protected Attributes
ilObjFile	$obj
ilWebDAVRepositoryHelper	$repo_helper
Manager	$resource_manager
Consumers	$resource_consumer
RequestInterface	$request
ilWebDAVObjFactory	$dav_factory
bool	$needs_size_check = true
bool	$versioning_enabled

Detailed Description

Author

Raphael Heer rapha.nosp@m.el.h.nosp@m.eer@h.nosp@m.slu..nosp@m.ch

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

Constructor & Destructor Documentation

__construct()

ilDAVFile::__construct	(	ilObjFile	$obj,
		ilWebDAVRepositoryHelper	$repo_helper,
		Services	$resource_storage,
		RequestInterface	$request,
		ilWebDAVObjFactory	$dav_factory,
		bool	$versioning_enabled
	)

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

      {
        $this->obj = $obj;
        $this->repo_helper = $repo_helper;
        $this->resource_manager = $resource_storage->manage();
        $this->resource_consumer = $resource_storage->consume();
        $this->request = $request;
        $this->dav_factory = $dav_factory;
        $this->versioning_enabled = $versioning_enabled;
    }

References $dav_factory, $obj, $repo_helper, $request, $versioning_enabled, ILIAS\ResourceStorage\Services\consume(), and ILIAS\ResourceStorage\Services\manage().

Here is the call graph for this function:

Member Function Documentation

delete()

ilDAVFile::delete

(

)

Definition at line 185 of file class.ilDAVFile.php.

                            : void
    {
        $this->repo_helper->deleteObject($this->obj->getRefId());
    }

get()

ilDAVFile::get

(

)

Returns

string|resource

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

    {
        if (!$this->repo_helper->checkAccess("read", $this->obj->getRefId())) {
            throw new Forbidden("Permission denied. No read access for this file");
        }
 
        if (($r_id = $this->obj->getResourceId()) &&
            ($identification = $this->resource_manager->find($r_id))) {
            return $this->resource_consumer->stream($identification)->getStream()->getContents();
        }
 
        throw new NotFound("File not found");
    }

getContentType()

ilDAVFile::getContentType

(

)

Definition at line 138 of file class.ilDAVFile.php.

                                    : ?string
    {
        return  $this->obj->getFileType();
    }

getETag()

ilDAVFile::getETag

(

)

Definition at line 143 of file class.ilDAVFile.php.

                             : ?string
    {
        if ($this->getSize() > 0) {
            return '"' . sha1(
                $this->getSize() .
                $this->getName() .
                $this->obj->getCreateDate()
            ) . '"';
        }
 
        return null;
    }

References getName(), and getSize().

Referenced by put().

Here is the call graph for this function:

Here is the caller graph for this function:

getLastModified()

ilDAVFile::getLastModified

(

)

Definition at line 190 of file class.ilDAVFile.php.

                                     : ?int
    {
        return $this->retrieveLastModifiedAsIntFromObjectLastUpdateString($this->obj->getLastUpdateDate());
    }

getName()

ilDAVFile::getName

(

)

Definition at line 133 of file class.ilDAVFile.php.

                             : string
    {
        return ilFileUtils::getValidFilename($this->obj->getTitle());
    }

References ilFileUtils\getValidFilename().

Referenced by getETag(), and put().

Here is the call graph for this function:

Here is the caller graph for this function:

getSize()

ilDAVFile::getSize

(

)

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

                             : int
    {
        try {
            return $this->obj->getFileSize();
        } catch (Error $e) {
            return -1;
        }
    }

References Vendor\Package\$e.

Referenced by getETag(), and put().

Here is the caller graph for this function:

noSizeCheckNeeded()

ilDAVFile::noSizeCheckNeeded

(

)

Definition at line 165 of file class.ilDAVFile.php.

                                       : void
    {
        $this->needs_size_check = false;
    }

put()

ilDAVFile::put

(

$data

)

Parameters

string | resource

$data

Definition at line 69 of file class.ilDAVFile.php.

                              : ?string
    {
        if (!$this->repo_helper->checkAccess('write', $this->obj->getRefId())) {
            throw new Forbidden("Permission denied. No write access for this file");
        }
 
        $size = 0;
 
        if ($this->request->hasHeader("Content-Length")) {
            $size = (int) $this->request->getHeader("Content-Length")[0];
        }
        if ($size === 0 && $this->request->hasHeader('X-Expected-Entity-Length')) {
            $size = (int) $this->request->getHeader('X-Expected-Entity-Length')[0];
        }
 
        if ($size > ilFileUtils::getUploadSizeLimitBytes()) {
            throw new Forbidden('File is too big');
        }
 
        if ($this->needs_size_check && $this->getSize() === 0) {
            $parent_ref_id = $this->repo_helper->getParentOfRefId($this->obj->getRefId());
            $obj_id = $this->obj->getId();
            $this->repo_helper->deleteObject($this->obj->getRefId());
            $file_obj = new ilObjFile();
            $file_obj->setTitle($this->getName());
            $file_obj->setFileName($this->getName());
 
            $file_dav = $this->dav_factory->createDAVObject($file_obj, $parent_ref_id);
            $file_dav->noSizeCheckNeeded();
            $this->repo_helper->updateLocksAfterResettingObject($obj_id, $file_obj->getId());
            return $file_dav->put($data);
        }
 
        $stream = Streams::ofResource($data);
 
        if ($this->versioning_enabled === true ||
            $this->obj->getVersion() === 0 && $this->obj->getMaxVersion() === 0) {
            $this->obj->appendStream($stream, $this->obj->getTitle());
        } else {
            $this->obj->replaceWithStream($stream, $this->obj->getTitle());
        }
 
        $stream->close();
 
        return $this->getETag();
    }

References $data, getETag(), getName(), getSize(), ilFileUtils\getUploadSizeLimitBytes(), and ILIAS\Repository\int().

Here is the call graph for this function:

setName()

ilDAVFile::setName

(

$name

)

Definition at line 170 of file class.ilDAVFile.php.

                                  : void
    {
        if (!$this->repo_helper->checkAccess("write", $this->obj->getRefId())) {
            throw new Forbidden('Permission denied');
        }
 
        if ($this->isDAVableObjTitle($name) &&
            $name === $this->obj->checkFileExtension($this->getName(), $name)) {
            $this->obj->setTitle($name);
            $this->obj->update();
        } else {
            throw new ilWebDAVNotDavableException(ilWebDAVNotDavableException::OBJECT_TITLE_NOT_DAVABLE);
        }
    }

References $name, and ilWebDAVNotDavableException\OBJECT_TITLE_NOT_DAVABLE.

Field Documentation

$dav_factory

ilWebDAVObjFactory ilDAVFile::$dav_factory

protected

Definition at line 44 of file class.ilDAVFile.php.

Referenced by __construct().

$needs_size_check

bool ilDAVFile::$needs_size_check = true

protected

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

$obj

ilObjFile ilDAVFile::$obj

protected

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

Referenced by __construct().

$repo_helper

ilWebDAVRepositoryHelper ilDAVFile::$repo_helper

protected

Definition at line 40 of file class.ilDAVFile.php.

Referenced by __construct().

$request

RequestInterface ilDAVFile::$request

protected

Definition at line 43 of file class.ilDAVFile.php.

Referenced by __construct().

$resource_consumer

Consumers ilDAVFile::$resource_consumer

protected

Definition at line 42 of file class.ilDAVFile.php.

$resource_manager

Manager ilDAVFile::$resource_manager

protected

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

$versioning_enabled

bool ilDAVFile::$versioning_enabled

protected

Definition at line 47 of file class.ilDAVFile.php.

Referenced by __construct().

---

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

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