php-internal-docs 8.4.8
Unofficial docs for php/php-src
Loading...
Searching...
No Matches
Data Structures | Macros | Typedefs | Enumerations | Functions | Variables
spl_directory.h File Reference
#include "php.h"

Go to the source code of this file.

Data Structures

struct  _spl_other_handler
 
struct  _spl_filesystem_object
 

Macros

#define SPL_FILE_OBJECT_DROP_NEW_LINE   0x00000001 /* drop new lines */
 
#define SPL_FILE_OBJECT_READ_AHEAD   0x00000002 /* read on rewind/next */
 
#define SPL_FILE_OBJECT_SKIP_EMPTY   0x00000004 /* skip empty lines */
 
#define SPL_FILE_OBJECT_READ_CSV   0x00000008 /* read via fgetcsv */
 
#define SPL_FILE_OBJECT_MASK   0x0000000F /* read via fgetcsv */
 
#define SPL_FILE_DIR_CURRENT_AS_FILEINFO   0x00000000 /* make RecursiveDirectoryTree::current() return SplFileInfo */
 
#define SPL_FILE_DIR_CURRENT_AS_SELF   0x00000010 /* make RecursiveDirectoryTree::current() return getSelf() */
 
#define SPL_FILE_DIR_CURRENT_AS_PATHNAME   0x00000020 /* make RecursiveDirectoryTree::current() return getPathname() */
 
#define SPL_FILE_DIR_CURRENT_MODE_MASK   0x000000F0 /* mask RecursiveDirectoryTree::current() */
 
#define SPL_FILE_DIR_CURRENT(intern, mode)
 
#define SPL_FILE_DIR_KEY_AS_PATHNAME   0x00000000 /* make RecursiveDirectoryTree::key() return getPathname() */
 
#define SPL_FILE_DIR_KEY_AS_FILENAME   0x00000100 /* make RecursiveDirectoryTree::key() return getFilename() */
 
#define SPL_FILE_DIR_KEY_MODE_MASK   0x00000F00 /* mask RecursiveDirectoryTree::key() */
 
#define SPL_FILE_NEW_CURRENT_AND_KEY   SPL_FILE_DIR_KEY_AS_FILENAME|SPL_FILE_DIR_CURRENT_AS_FILEINFO
 
#define SPL_FILE_DIR_KEY(intern, mode)
 
#define SPL_FILE_DIR_SKIPDOTS   0x00001000 /* Tells whether it should skip dots or not */
 
#define SPL_FILE_DIR_UNIXPATHS   0x00002000 /* Whether to unixify path separators */
 
#define SPL_FILE_DIR_FOLLOW_SYMLINKS   0x00004000 /* make RecursiveDirectoryTree::hasChildren() follow symlinks */
 
#define SPL_FILE_DIR_OTHERS_MASK   0x00007000 /* mask used for get/setFlags */
 

Typedefs

typedef struct _spl_filesystem_object spl_filesystem_object
 
typedef void(* spl_foreign_dtor_t) (spl_filesystem_object *object)
 
typedef void(* spl_foreign_clone_t) (spl_filesystem_object *src, spl_filesystem_object *dst)
 
typedef struct _spl_other_handler spl_other_handler
 

Enumerations

enum  SPL_FS_OBJ_TYPE { SPL_FS_INFO , SPL_FS_DIR , SPL_FS_FILE }
 

Functions

 PHP_MINIT_FUNCTION (spl_directory)
 
PHPAPI zend_string * spl_filesystem_object_get_path (const spl_filesystem_object *intern)
 

Variables

PHPAPI zend_class_entry * spl_ce_SplFileInfo
 
PHPAPI zend_class_entry * spl_ce_DirectoryIterator
 
PHPAPI zend_class_entry * spl_ce_FilesystemIterator
 
PHPAPI zend_class_entry * spl_ce_RecursiveDirectoryIterator
 
PHPAPI zend_class_entry * spl_ce_GlobIterator
 
