DynamicArray::setSize

(Available since version 1.0)

DynamicArray::setSizeChange the size of an array

Description

public int DynamicArray::setSize ( int $size )

Change the size of an array to the new size of size. If size is less than the current array size, any values after the new size will be discarded. If size is greater than the current array size, the array will be padded with NULL values.

Parameters

size

The new array size. This should be a value between 0 and PHP_INT_MAX.

Return Values

Returns 1 instead of void to match SplFixedArray.

Errors/Exceptions

Throws SEIDS::Arrays::InvalidArgumentException when size is less than zero.

Throws E_USER_WARNING when size cannot be used as a number.

Examples

Example #1 DynamicArray::setSize() example

<?php
require 'vendor/autoload.php'// A PSR-4 or PSR-0 autoloader
use \SEIDS\Arrays\Dynamic\DynamicArray;

$array = new DynamicArray(5);
echo 
$array->getSize()."\n";
$array->setSize(10);
echo 
$array->getSize()."\n";
?>

The above example will output:

5
10

To Top