\Pydio\Cache\ImplementationdoctrineCacheDriver

Standard Memcache driver

Summary

Methods
Properties
Constants
getCacheDriver()
getOptionsForNode()
computeFullRepositoryId()
fetch()
fetchMultiple()
contains()
save()
saveWithTimestamp()
fetchWithTimestamps()
delete()
deleteAll()
supportsPatternDelete()
deleteKeyStartingWith()
listNamespaces()
getStats()
__destruct()
__construct()
__clone()
getWorkDirForPluginId()
init()
performChecks()
isEnabled()
loadManifest()
getManifestLabel()
getManifestDescription()
serialize()
unserialize()
getManifestRawContent()
getRegistryContributions()
updateDependencies()
dependsOn()
getActiveDependencies()
getConfigsDefinitions()
loadConfigs()
getConfigs()
getClassFile()
missingExtensions()
hasMissingExtensions()
manifestLoaded()
getId()
getName()
getType()
getBaseDir()
getDependencies()
logDebug()
logInfo()
logNotice()
logWarning()
logError()
detectStreamWrapper()
getPluginInformation()
getPluginInformationHTML()
reloadXPath()
hasMixin()
_apc_init()
_memcache_init()
_memcached_init()
_redis_init()
_xcache_init()
$driverType
$loadingState
No constants found
getTimestampKey()
requiresHttpForwarding()
getHttpClient()
getPluginWorkDir()
getPluginCacheDir()
getXPath()
getContextualOption()
loadRegistryContributions()
initXmlContributionFile()
parseSpecificContributions()
unserializeManifest()
loadDependencies()
cachedNodesFromManifest()
loadConfigsDefinitions()
loadOptionsDefaults()
exposeConfigInManifest()
loadMixins()
nodeAttrToHash()
nodesEqual()
$namespacedCaches
$httpClient
$baseDir
$id
$name
$type
$manifestLoaded
$externalFilesAppended
$enabled
$registryContributions
$contributionsLoaded
$options
$pluginConf
$pluginConfDefinition
$dependencies
$extensionsDependencies
$streamData
$mixins
$cachedXPathResults
$manifestDoc
N/A
initCacheWithNamespace()
$httpDeletion
$xPath
$manifestXML
$serializableAttributes
N/A

Properties

$driverType

$driverType : String

Driver type

Type

String — type of driver

$loadingState

$loadingState : 

Type

$namespacedCaches

$namespacedCaches : array<mixed,\Doctrine\Common\Cache\CacheProvider>

Type

array<mixed,\Doctrine\Common\Cache\CacheProvider>

$httpClient

$httpClient : \GuzzleHttp\Client

Keep a pointer to an http client if necessary

Type

\GuzzleHttp\Client

$baseDir

$baseDir : 

Type

$id

$id : 

Type

$name

$name : 

Type

$type

$type : 

Type

$manifestLoaded

$manifestLoaded : 

Type

$externalFilesAppended

$externalFilesAppended : 

Type

$enabled

$enabled : 

Type

$registryContributions

$registryContributions : 

Type

$contributionsLoaded

$contributionsLoaded : 

Type

$options

$options : array

Type

array

$pluginConf

$pluginConf : 

Type

$pluginConfDefinition

$pluginConfDefinition : 

Type

$dependencies

$dependencies : 

Type

$extensionsDependencies

$extensionsDependencies : 

Type

$streamData

$streamData : 

Type

$mixins

$mixins : 

Type

$cachedXPathResults

$cachedXPathResults : 

Type

$manifestDoc

$manifestDoc : \DOMDocument

The manifest.xml loaded

Type

\DOMDocument

$httpDeletion

$httpDeletion : array

Type

array

$xPath

$xPath : \DOMXPath

XPath query

Type

\DOMXPath

$manifestXML

$manifestXML : string

Internally store XML during serialization state.

Type

string

$serializableAttributes

$serializableAttributes : 

Type

Methods

getCacheDriver()

getCacheDriver(string  $namespace = AJXP_CACHE_SERVICE_NS_SHARED) : \Doctrine\Common\Cache\CacheProvider

Parameters

string $namespace

Returns

\Doctrine\Common\Cache\CacheProvider

getOptionsForNode()

getOptionsForNode(\Pydio\Access\Core\Model\AJXP_Node  $node, string  $cacheType, string  $details = '') : string

Compute a cache ID for a given node. Will be in the form cacheType://repositoryId/userSepcificKey|shared/nodePath[##detail]

Parameters

\Pydio\Access\Core\Model\AJXP_Node $node
string $cacheType
string $details

Returns

string

