KTextTemplate::CachingLoaderDecorator Class

class KTextTemplate::CachingLoaderDecorator

Implements a loader decorator which caches compiled Template objects. More...

Header:	`#include <KTextTemplate/CachingLoaderDecorator>`
CMake:	`find_package(KF6 REQUIRED COMPONENTS TextTemplate)` `target_link_libraries(mytarget PRIVATE KF6::TextTemplate)`
Inherits:	KTextTemplate::AbstractTemplateLoader

List of all members, including inherited members

Public Functions

	CachingLoaderDecorator(QSharedPointer<KTextTemplate::AbstractTemplateLoader> loader)
void	clear()
bool	isEmpty() const
int	size() const

Reimplemented Public Functions

virtual bool	canLoadTemplate(const QString &name) const override
virtual std::pair<QString, QString>	getMediaUri(const QString &fileName) const override
virtual KTextTemplate::Template	loadByName(const QString &name, const KTextTemplate::Engine *engine) const override

Detailed Description

The **%CachingLoaderDecorator** can be used with any implementation of KTextTemplate::AbstractTemplateLoader.

auto loader = QSharedPointer<KTextTemplate::FileSystemTemplateLoader>::create();
loader->setTemplateDirs({"/path/one", "/path/two"});

auto cache =
    QSharedPointer<KTextTemplate::CachingLoaderDecorator>::create( loader );
m_engine->addTemplateLoader( cache );

The effect is that templates do not need to be loaded from the filesystem and compiled into Template objects on each access, but may be returned from the cache instead.

This can be significant if loading Templates in a loop, or loading the same Template very often in an application.

<ul>
{% for item in list %}
  <li>{% include "itemtemplate.html" %}</li>
{% endfor %}
</ul>

If the loading of Templates is a bottleneck in an application, it may make sense to use the caching decorator.

Member Function Documentation

CachingLoaderDecorator::CachingLoaderDecorator(QSharedPointer<KTextTemplate::AbstractTemplateLoader> loader)

Constructor

`[override virtual]` bool CachingLoaderDecorator::canLoadTemplate(const QString &name) const

Reimplements: AbstractTemplateLoader::canLoadTemplate(const QString &name) const.

void CachingLoaderDecorator::clear()

Clears the Templates objects cached in the decorator.

`[override virtual]` std::pair<QString, QString> CachingLoaderDecorator::getMediaUri(const QString &fileName) const

Reimplements: AbstractTemplateLoader::getMediaUri(const QString &fileName) const.

bool CachingLoaderDecorator::isEmpty() const

Returns whether the cache is empty.

`[override virtual]` KTextTemplate::Template CachingLoaderDecorator::loadByName(const QString &name, const KTextTemplate::Engine **engine*) const

Reimplements: AbstractTemplateLoader::loadByName(const QString &name, const KTextTemplate::Engine *engine) const.

int CachingLoaderDecorator::size() const

Returns the number of Template objects cached in the decorator.

Contents