Search moodle.org's
Developer Documentation

See Release Notes

  • Bug fixes for general core bugs in 4.2.x will end 22 April 2024 (12 months).
  • Bug fixes for security issues in 4.2.x will end 7 October 2024 (18 months).
  • PHP version: minimum PHP 8.0.0 Note: minimum PHP version has increased since Moodle 4.1. PHP 8.1.x is supported too.
/lib/openspout/src/Reader/XLSX/Manager/SharedStringsCaching/ -> FileBasedStrategy.php (source)

[Source view]

Differences Between: [Versions 402 and 403]

(no description)

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

Defines 1 class

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


Class: FileBasedStrategy  - X-Ref

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(string $tempFolder, int $maxNumStringsPerTempFile)   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

addStringForIndex(string $sharedString, int $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

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


getStringAtIndex(int $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

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


getSharedStringTempFilePath(int $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

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


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