computeFullRepositoryId()

computeFullRepositoryId(  $repositoryId,   $cacheType) : string

Same as computeIdForNode but maybe used if a repository has been deleted

Parameters

$repositoryId
$cacheType

Returns

string

fetch()

fetch(  $namespace, string  $id) : mixed

Fetches an entry from the cache.

Parameters

$namespace
string $id

The id of the cache entry to fetch.

Returns

mixed —

The cached data or FALSE, if no cache entry exists for the given id.

fetchMultiple()

fetchMultiple(  $namespace, array<mixed,string>  $ids) : mixed

Fetches many entries from the cache.

Parameters

$namespace
array<mixed,string> $ids

The ids of the cache entry to fetch.

Returns

mixed —

The cached data or FALSE, if no cache entry exists for the given id.

contains()

contains(  $namespace, string  $id) : boolean

Tests if an entry exists in the cache.

Parameters

$namespace
string $id

The cache id of the entry to check for.

Returns

boolean —

TRUE if a cache entry exists for the given cache id, FALSE otherwise.

save()

save(  $namespace, string  $id, mixed  $data, integer  $lifeTime) : boolean

Puts data into the cache.

Parameters

$namespace
string $id

The cache id.

mixed $data

The cache entry/data.

integer $lifeTime

The cache lifetime. If != 0, sets a specific lifetime for this cache entry (0 => infinite lifeTime).

Returns

boolean —

TRUE if the entry was successfully stored in the cache, FALSE otherwise.

saveWithTimestamp()

saveWithTimestamp(  $namespace,   $id,   $data, integer  $lifeTime) : boolean

Puts data into the cache, and store an associated timestamp of current time

Parameters

$namespace
$id
$data
integer $lifeTime

Returns

boolean

fetchWithTimestamps()

fetchWithTimestamps(  $namespace,   $id,   $idsToCheck) : mixed|false

Parameters

$namespace
$id
$idsToCheck

Returns

mixed|false

delete()

delete(  $namespace, string  $id) : boolean

Deletes an entry from the cache

Parameters

$namespace
string $id

The id of the cache entry to fetch.

Returns

boolean —

TRUE if the entry was successfully deleted, FALSE otherwise.

deleteAll()

deleteAll(  $namespace) : boolean

Deletes ALL entries from the cache

Parameters

$namespace

Returns

boolean —

TRUE if the entries were successfully deleted, FALSE otherwise.

supportsPatternDelete()

supportsPatternDelete(string  $namespace) : boolean

Parameters

string $namespace

Returns

boolean

deleteKeyStartingWith()

deleteKeyStartingWith(string  $namespace, string  $id) : boolean

Parameters

string $namespace
string $id

Returns

boolean

listNamespaces()

listNamespaces() : array

Returns

array

getStats()

getStats(  $namespace) : array|null

Parameters

$namespace

Returns

array|null

__destruct()

__destruct() 

__construct()

__construct(string  $id, string  $baseDir) 

Construction method

Parameters

string $id
string $baseDir

__clone()

__clone() 

Make sure to clone the XML manifest document, otherwise if the plugin changes it dynamically, it can mess up things.

getWorkDirForPluginId()

getWorkDirForPluginId(  $pluginId) : string

Parameters

$pluginId

Returns

string

init()

init(\Pydio\Core\Model\ContextInterface  $ctx, array  $options = array()) 

Initialise the cache driver based on config

Parameters

\Pydio\Core\Model\ContextInterface $ctx
array $options

array of options specific to the cache driver.

performChecks()

performChecks() 

Perform initialization checks, and throw exception if problems found.

Throws

\Exception

isEnabled()

isEnabled() : boolean

Returns

boolean

loadManifest()

loadManifest() : void

Load the main manifest.xml file of the plugni

Throws

\Exception

getManifestLabel()

getManifestLabel() : mixed|string

Get the plugin label as defined in the manifest file (label attribute)

Returns

mixed|string

getManifestDescription()

getManifestDescription() : mixed|string

Get the plugin description as defined in the manifest file (description attribute)

Returns

mixed|string

serialize()

serialize() : string

Serialized all declared attributes and return a serialized representation of this plugin.

The XML Manifest is base64 encoded before serialization.

Returns

string

unserialize()

unserialize(  $string) : void

Load this plugin from its serialized reprensation. The manifest XML is base64 decoded.

Parameters

$string

getManifestRawContent()

getManifestRawContent(string  $xmlNodeName = "", string  $format = "string", boolean  $externalFiles = false) : \DOMElement|\DOMNodeList|string

Legacy function, should better be used to return XML Nodes than string. Perform a query on the manifest.

