\phpDocumentor\Descriptor\CacheProjectDescriptorMapper

Maps a projectDescriptor to and from a cache instance.

Summary

Methods
Properties
Constants
__construct()
populate()
save()
garbageCollect()
No public properties found
FILE_PREFIX
FILE_LIST
KEY_SETTINGS
No protected methods found
No protected properties found
N/A
loadCacheItemAsSettings()
$cache
N/A

Constants

FILE_PREFIX

FILE_PREFIX = 'phpDocumentor-projectDescriptor-files-'

FILE_LIST

FILE_LIST = 'phpDocumentor-projectDescriptor-filelist'

KEY_SETTINGS

KEY_SETTINGS = 'phpDocumentor-projectDescriptor-settings'

Properties

$cache

$cache : \Symfony\Component\Cache\Adapter\AdapterInterface

Type

\Symfony\Component\Cache\Adapter\AdapterInterface —

Methods

__construct()

__construct(\Symfony\Component\Cache\Adapter\AdapterInterface  $descriptors) : mixed

Initializes this mapper with the given cache instance.

Parameters

\Symfony\Component\Cache\Adapter\AdapterInterface $descriptors

Returns

mixed —

populate()

populate(\phpDocumentor\Descriptor\ProjectDescriptor  $projectDescriptor) : void

Returns the Project Descriptor from the cache.

Parameters

\phpDocumentor\Descriptor\ProjectDescriptor $projectDescriptor

save()

save(\phpDocumentor\Descriptor\ProjectDescriptor  $projectDescriptor) : void

Stores a Project Descriptor in the Cache.

Parameters

\phpDocumentor\Descriptor\ProjectDescriptor $projectDescriptor

garbageCollect()

garbageCollect(\phpDocumentor\Reflection\File[]  $files) : void

Removes all files in cache that do not occur in the given FileSet Collection.

Parameters

\phpDocumentor\Reflection\File[] $files

loadCacheItemAsSettings()

loadCacheItemAsSettings(\phpDocumentor\Descriptor\ProjectDescriptor  $projectDescriptor) : void

Parameters

\phpDocumentor\Descriptor\ProjectDescriptor $projectDescriptor