Search moodle.org's
Developer Documentation

See Release Notes

  • Bug fixes for general core bugs in 3.10.x will end 8 November 2021 (12 months).
  • Bug fixes for security issues in 3.10.x will end 9 May 2022 (18 months).
  • PHP version: minimum PHP 7.2.0 Note: minimum PHP version has increased since Moodle 3.8. PHP 7.3.x and 7.4.x are supported too.
/lib/spout/src/Spout/Reader/XLSX/Manager/SharedStringsCaching/ -> FileBasedStrategy.php (source)

[Source view]

Differences Between: [Versions 310 and 311] [Versions 310 and 400] [Versions 310 and 401]

(no description)

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

Defines 1 class

FileBasedStrategy:: (8 methods):
  __construct()
  addStringForIndex()
  getSharedStringTempFilePath()
  closeCache()
  getStringAtIndex()
  escapeLineFeed()
  unescapeLineFeed()
  clearCache()


Class: FileBasedStrategy  - X-Ref

Class FileBasedStrategy

This class implements the file-based caching strategy for shared strings.
Shared strings are stored in small files (with a max number of strings per file).
This strategy is slower than an in-memory strategy but is used to avoid out of memory crashes.
__construct($tempFolder, $maxNumStringsPerTempFile, $helperFactory)   X-Ref

param: string $tempFolder Temporary folder where the temporary files to store shared strings will be stored
param: int $maxNumStringsPerTempFile Maximum number of strings that can be stored in one temp file
param: HelperFactory $helperFactory Factory to create helpers

addStringForIndex($sharedString, $sharedStringIndex)   X-Ref
Adds the given string to the cache.

param: string $sharedString The string to be added to the cache
param: int $sharedStringIndex Index of the shared string in the sharedStrings.xml file
return: void

getSharedStringTempFilePath($sharedStringIndex)   X-Ref
Returns the path for the temp file that should contain the string for the given index

param: int $sharedStringIndex Index of the shared string in the sharedStrings.xml file
return: string The temp file path for the given index

closeCache()   X-Ref
Closes the cache after the last shared string was added.
This prevents any additional string from being added to the cache.

return: void

getStringAtIndex($sharedStringIndex)   X-Ref
Returns the string located at the given index from the cache.

param: int $sharedStringIndex Index of the shared string in the sharedStrings.xml file
return: string The shared string at the given index

escapeLineFeed($unescapedString)   X-Ref
Escapes the line feed characters (\n)

param: string $unescapedString
return: string

unescapeLineFeed($escapedString)   X-Ref
Unescapes the line feed characters (\n)

param: string $escapedString
return: string

clearCache()   X-Ref
Destroys the cache, freeing memory and removing any created artifacts

return: void