Search moodle.org's
Developer Documentation

See Release Notes
Long Term Support Release

  • Bug fixes for general core bugs in 4.1.x will end 13 November 2023 (12 months).
  • Bug fixes for security issues in 4.1.x will end 10 November 2025 (36 months).
  • PHP version: minimum PHP 7.4.0 Note: minimum PHP version has increased since Moodle 4.0. PHP 8.0.x is supported too.
/lib/htmlpurifier/HTMLPurifier/DefinitionCache/ -> Serializer.php (source)

[Source view]

(no description)

File Size: 311 lines (9 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

HTMLPurifier_DefinitionCache_Serializer:: (13 methods):
  add()
  set()
  replace()
  get()
  remove()
  flush()
  cleanup()
  generateFilePath()
  generateDirectoryPath()
  generateBaseDirectoryPath()
  _write()
  _prepareDir()
  _testPermissions()


Class: HTMLPurifier_DefinitionCache_Serializer  - X-Ref

add($def, $config)   X-Ref

param: HTMLPurifier_Definition $def
param: HTMLPurifier_Config $config
return: int|bool

set($def, $config)   X-Ref

param: HTMLPurifier_Definition $def
param: HTMLPurifier_Config $config
return: int|bool

replace($def, $config)   X-Ref

param: HTMLPurifier_Definition $def
param: HTMLPurifier_Config $config
return: int|bool

get($config)   X-Ref

param: HTMLPurifier_Config $config
return: bool|HTMLPurifier_Config

remove($config)   X-Ref

param: HTMLPurifier_Config $config
return: bool

flush($config)   X-Ref

param: HTMLPurifier_Config $config
return: bool

cleanup($config)   X-Ref

param: HTMLPurifier_Config $config
return: bool

generateFilePath($config)   X-Ref
Generates the file path to the serial file corresponding to
the configuration and definition name

param: HTMLPurifier_Config $config
return: string

generateDirectoryPath($config)   X-Ref
Generates the path to the directory contain this cache's serial files

param: HTMLPurifier_Config $config
return: string

generateBaseDirectoryPath($config)   X-Ref
Generates path to base directory that contains all definition type
serials

param: HTMLPurifier_Config $config
return: mixed|string

_write($file, $data, $config)   X-Ref
Convenience wrapper function for file_put_contents

param: string $file File name to write to
param: string $data Data to write into file
param: HTMLPurifier_Config $config
return: int|bool Number of bytes written if success, or false if failure.

_prepareDir($config)   X-Ref
Prepares the directory that this type stores the serials in

param: HTMLPurifier_Config $config
return: bool True if successful

_testPermissions($dir, $chmod)   X-Ref
Tests permissions on a directory and throws out friendly
error messages and attempts to chmod it itself if possible

param: string $dir Directory path
param: int $chmod Permissions
return: bool True if directory is writable