ProjectDescriptorMapper
in package
Maps a projectDescriptor to and from a cache instance.
Table of Contents
- FILE_LIST = 'phpDocumentor-projectDescriptor-filelist'
- FILE_PREFIX = 'phpDocumentor-projectDescriptor-files-'
- KEY_SETTINGS = 'phpDocumentor-projectDescriptor-settings'
- $cache : AdapterInterface
- __construct() : mixed
- Initializes this mapper with the given cache instance.
- garbageCollect() : void
- Removes all files in cache that do not occur in the given FileSet Collection.
- populate() : void
- Returns the Project Descriptor from the cache.
- save() : void
- Stores a Project Descriptor in the Cache.
- loadCacheItemAsSettings() : void
Constants
FILE_LIST
public
mixed
FILE_LIST
= 'phpDocumentor-projectDescriptor-filelist'
FILE_PREFIX
public
mixed
FILE_PREFIX
= 'phpDocumentor-projectDescriptor-files-'
KEY_SETTINGS
public
mixed
KEY_SETTINGS
= 'phpDocumentor-projectDescriptor-settings'
Properties
$cache
private
AdapterInterface
$cache
Methods
__construct()
Initializes this mapper with the given cache instance.
public
__construct(AdapterInterface $descriptors) : mixed
Parameters
- $descriptors : AdapterInterface
Return values
mixed —garbageCollect()
Removes all files in cache that do not occur in the given FileSet Collection.
public
garbageCollect(array<string|int, File> $files) : void
Parameters
- $files : array<string|int, File>
Return values
void —populate()
Returns the Project Descriptor from the cache.
public
populate(ProjectDescriptor $projectDescriptor) : void
Parameters
- $projectDescriptor : ProjectDescriptor
Return values
void —save()
Stores a Project Descriptor in the Cache.
public
save(ProjectDescriptor $projectDescriptor) : void
Parameters
- $projectDescriptor : ProjectDescriptor
Return values
void —loadCacheItemAsSettings()
private
loadCacheItemAsSettings(ProjectDescriptor $projectDescriptor) : void
Parameters
- $projectDescriptor : ProjectDescriptor