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/spout/src/Spout/Common/Helper/ -> StringHelper.php (source)

[Source view]

Differences Between: [Versions 310 and 401] [Versions 39 and 401]

(no description)

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

Defines 1 class

StringHelper:: (5 methods):
  __construct()
  getStringLength()
  getCharFirstOccurrencePosition()
  getCharLastOccurrencePosition()
  formatNumericValue()


Class: StringHelper  - X-Ref

Class StringHelper
This class provides helper functions to work with strings and multibyte strings.

__construct()   X-Ref
No description

getStringLength($string)   X-Ref
Returns the length of the given string.
It uses the multi-bytes function is available.

param: string $string
return: int

getCharFirstOccurrencePosition($char, $string)   X-Ref
Returns the position of the first occurrence of the given character/substring within the given string.
It uses the multi-bytes function is available.

param: string $char Needle
param: string $string Haystack
return: int Char/substring's first occurrence position within the string if found (starts at 0) or -1 if not found

getCharLastOccurrencePosition($char, $string)   X-Ref
Returns the position of the last occurrence of the given character/substring within the given string.
It uses the multi-bytes function is available.

param: string $char Needle
param: string $string Haystack
return: int Char/substring's last occurrence position within the string if found (starts at 0) or -1 if not found

formatNumericValue($numericValue)   X-Ref
Formats a numeric value (int or float) in a way that's compatible with the expected spreadsheet format.

Formatting of float values is locale dependent in PHP < 8.
Thousands separators and decimal points vary from locale to locale (en_US: 12.34 vs pl_PL: 12,34).
However, float values must be formatted with no thousands separator and a "." as decimal point
to work properly. This method can be used to convert the value to the correct format before storing it.

param: int|float $numericValue
return: string