Parameters

string $xmlNodeName
string $format
boolean $externalFiles

Returns

\DOMElement|\DOMNodeList|string

getRegistryContributions()

getRegistryContributions(\Pydio\Core\Model\ContextInterface  $ctx, boolean  $extendedVersion = true) : array<mixed,\DOMElement>

Return the registry contributions. The parameter can be used by subclasses to optimize the size of the XML returned : the extended version is called when sending to the client, whereas the "small" version is loaded to find and apply actions.

Parameters

\Pydio\Core\Model\ContextInterface $ctx
boolean $extendedVersion

Can be used by subclasses to optimize the size of the XML returned.

Returns

array<mixed,\DOMElement>

dependsOn()

dependsOn(string  $pluginName) : boolean

Check if this plugin depends on another one.

Parameters

string $pluginName

Returns

boolean

getActiveDependencies()

getActiveDependencies(\Pydio\Core\PluginFramework\PluginsService  $pluginService) : array

Get dependencies

Parameters

\Pydio\Core\PluginFramework\PluginsService $pluginService

Returns

array

getConfigsDefinitions()

getConfigsDefinitions() : array

Returns

array

loadConfigs()

loadConfigs(array  $configData) : void

Load the configs passed as parameter. This method will + Parse the config definitions and load the default values + Merge these values with the $configData parameter + Publish their value in the manifest if the global_param is "exposed" to the client.

Parameters

array $configData

getConfigs()

getConfigs() : array

Return this plugin configs, merged with its associated "core" configs.

Returns

array

getClassFile()

getClassFile() : array|boolean

Return the file path of the specific class to load

Returns

array|boolean

missingExtensions()

missingExtensions() : array

Returns

array

hasMissingExtensions()

hasMissingExtensions() : boolean

Returns

boolean

manifestLoaded()

manifestLoaded() : boolean

Returns

boolean

getId()

getId() : string

Returns

string

getName()

getName() : string

Returns

string

getType()

getType() : string

Returns

string

getBaseDir()

getBaseDir() : string

Returns

string

getDependencies()

getDependencies() : array

Returns

array

logDebug()

logDebug(string  $prefix, array|string  $message = "") : void

Write a debug log with the plugin id as source

Parameters

string $prefix

A quick description or action

array|string $message

Variable number of message args (string or array)

logInfo()

logInfo(string  $prefix, array|string  $message) : void

Write an info log with the plugin id as source

Parameters

string $prefix

A quick description or action

array|string $message

Variable number of message args (string or array)

logNotice()

logNotice(string  $prefix, array|string  $message) : void

Write a notice log with the plugin id as source

Parameters

string $prefix

A quick description or action

array|string $message

Variable number of message args (string or array)

logWarning()

logWarning(string  $prefix, array|string  $message) : void

Write a warning log with the plugin id as source

Parameters

string $prefix

A quick description or action

array|string $message

Variable number of message args (string or array)

logError()

logError(string  $prefix, array|string  $message) : void

Write an error log with the plugin id as source

Parameters

string $prefix

A quick description or action

array|string $message

Variable number of message args (string or array)

detectStreamWrapper()

detectStreamWrapper(boolean  $register = false, \Pydio\Core\Model\ContextInterface  $ctx = null) : array|boolean

Detect if this plugin declares a StreamWrapper, and if yes loads it and register the stream.

Parameters

boolean $register
\Pydio\Core\Model\ContextInterface $ctx

Returns

array|boolean

getPluginInformation()

getPluginInformation() : array

Returns

array

getPluginInformationHTML()

getPluginInformationHTML(  $defaultAuthor,   $defaultUriBase) : string

Parameters

$defaultAuthor
$defaultUriBase

Returns

string

reloadXPath()

reloadXPath() : void

hasMixin()

hasMixin(  $mixinName) : boolean

Parameters

$mixinName

Returns

boolean

_apc_init()

_apc_init(  $options) : \Doctrine\Common\Cache\ApcCache|\Pydio\Cache\Doctrine\Ext\PydioApcuCache

Parameters

$options

Returns

\Doctrine\Common\Cache\ApcCache|\Pydio\Cache\Doctrine\Ext\PydioApcuCache

_memcache_init()

_memcache_init(  $options) : \Doctrine\Common\Cache\MemcacheCache|null

Parameters

$options

Returns

\Doctrine\Common\Cache\MemcacheCache|null

_memcached_init()

_memcached_init(  $options) : \Doctrine\Common\Cache\MemcachedCache|null

Parameters

$options

Returns

\Doctrine\Common\Cache\MemcachedCache|null

