$sanitizer->intArray() method

Sanitize array or CSV string to array of unsigned integers (or signed integers if specified $min is less than 0)

If string specified, string delimiter may be comma (","), or pipe ("|"), or you may override with the 'delimiter' option.

Usage

// basic usage
$array = $sanitizer->intArray($value);

// usage with all arguments
$array = $sanitizer->intArray($value, $options = []);

Arguments

NameType(s)Description
valuearray, string, mixed

Accepts an array or CSV string. If given something else, it becomes first value in array.

options (optional)array, bool

Optional options (see Sanitizer::array() and Sanitizer::int() methods for options), plus these two:

  • min (int): Minimum allowed value (default=0)
  • max (int): Maximum allowed value (default=PHP_INT_MAX)
  • strict (bool): Remove rather than convert any values that are not all digits or fall outside min/max range? (default=false) Since 3.0.157+
  • maxItems (int): Maximum items allowed in each array (default=0, which means no limit)
  • maxDepth (int): Max nested array depth (default=0, which means no nesting allowed) Since 3.0.160
  • You may specify boolean true for $options argument to use just the strict option. (3.0.157+)
  • The following options are only used if the provided $value is a string:
  • csv (bool): Allow conversion of delimited string to array? (default=true) Since 3.0.165
  • delimiter (string): Single delimiter to use to identify CSV strings. Overrides the 'delimiters' option when specified (default=null)
  • delimiters (array): Delimiters to identify CSV strings. First found delimiter will be used, default=array("|", ",")
  • enclosure (string): Enclosure to use for CSV strings (default=double quote, i.e. ")

Return value

array

Array of integers


$sanitizer methods and properties

API reference based on ProcessWire core version 3.0.236

Latest news

  • ProcessWire Weekly #522
    In the 522nd issue of ProcessWire Weekly we'll check out the latest core updates, introduce a new module called File Mover, and more. Read on!
    Weekly.pw / 11 May 2024
  • ProFields Table Field with Actions support
    This week we have some updates for the ProFields table field (FieldtypeTable). These updates are primarily focused on adding new tools for the editor to facilitate input and management of content in a table field.
    Blog / 12 April 2024
  • Subscribe to weekly ProcessWire news

“ProcessWire is like a breath of fresh air. So powerful yet simple to build with and customise, and web editors love it too.” —Margaret Chatwin, Web developer