php-internal-docs 8.4.8
Unofficial docs for php/php-src
Loading...
Searching...
No Matches
spl_iterators.h File Reference
#include "php.h"

Go to the source code of this file.

Macros

#define RIT_CATCH_GET_CHILD   CIT_CATCH_GET_CHILD
 

Typedefs

typedef int(* spl_iterator_apply_func_t) (zend_object_iterator *iter, void *puser)
 

Enumerations

enum  RecursiveIteratorMode { RIT_LEAVES_ONLY = 0 , RIT_SELF_FIRST = 1 , RIT_CHILD_FIRST = 2 }
 
enum  RecursiveTreeIteratorFlags { RTIT_BYPASS_CURRENT = 4 , RTIT_BYPASS_KEY = 8 }
 
enum  dual_it_type {
  DIT_Default = 0 , DIT_FilterIterator = DIT_Default , DIT_RecursiveFilterIterator = DIT_Default , DIT_ParentIterator = DIT_Default ,
  DIT_LimitIterator , DIT_CachingIterator , DIT_RecursiveCachingIterator , DIT_IteratorIterator ,
  DIT_NoRewindIterator , DIT_InfiniteIterator , DIT_AppendIterator , DIT_RegexIterator ,
  DIT_RecursiveRegexIterator , DIT_CallbackFilterIterator , DIT_RecursiveCallbackFilterIterator , DIT_Unknown = ~0
}
 
enum  recursive_it_it_type { RIT_Default = 0 , RIT_RecursiveIteratorIterator = RIT_Default , RIT_RecursiveTreeIterator , RIT_Unknow = ~0 }
 
enum  {
  CIT_CALL_TOSTRING = 0x00000001 , CIT_TOSTRING_USE_KEY = 0x00000002 , CIT_TOSTRING_USE_CURRENT = 0x00000004 , CIT_TOSTRING_USE_INNER = 0x00000008 ,
  CIT_CATCH_GET_CHILD = 0x00000010 , CIT_FULL_CACHE = 0x00000100 , CIT_PUBLIC = 0x0000FFFF , CIT_VALID = 0x00010000 ,
  CIT_HAS_CHILDREN = 0x00020000
}
 
enum  { REGIT_USE_KEY = 0x00000001 , REGIT_INVERTED = 0x00000002 }
 
enum  regex_mode {
  REGIT_MODE_MATCH , REGIT_MODE_GET_MATCH , REGIT_MODE_ALL_MATCHES , REGIT_MODE_SPLIT ,
  REGIT_MODE_REPLACE , REGIT_MODE_MAX
}
 

Functions

 PHP_MINIT_FUNCTION (spl_iterators)
 
PHPAPI zend_result spl_iterator_apply (zval *obj, spl_iterator_apply_func_t apply_func, void *puser)
 

Variables

PHPAPI zend_class_entryspl_ce_AppendIterator
 
PHPAPI zend_class_entryspl_ce_CachingIterator
 
PHPAPI zend_class_entryspl_ce_CallbackFilterIterator
 
PHPAPI zend_class_entryspl_ce_EmptyIterator
 
PHPAPI zend_class_entryspl_ce_FilterIterator
 
PHPAPI zend_class_entryspl_ce_InfiniteIterator
 
PHPAPI zend_class_entryspl_ce_IteratorIterator
 
PHPAPI zend_class_entryspl_ce_LimitIterator
 
PHPAPI zend_class_entryspl_ce_NoRewindIterator
 
PHPAPI zend_class_entryspl_ce_OuterIterator
 
PHPAPI zend_class_entryspl_ce_ParentIterator
 
PHPAPI zend_class_entryspl_ce_RecursiveCachingIterator
 
PHPAPI zend_class_entryspl_ce_RecursiveCallbackFilterIterator
 
PHPAPI zend_class_entryspl_ce_RecursiveFilterIterator
 
PHPAPI zend_class_entryspl_ce_RecursiveIterator
 
PHPAPI zend_class_entryspl_ce_RecursiveIteratorIterator
 
PHPAPI zend_class_entryspl_ce_RecursiveRegexIterator
 
PHPAPI zend_class_entryspl_ce_RecursiveTreeIterator
 
PHPAPI zend_class_entryspl_ce_RegexIterator
 
PHPAPI zend_class_entryspl_ce_SeekableIterator
 

Macro Definition Documentation

◆ RIT_CATCH_GET_CHILD

#define RIT_CATCH_GET_CHILD   CIT_CATCH_GET_CHILD

Definition at line 52 of file spl_iterators.h.

Typedef Documentation

◆ spl_iterator_apply_func_t

typedef int(* spl_iterator_apply_func_t) (zend_object_iterator *iter, void *puser)

Definition at line 114 of file spl_iterators.h.

Enumeration Type Documentation

◆ anonymous enum

anonymous enum
Enumerator
CIT_CALL_TOSTRING 
CIT_TOSTRING_USE_KEY 
CIT_TOSTRING_USE_CURRENT 
CIT_TOSTRING_USE_INNER 
CIT_CATCH_GET_CHILD 
CIT_FULL_CACHE 
CIT_PUBLIC 
CIT_VALID 
CIT_HAS_CHILDREN 

Definition at line 85 of file spl_iterators.h.

◆ anonymous enum

anonymous enum
Enumerator
REGIT_USE_KEY 
REGIT_INVERTED 

Definition at line 99 of file spl_iterators.h.

◆ dual_it_type

