Open In App

PHP SplObjectStorage key() Function

Last Updated : 23 Jun, 2023
Improve
Improve
Like Article
Like
Save
Share
Report

The SplObjectStorage::key() function is an inbuilt function in PHP which is used to get the index of the currently pointing iterator. Syntax:

int SplObjectStorage::key()

Parameters: This function does not accept any parameter. Return Value: This function returns the index at which the iterator currently pointing. Below programs illustrate the SplObjectStorage::key() function in PHP: Program 1: 

php




<?php
  
// Create an empty SplObjectStorage
$str = new SplObjectStorage();
  
$obj = new StdClass;
  
$str->attach($obj, "d1");
  
$str->rewind();
  
// Get current index 
$index  = $str->key();
  
// Print Result
var_dump($index);
?>


Output:

int(0)

Program 2: 

php




<?php
  
// Create an Empty SplObjectStorage
$str = new SplObjectStorage();
   
$obj1 = new StdClass;
$obj2 = new StdClass;
$obj3 = new StdClass;
$obj4 = new StdClass;
   
$str->attach($obj1, "GeeksforGeeks");
$str->attach($obj2, "GFG");
$str->attach($obj3);
$str->attach($obj4, "DSA");
   
$str->rewind();
   
// Iterate and print data on each index
while($str->valid()) {
      
    // Get index 
    $index  = $str->key();
    $object = $str->current(); 
    $data   = $str->getInfo();
   
    var_dump($index, $data);
    $str->next();
}
?>


Output:

int(0)
string(12) "GeksforGeeks"
int(1)
string(3) "GFG"
int(2)
NULL
int(3)
string(3) "DSA"

Reference: https://www.php.net/manual/en/splobjectstorage.key.php



Similar Reads

PHP SplObjectStorage contains() Function
The SplObjectStorage::contains() function is an inbuilt function in PHP which is used to check the storage object contains a specified object or not. Syntax: bool SplObjectStorage::contains( $value ) Parameters: This function accepts a single parameter $value which specifies the storage object which is going to check. Return Value: This function re
1 min read
PHP SplObjectStorage count() Function
The SplObjectStorage::count() function is an inbuilt function in PHP which is used to count the number of objects in storage. Syntax: int SplObjectStorage::count() Parameters: This function does not contains any parameter. Return Value: This function returns number of objects in storage. Below programs illustrate the SplObjectStorage::count() funct
1 min read
PHP SplObjectStorage addAll() Function
The SplObjectStorage::addAll() function is an inbuilt function in PHP which is used to add elements from another storage. Syntax: void SplObjectStorage::addAll( $value ) Parameters: This function accepts a single parameter $value which holds an storage which need to import. Return Value: It does not return any value. Below programs illustrate the S
1 min read
PHP SplObjectStorage valid() Function
The SplObjectStorage::valid() function is an inbuilt function in PHP which is used to check the current storage entry is valid or not. Syntax: bool SplObjectStorage::valid() Parameters: This function does not accept any parameter. Return Value: This function returns true if the iterator entry is valid, false otherwise. Below programs illustrate the
1 min read
PHP SplObjectStorage attach() Function
The SplObjectStorage::attach() function is an inbuilt function in PHP which is used to add objects into the SplObjectStorage. Syntax: void SplObjectStorage::attach($obj, $val) Parameters: This function accepts two parameters as mention above and described below. $obj: This is required parameter which specifies the object of the storage class. $val:
1 min read
PHP SplObjectStorage current() Function
The SplObjectStorage::current() function is an inbuilt function in PHP which is used get the current entry of storage. Syntax: object SplObjectStorage::current() Parameters: This function does not accept any parameter. Return Value: This function returns the object of the current storage. Below programs illustrate the SplObjectStorage::current() fu
1 min read
PHP SplObjectStorage next() Function
The SplObjectStorage::next() function is an inbuilt function in PHP which is used to move to next entry of storage. Syntax: void SplObjectStorage::next() Parameters: This function does not accept any parameter. Return Value: This function does not return any value. Below programs illustrate the SplObjectStorage::next() function in PHP: Program 1: P
1 min read
PHP SplObjectStorage detach() Function
The SplObjectStorage::detach() function is an inbuilt function in PHP which is used to remove objects from the storage. Syntax: void SplObjectStorage::detach($obj) Parameters: This function accepts a single parameter $obj which specifies the object to be remove from the storage. Return Value: This function does not return any value. Below programs
1 min read
PHP SplObjectStorage getinfo() Function
The SplObjectStorage::getinfo() function is an inbuilt function in PHP that is used to get the data associated with the object by the current iterator position. Syntax: mixed SplObjectStorage::getinfo() Parameters: This function does not accept any parameter. Return Value: This function returns the object associated by the current iterator position
1 min read
PHP SplObjectStorage offsetSet() Function
The SplObjectStorage::offsetSet() function is an inbuilt function in PHP which is used to set the object of storage. Syntax: void SplObjectStorage::offsetSet($obj, $val) Parameters: This function accept two parameters as mention above and described below: $obj: It specifies the object to be attach.$val: It specifies the value to be associate with t
1 min read