PHPAPI zend_class_entry * spl_ce_SplFileObject
 
PHPAPI zend_class_entry * spl_ce_SplTempFileObject
 

Macro Definition Documentation

◆ SPL_FILE_DIR_CURRENT

#define SPL_FILE_DIR_CURRENT ( intern,
mode )
Value:
((intern->flags&SPL_FILE_DIR_CURRENT_MODE_MASK)==mode)
mode
char * mode
Definition func_interceptors.c:282
SPL_FILE_DIR_CURRENT_MODE_MASK
#define SPL_FILE_DIR_CURRENT_MODE_MASK
Definition spl_directory.h:100

Definition at line 101 of file spl_directory.h.

◆ SPL_FILE_DIR_CURRENT_AS_FILEINFO

#define SPL_FILE_DIR_CURRENT_AS_FILEINFO   0x00000000 /* make RecursiveDirectoryTree::current() return SplFileInfo */

Definition at line 97 of file spl_directory.h.

◆ SPL_FILE_DIR_CURRENT_AS_PATHNAME

#define SPL_FILE_DIR_CURRENT_AS_PATHNAME   0x00000020 /* make RecursiveDirectoryTree::current() return getPathname() */

Definition at line 99 of file spl_directory.h.

◆ SPL_FILE_DIR_CURRENT_AS_SELF

#define SPL_FILE_DIR_CURRENT_AS_SELF   0x00000010 /* make RecursiveDirectoryTree::current() return getSelf() */

Definition at line 98 of file spl_directory.h.

◆ SPL_FILE_DIR_CURRENT_MODE_MASK

#define SPL_FILE_DIR_CURRENT_MODE_MASK   0x000000F0 /* mask RecursiveDirectoryTree::current() */

Definition at line 100 of file spl_directory.h.

◆ SPL_FILE_DIR_FOLLOW_SYMLINKS

#define SPL_FILE_DIR_FOLLOW_SYMLINKS   0x00004000 /* make RecursiveDirectoryTree::hasChildren() follow symlinks */

Definition at line 111 of file spl_directory.h.

◆ SPL_FILE_DIR_KEY

#define SPL_FILE_DIR_KEY ( intern,
mode )
Value:
((intern->flags&SPL_FILE_DIR_KEY_MODE_MASK)==mode)
SPL_FILE_DIR_KEY_MODE_MASK
#define SPL_FILE_DIR_KEY_MODE_MASK
Definition spl_directory.h:105

Definition at line 107 of file spl_directory.h.

◆ SPL_FILE_DIR_KEY_AS_FILENAME

#define SPL_FILE_DIR_KEY_AS_FILENAME   0x00000100 /* make RecursiveDirectoryTree::key() return getFilename() */

Definition at line 104 of file spl_directory.h.

◆ SPL_FILE_DIR_KEY_AS_PATHNAME

#define SPL_FILE_DIR_KEY_AS_PATHNAME   0x00000000 /* make RecursiveDirectoryTree::key() return getPathname() */

Definition at line 103 of file spl_directory.h.

◆ SPL_FILE_DIR_KEY_MODE_MASK

#define SPL_FILE_DIR_KEY_MODE_MASK   0x00000F00 /* mask RecursiveDirectoryTree::key() */

Definition at line 105 of file spl_directory.h.

◆ SPL_FILE_DIR_OTHERS_MASK

#define SPL_FILE_DIR_OTHERS_MASK   0x00007000 /* mask used for get/setFlags */

Definition at line 112 of file spl_directory.h.

◆ SPL_FILE_DIR_SKIPDOTS

#define SPL_FILE_DIR_SKIPDOTS   0x00001000 /* Tells whether it should skip dots or not */

Definition at line 109 of file spl_directory.h.

◆ SPL_FILE_DIR_UNIXPATHS

#define SPL_FILE_DIR_UNIXPATHS   0x00002000 /* Whether to unixify path separators */

Definition at line 110 of file spl_directory.h.

