com\setasign\Konquadrat\Object

AbstractCachingDocument

File: /Konquadrat/src/Object/AbstractCachingDocument.php

Class hierarchy

Implements

Summary

Methods

calculateHash()

abstract protected AbstractCachingDocument::calculateHash (
void
): string

Calculates the hash to define when the file should be generated.

Note: You shouldn't use $this->getObject()->changeDateTime because though saving the generated file under the object the cache will never hit.

generate()

public AbstractCachingDocument::generate (
void
): \com\setasign\SetaFramework\FileSystem\File
Exceptions

Throws \com\setasign\Konquadrat\Exception

generateFile()

abstract protected AbstractCachingDocument::generateFile (
void
): \com\setasign\SetaFramework\FileSystem\File

Generates the file.

The implementation shouldn't care about the cache or anything.

getFileFieldName()

abstract protected AbstractCachingDocument::getFileFieldName (
void
): string

The file field in which is generated file will be stored.

triggerChangeDateTime should be set to false for this field!

getObject()

abstract protected AbstractCachingDocument::getObject (
void
): AbstractObject

The main object which this document tries to display.