_xcache_init()

_xcache_init(  $options) : \Doctrine\Common\Cache\XcacheCache

Parameters

$options

Returns

\Doctrine\Common\Cache\XcacheCache

getTimestampKey()

getTimestampKey(string  $id) : string

Parameters

string $id

Returns

string

requiresHttpForwarding()

requiresHttpForwarding(  $cacheDriver) : boolean

Parameters

$cacheDriver

Returns

boolean

getHttpClient()

getHttpClient() : \GuzzleHttp\Client

Throws

\Pydio\Core\Exception\PydioException

Returns

\GuzzleHttp\Client

getPluginWorkDir()

getPluginWorkDir(boolean  $check = false) : string

Parameters

boolean $check

Throws

\Exception

Returns

string

getPluginCacheDir()

getPluginCacheDir(boolean  $shared = false, boolean  $check = false) : string

Parameters

boolean $shared
boolean $check

Throws

\Exception

Returns

string

getXPath()

getXPath() : \DOMXPath

Returns

\DOMXPath

getContextualOption()

getContextualOption(\Pydio\Core\Model\ContextInterface  $ctx,   $optionName) : mixed|null

Parameters

\Pydio\Core\Model\ContextInterface $ctx
$optionName

Returns

mixed|null

loadRegistryContributions()

loadRegistryContributions(\Pydio\Core\Model\ContextInterface  $ctx, boolean  $dry = false) 

Main function for loading all the nodes under registry_contributions.

Parameters

\Pydio\Core\Model\ContextInterface $ctx
boolean $dry

initXmlContributionFile()

initXmlContributionFile(\Pydio\Core\Model\ContextInterface  $ctx, string  $xmlFile, array  $include = array("*"), array  $exclude = array(), boolean  $dry = false) 

Load an external XML file and include/exclude its nodes as contributions.

Parameters

\Pydio\Core\Model\ContextInterface $ctx
string $xmlFile

Path to the file from the base install path

array $include

XPath query for XML Nodes to include

array $exclude

XPath query for XML Nodes to exclude from the included ones.

boolean $dry

Dry-run of the inclusion

parseSpecificContributions()

parseSpecificContributions(\Pydio\Core\Model\ContextInterface  $ctx, \DOMNode  $contribNode) : void

Dynamically modify some registry contributions nodes. Can be easily derivated to enable/disable some features dynamically during plugin initialization.

Parameters

\Pydio\Core\Model\ContextInterface $ctx
\DOMNode $contribNode

unserializeManifest()

unserializeManifest() 

Load DOMDocument from serialized value. Must be called after checking that property $this->manifestXML is not null.

loadDependencies()

loadDependencies() : void

Load the declared dependant plugins

cachedNodesFromManifest()

cachedNodesFromManifest(  $query) : array|mixed

Parameters

$query

Returns

array|mixed

loadConfigsDefinitions()

loadConfigsDefinitions() : void

Load the global parameters for this plugin

loadOptionsDefaults()

loadOptionsDefaults() : array

Load the default values for this plugin options

Returns

array

exposeConfigInManifest()

exposeConfigInManifest(  $configName,   $configValue) : void

Add a name/value pair in the manifest to be published to the world.

Parameters

$configName
$configValue

loadMixins()

loadMixins() : void

Check if the plugin declares mixins, and load them using PluginsService::patchPluginWithMixin method

nodeAttrToHash()

nodeAttrToHash(\DOMNode  $node) : array

Transform a simple node and its attributes to a HashTable

Parameters

\DOMNode $node

Returns

array

nodesEqual()

nodesEqual(\DOMNode  $node1, \DOMNode  $node2) : boolean

Compare two nodes at first level (nodename and attributes)

Parameters

\DOMNode $node1
\DOMNode $node2

Returns

boolean

initCacheWithNamespace()

initCacheWithNamespace(  $namespace) : \Doctrine\Common\Cache\ApcCache|\Doctrine\Common\Cache\MemcacheCache|\Doctrine\Common\Cache\MemcachedCache|\Doctrine\Common\Cache\XcacheCache|null|\Pydio\Cache\Doctrine\Ext\PydioApcuCache|\Pydio\Cache\Doctrine\Ext\PydioRedisCache

Parameters

$namespace

Returns

\Doctrine\Common\Cache\ApcCache|\Doctrine\Common\Cache\MemcacheCache|\Doctrine\Common\Cache\MemcachedCache|\Doctrine\Common\Cache\XcacheCache|null|\Pydio\Cache\Doctrine\Ext\PydioApcuCache|\Pydio\Cache\Doctrine\Ext\PydioRedisCache