◆ SPL_FILE_NEW_CURRENT_AND_KEY

#define SPL_FILE_NEW_CURRENT_AND_KEY   SPL_FILE_DIR_KEY_AS_FILENAME|SPL_FILE_DIR_CURRENT_AS_FILEINFO

Definition at line 106 of file spl_directory.h.

◆ SPL_FILE_OBJECT_DROP_NEW_LINE

#define SPL_FILE_OBJECT_DROP_NEW_LINE   0x00000001 /* drop new lines */

Definition at line 91 of file spl_directory.h.

◆ SPL_FILE_OBJECT_MASK

#define SPL_FILE_OBJECT_MASK   0x0000000F /* read via fgetcsv */

Definition at line 95 of file spl_directory.h.

◆ SPL_FILE_OBJECT_READ_AHEAD

#define SPL_FILE_OBJECT_READ_AHEAD   0x00000002 /* read on rewind/next */

Definition at line 92 of file spl_directory.h.

◆ SPL_FILE_OBJECT_READ_CSV

#define SPL_FILE_OBJECT_READ_CSV   0x00000008 /* read via fgetcsv */

Definition at line 94 of file spl_directory.h.

◆ SPL_FILE_OBJECT_SKIP_EMPTY

#define SPL_FILE_OBJECT_SKIP_EMPTY   0x00000004 /* skip empty lines */

Definition at line 93 of file spl_directory.h.

Typedef Documentation

◆ spl_filesystem_object

typedef struct _spl_filesystem_object spl_filesystem_object

Definition at line 33 of file spl_directory.h.

◆ spl_foreign_clone_t

typedef void(* spl_foreign_clone_t) (spl_filesystem_object *src, spl_filesystem_object *dst)

Definition at line 36 of file spl_directory.h.

◆ spl_foreign_dtor_t

typedef void(* spl_foreign_dtor_t) (spl_filesystem_object *object)

Definition at line 35 of file spl_directory.h.

◆ spl_other_handler

typedef struct _spl_other_handler spl_other_handler

Enumeration Type Documentation

◆ SPL_FS_OBJ_TYPE

enum SPL_FS_OBJ_TYPE
Enumerator
SPL_FS_INFO 
SPL_FS_DIR 
SPL_FS_FILE 

Definition at line 45 of file spl_directory.h.

Function Documentation

◆ PHP_MINIT_FUNCTION()

PHP_MINIT_FUNCTION ( spl_directory )

Definition at line 2756 of file spl_directory.c.

◆ spl_filesystem_object_get_path()

PHPAPI zend_string * spl_filesystem_object_get_path ( const spl_filesystem_object * intern)

Definition at line 212 of file spl_directory.c.

Variable Documentation

◆ spl_ce_DirectoryIterator

PHPAPI zend_class_entry* spl_ce_DirectoryIterator
extern

Definition at line 46 of file spl_directory.c.

◆ spl_ce_FilesystemIterator

PHPAPI zend_class_entry* spl_ce_FilesystemIterator
extern

Definition at line 47 of file spl_directory.c.

◆ spl_ce_GlobIterator

PHPAPI zend_class_entry* spl_ce_GlobIterator
extern

Definition at line 49 of file spl_directory.c.

◆ spl_ce_RecursiveDirectoryIterator

PHPAPI zend_class_entry* spl_ce_RecursiveDirectoryIterator
extern

Definition at line 48 of file spl_directory.c.

◆ spl_ce_SplFileInfo

PHPAPI zend_class_entry* spl_ce_SplFileInfo
extern

Definition at line 45 of file spl_directory.c.

◆ spl_ce_SplFileObject

PHPAPI zend_class_entry* spl_ce_SplFileObject
extern

Definition at line 50 of file spl_directory.c.

◆ spl_ce_SplTempFileObject

PHPAPI zend_class_entry* spl_ce_SplTempFileObject
extern

Definition at line 51 of file spl_directory.c.