Enumerator
DIT_Default 
DIT_FilterIterator 
DIT_RecursiveFilterIterator 
DIT_ParentIterator 
DIT_LimitIterator 
DIT_CachingIterator 
DIT_RecursiveCachingIterator 
DIT_IteratorIterator 
DIT_NoRewindIterator 
DIT_InfiniteIterator 
DIT_AppendIterator 
DIT_RegexIterator 
DIT_RecursiveRegexIterator 
DIT_CallbackFilterIterator 
DIT_RecursiveCallbackFilterIterator 
DIT_Unknown 

Definition at line 59 of file spl_iterators.h.

◆ recursive_it_it_type

Enumerator
RIT_Default 
RIT_RecursiveIteratorIterator 
RIT_RecursiveTreeIterator 
RIT_Unknow 

Definition at line 78 of file spl_iterators.h.

◆ RecursiveIteratorMode

Enumerator
RIT_LEAVES_ONLY 
RIT_SELF_FIRST 
RIT_CHILD_FIRST 

Definition at line 46 of file spl_iterators.h.

◆ RecursiveTreeIteratorFlags

Enumerator
RTIT_BYPASS_CURRENT 
RTIT_BYPASS_KEY 

Definition at line 54 of file spl_iterators.h.

◆ regex_mode

enum regex_mode
Enumerator
REGIT_MODE_MATCH 
REGIT_MODE_GET_MATCH 
REGIT_MODE_ALL_MATCHES 
REGIT_MODE_SPLIT 
REGIT_MODE_REPLACE 
REGIT_MODE_MAX 

Definition at line 105 of file spl_iterators.h.

Function Documentation

◆ PHP_MINIT_FUNCTION()

PHP_MINIT_FUNCTION ( spl_iterators )

Definition at line 3111 of file spl_iterators.c.

◆ spl_iterator_apply()

PHPAPI zend_result spl_iterator_apply ( zval * obj,
spl_iterator_apply_func_t apply_func,
void * puser )

Definition at line 2929 of file spl_iterators.c.

Variable Documentation

◆ spl_ce_AppendIterator

PHPAPI zend_class_entry* spl_ce_AppendIterator
extern

Definition at line 52 of file spl_iterators.c.

◆ spl_ce_CachingIterator

PHPAPI zend_class_entry* spl_ce_CachingIterator
extern

Definition at line 45 of file spl_iterators.c.

◆ spl_ce_CallbackFilterIterator

PHPAPI zend_class_entry* spl_ce_CallbackFilterIterator
extern

Definition at line 39 of file spl_iterators.c.

◆ spl_ce_EmptyIterator

PHPAPI zend_class_entry* spl_ce_EmptyIterator
extern

Definition at line 51 of file spl_iterators.c.

◆ spl_ce_FilterIterator

PHPAPI zend_class_entry* spl_ce_FilterIterator
extern

Definition at line 38 of file spl_iterators.c.

◆ spl_ce_InfiniteIterator

PHPAPI zend_class_entry* spl_ce_InfiniteIterator
extern

Definition at line 50 of file spl_iterators.c.

◆ spl_ce_IteratorIterator

PHPAPI zend_class_entry* spl_ce_IteratorIterator
extern

Definition at line 48 of file spl_iterators.c.

◆ spl_ce_LimitIterator

PHPAPI zend_class_entry* spl_ce_LimitIterator
extern

Definition at line 44 of file spl_iterators.c.

◆ spl_ce_NoRewindIterator

PHPAPI zend_class_entry* spl_ce_NoRewindIterator
extern

Definition at line 49 of file spl_iterators.c.

◆ spl_ce_OuterIterator

PHPAPI zend_class_entry* spl_ce_OuterIterator
extern

Definition at line 47 of file spl_iterators.c.

◆ spl_ce_ParentIterator

PHPAPI zend_class_entry* spl_ce_ParentIterator
extern

Definition at line 42 of file spl_iterators.c.

◆ spl_ce_RecursiveCachingIterator

PHPAPI zend_class_entry* spl_ce_RecursiveCachingIterator
extern

Definition at line 46 of file spl_iterators.c.

◆ spl_ce_RecursiveCallbackFilterIterator

PHPAPI zend_class_entry* spl_ce_RecursiveCallbackFilterIterator
extern

Definition at line 41 of file spl_iterators.c.

◆ spl_ce_RecursiveFilterIterator

PHPAPI zend_class_entry* spl_ce_RecursiveFilterIterator
extern

Definition at line 40 of file spl_iterators.c.

◆ spl_ce_RecursiveIterator

PHPAPI zend_class_entry* spl_ce_RecursiveIterator
extern

Definition at line 36 of file spl_iterators.c.

◆ spl_ce_RecursiveIteratorIterator

PHPAPI zend_class_entry* spl_ce_RecursiveIteratorIterator
extern

Definition at line 37 of file spl_iterators.c.

◆ spl_ce_RecursiveRegexIterator

PHPAPI zend_class_entry* spl_ce_RecursiveRegexIterator
extern

Definition at line 54 of file spl_iterators.c.

◆ spl_ce_RecursiveTreeIterator

PHPAPI zend_class_entry* spl_ce_RecursiveTreeIterator
extern

Definition at line 55 of file spl_iterators.c.

◆ spl_ce_RegexIterator

PHPAPI zend_class_entry* spl_ce_RegexIterator
extern

Definition at line 53 of file spl_iterators.c.

◆ spl_ce_SeekableIterator

PHPAPI zend_class_entry* spl_ce_SeekableIterator
extern

Definition at line 43 of file spl_iterators.c.