PHPFUI/InstaDoc
 
Copied!
Abstract
Methods
public static pregSplit(string $pattern, string $subject, int $limit = -1, int $flags = 0) : array
 

Wrapper function for phps preg_split

This function is inspired by {@link https://github.com/thecodingmachine/safe/blob/master/generated/pcre.php}. But since this library is all about performance we decided to strip everything we don't need. Reducing the amount of files that have to be loaded, etc.

  • param string $pattern The pattern to search for, as a string.
  • param string $subject The input string.
  • param int $limit If specified, then only substrings up to limit are returned with the rest of the string being placed in the last substring. A limit of -1 or 0 means "no limit".
  • param int $flags flags can be any combination of the following flags (combined with the | bitwise operator): PREG_SPLIT_NO_EMPTY* If this flag is set, only non-empty pieces will be returned by preg_split(). PREG_SPLIT_DELIM_CAPTURE* If this flag is set, parenthesized expression in the delimiter pattern will be captured and returned as well. PREG_SPLIT_OFFSET_CAPTURE* If this flag is set, for every occurring match the appendant string offset will also be returned. Note that this changes the return value in an array where every element is an array consisting of the matched string at offset 0 and its string offset into subject at offset 1.
  • return string[] Returns an array containing substrings of subject split along boundaries matched by pattern
  • throws \PcreException
Methods
public static pregSplit(string $pattern, string $subject, int $limit = -1, int $flags = 0) : array
 

Wrapper function for phps preg_split

This function is inspired by {@link https://github.com/thecodingmachine/safe/blob/master/generated/pcre.php}. But since this library is all about performance we decided to strip everything we don't need. Reducing the amount of files that have to be loaded, etc.

  • param string $pattern The pattern to search for, as a string.
  • param string $subject The input string.
  • param int $limit If specified, then only substrings up to limit are returned with the rest of the string being placed in the last substring. A limit of -1 or 0 means "no limit".
  • param int $flags flags can be any combination of the following flags (combined with the | bitwise operator): PREG_SPLIT_NO_EMPTY* If this flag is set, only non-empty pieces will be returned by preg_split(). PREG_SPLIT_DELIM_CAPTURE* If this flag is set, parenthesized expression in the delimiter pattern will be captured and returned as well. PREG_SPLIT_OFFSET_CAPTURE* If this flag is set, for every occurring match the appendant string offset will also be returned. Note that this changes the return value in an array where every element is an array consisting of the matched string at offset 0 and its string offset into subject at offset 1.
  • return string[] Returns an array containing substrings of subject split along boundaries matched by pattern
  • throws \PcreException
© 2025 Bruce Wells
Search Namespaces \ Classes
Configuration