FileModule (Resin 4.0.s170329)

java.lang.Object
- com.caucho.quercus.module.AbstractQuercusModule
- - com.caucho.quercus.lib.file.FileModule

All Implemented Interfaces:

QuercusModule
```
public class FileModule
extends AbstractQuercusModule
```
Information and actions for about files

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`DIRECTORY_SEPARATOR`
`static int`	`FILE_APPEND`
`static int`	`FILE_IGNORE_NEW_LINES`
`static int`	`FILE_SKIP_EMPTY_LINES`
`static int`	`FILE_USE_INCLUDE_PATH`
`static int`	`FNM_CASEFOLD`
`static int`	`FNM_NOESCAPE`
`static int`	`FNM_PATHNAME`
`static int`	`FNM_PERIOD`
`static int`	`GLOB_BRACE`
`static int`	`GLOB_ERR`
`static int`	`GLOB_MARK`
`static int`	`GLOB_NOCHECK`
`static int`	`GLOB_NOESCAPE`
`static int`	`GLOB_NOSORT`
`static int`	`GLOB_ONLYDIR`
`static int`	`LOCK_EX`
`static int`	`LOCK_NB`
`static int`	`LOCK_SH`
`static int`	`LOCK_UN`
`static java.lang.String`	`PATH_SEPARATOR`
`static int`	`PATHINFO_BASENAME`
`static int`	`PATHINFO_DIRNAME`
`static int`	`PATHINFO_EXTENSION`
`static int`	`PATHINFO_FILENAME`
`static int`	`SEEK_CUR`
`static int`	`SEEK_END`
`static int`	`SEEK_SET`
`static int`	`UPLOAD_ERR_CANT_WRITE`
`static int`	`UPLOAD_ERR_EXTENSION`
`static int`	`UPLOAD_ERR_FORM_SIZE`
`static int`	`UPLOAD_ERR_INI_SIZE`
`static int`	`UPLOAD_ERR_NO_FILE`
`static int`	`UPLOAD_ERR_NO_TMP_DIR`
`static int`	`UPLOAD_ERR_OK`
`static int`	`UPLOAD_ERR_PARTIAL`

Fields inherited from class com.caucho.quercus.module.AbstractQuercusModule
PHP_INI_ALL, PHP_INI_PERDIR, PHP_INI_SYSTEM, PHP_INI_USER

Constructor Summary

Constructors
Constructor and Description

FileModule()

Constructors
Constructor and Description
`FileModule()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static Value`	`basename(StringValue path, StringValue suffix)` Returns the base name of a string.
`static boolean`	`chdir(Env env, Path path)` Changes the working directory
`static boolean`	`chgrp(Env env, Path file, Value group)` Changes the group of the file.
`static boolean`	`chmod(Env env, Path file, int mode)` Changes the permissions of the file.
`static boolean`	`chown(Env env, Path file, Value user)` Changes the ownership of the file.
`static boolean`	`chroot(Env env, Path path)` Changes the working directory, forming a virtual root
`static void`	`clearstatcache(Env env, boolean clearRealPathCache, java.lang.String fileName)` Clears the stat cache for the file
`static Value`	`closedir(Env env, Directory dir)` Closes the directory
`static boolean`	`copy(Env env, StringValue src, StringValue dst)` Copies a file to the destination.
`static Value`	`dir(Env env, StringValue filename)` Opens a directory
`StringValue`	`dirname(Env env, StringValue path)` Returns the directory name of a string.
`static Value`	`disk_free_space(Env env, Path directory)` Returns the free space for disk partition containing the directory
`static Value`	`disk_total_space(Env env, Path directory)` Returns the total space for disk partition containing the directory
`static Value`	`diskfreespace(Env env, Path directory)` Returns the total space for disk partition containing the directory
`static boolean`	`fclose(Env env, BinaryStream s)` Closes a file.
`static boolean`	`feof(Env env, BinaryStream binaryStream)` Checks for the end of file.
`static boolean`	`fflush(Env env, BinaryOutput os)` Flushes a file.
`static Value`	`fgetc(Env env, BinaryInput is)` Returns the next character as a byte
`Value`	`fgetcsv(Env env, BinaryInput is, int length, java.lang.String delimiter, java.lang.String enclosure)` Parses a comma-separated-value line from a file.
`static Value`	`fgets(Env env, BinaryInput is, int length)` Returns the next line
`static Value`	`fgetss(Env env, BinaryInput is, int length, Value allowedTags)` Returns the next line stripping tags
`static boolean`	`file_exists(Env env, StringValue filename)` Returns true if file exists
`static StringValue`	`file_get_contents(Env env, StringValue filename, boolean useIncludePath, Value context, long offset, long maxLen)` Parses the file, returning it as a string array.
`static Value`	`file_put_contents(Env env, StringValue filename, Value data, int flags, Value context)` Writes data to a file.
`static Value`	`file(Env env, StringValue filename, int flags, Value context)` Parses the file, returning it in an array.
`static Value`	`fileatime(Env env, StringValue filename)` Returns the file access time
`static Value`	`filectime(Env env, StringValue filename)` Returns the file create time
`static Value`	`filegroup(Env env, Path path)` Returns the file's group
`static Value`	`fileinode(Env env, Path path)` Returns the file's inocde
`static Value`	`filemtime(Env env, StringValue filename)` Returns the file modified time
`static Value`	`fileowner(Env env, StringValue filename)` Returns the file's owner
`static Value`	`fileperms(Env env, Path path)` Returns the file's permissions
`static Value`	`filesize(Env env, StringValue filename)` Returns the file's size
`static Value`	`filetype(Env env, Path path)` Returns the file's type
`static boolean`	`flock(Env env, LockableStream fileV, int operation, Value wouldBlock)` Advisory locking
`static boolean`	`fnmatch(Env env, java.lang.String pattern, java.lang.String string, int flags)` Returns true if the given string matches the given glob pattern.
`static BinaryStream`	`fopen(Env env, StringValue filename, java.lang.String mode, boolean useIncludePath, Value contextV)` Opens a file.
`Value`	`fpassthru(Env env, BinaryInput is)` Output the filepointer data to the output stream.
`Value`	`fputcsv(Env env, BinaryOutput os, ArrayValue value, StringValue delimiter, StringValue enclosure)` Parses a comma-separated-value line from a file.
`static Value`	`fputs(Env env, BinaryOutput os, java.io.InputStream value, int length)` Writes a string to the file.
`static Value`	`fread(Env env, BinaryInput is, int length)` Reads content from a file.
`static Value`	`fscanf(Env env, BinaryInput is, StringValue format, Value[] args)` Reads and parses a line.
`static Value`	`fseek(Env env, BinaryStream binaryStream, long offset, int whence)` Sets the current position.
`static Value`	`fstat(Env env, BinaryStream stream)` Returns the status of the given file pointer.
`static Value`	`ftell(Env env, BinaryStream binaryStream)` Returns the current position.
`static boolean`	`ftruncate(Env env, BinaryOutput handle, long size)` Truncates a file.
`static Value`	`fwrite(Env env, BinaryOutput os, java.io.InputStream value, int length)` Writes a string to the file.
`java.util.Map<StringValue,Value>`	`getConstMap()` Returns the constants defined by this module.
`static java.lang.String`	`getcwd(Env env)` Returns the current working directory.
`IniDefinitions`	`getIniDefinitions()` Returns the default quercus.ini values.
`static Value`	`glob(Env env, java.lang.String pattern, int flags)` Matches all files with the given pattern.
`static boolean`	`is_dir(Env env, StringValue filename)` Returns true if the path is a directory.
`static boolean`	`is_executable(Env env, Path path)` Returns true if the path is an executable file
`static boolean`	`is_file(Path path)` Returns true if the path is a file.
`static boolean`	`is_link(Env env, Path path)` Returns true if the path is a symbolic link
`static boolean`	`is_readable(Path path)` Returns true if the path is readable
`static boolean`	`is_uploaded_file(Env env, Path path)` Returns true for an uploaded file.
`static boolean`	`is_writable(Env env, StringValue filename)` Returns true if the path is writable
`static boolean`	`is_writeable(Env env, StringValue filename)` Returns true if the path is writable
`boolean`	`link(Env env, Path source, Path destination)` Creates a hard link
`static long`	`linkinfo(Env env, Path path)`
`static Value`	`lstat(Env env, StringValue filename)` Returns file statistics
`static boolean`	`mkdir(Env env, StringValue dirname, int mode, boolean recursive, Value context)` Makes the directory
`static boolean`	`move_uploaded_file(Env env, Path src, StringValue dst)` Moves the uploaded file.
`static Value`	`opendir(Env env, StringValue pathName, Value context)` Opens a directory
`static BinaryStream`	`openForAppend(Env env, StringValue filename, boolean isUseIncludePath)`
`static Value`	`parse_ini_file(Env env, Path path, boolean processSections)` Parses the ini file.
`static Value`	`pathinfo(Env env, java.lang.String path, Value optionsV)` Parses the path, splitting it into parts.
`static int`	`pclose(Env env, BinaryStream stream)`
`static BinaryStream`	`popen(Env env, java.lang.String command, StringValue mode)`
`static Value`	`readdir(Env env, Directory dir)` Reads the next entry
`Value`	`readfile(Env env, StringValue filename, boolean useIncludePath, Value context)` Read the contents of a file and write them out.
`static Value`	`readlink(Env env, Path path)` The readlink
`static Value`	`realpath(Env env, Path path)` Returns the actual path name.
`static boolean`	`rename(Env env, StringValue from, StringValue to)` Renames a file
`static Value`	`rewind(Env env, BinaryStream binaryStream)` Rewinds the stream.
`static void`	`rewinddir(Env env, Directory dir)` Rewinds the directory listing
`static boolean`	`rmdir(Env env, StringValue filename, Value context)` remove a directory
`static Value`	`scandir(Env env, StringValue fileName, int order, Value context)` Scan the directory
`static int`	`set_file_buffer(Env env, BinaryOutput stream, int bufferSize)` Sets the write buffer.
`static Value`	`stat(Env env, StringValue filename)` Returns file statistics
`boolean`	`symlink(Env env, Path source, Path destination)` Creates a symlink
`static java.lang.String`	`tempnam(Env env, Path dir, java.lang.String prefix)` Creates a temporary file.
`static FileInputOutput`	`tmpfile(Env env)` Creates a temporary file.
`static boolean`	`touch(Env env, StringValue filename, int time, int atime)` sets the time to the current time
`static int`	`umask(Env env, int maskV)` umask call
`static boolean`	`unlink(Env env, StringValue filename, Value context)` remove call

Methods inherited from class com.caucho.quercus.module.AbstractQuercusModule
addConstant, addConstant, addConstant, getLoadedExtensions

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail
- DIRECTORY_SEPARATOR
```
public static final java.lang.String DIRECTORY_SEPARATOR
```
- PATH_SEPARATOR
```
public static final java.lang.String PATH_SEPARATOR
```
- UPLOAD_ERR_OK
```
public static final int UPLOAD_ERR_OK
```
  See Also:
  
  Constant Field Values
- UPLOAD_ERR_INI_SIZE
```
public static final int UPLOAD_ERR_INI_SIZE
```
  See Also:
  
  Constant Field Values
- UPLOAD_ERR_FORM_SIZE
```
public static final int UPLOAD_ERR_FORM_SIZE
```
  See Also:
  
  Constant Field Values
- UPLOAD_ERR_PARTIAL
```
public static final int UPLOAD_ERR_PARTIAL
```
  See Also:
  
  Constant Field Values
- UPLOAD_ERR_NO_FILE
```
public static final int UPLOAD_ERR_NO_FILE
```
  See Also:
  
  Constant Field Values
- UPLOAD_ERR_NO_TMP_DIR
```
public static final int UPLOAD_ERR_NO_TMP_DIR
```
  See Also:
  
  Constant Field Values
- UPLOAD_ERR_CANT_WRITE
```
public static final int UPLOAD_ERR_CANT_WRITE
```
  See Also:
  
  Constant Field Values
- UPLOAD_ERR_EXTENSION
```
public static final int UPLOAD_ERR_EXTENSION
```
  See Also:
  
  Constant Field Values
- FILE_USE_INCLUDE_PATH
```
public static final int FILE_USE_INCLUDE_PATH
```
  See Also:
  
  Constant Field Values
- FILE_IGNORE_NEW_LINES
```
public static final int FILE_IGNORE_NEW_LINES
```
  See Also:
  
  Constant Field Values
- FILE_SKIP_EMPTY_LINES
```
public static final int FILE_SKIP_EMPTY_LINES
```
  See Also:
  
  Constant Field Values
- FILE_APPEND
```
public static final int FILE_APPEND
```
  See Also:
  
  Constant Field Values
- LOCK_SH
```
public static final int LOCK_SH
```
  See Also:
  
  Constant Field Values
- LOCK_EX
```
public static final int LOCK_EX
```
  See Also:
  
  Constant Field Values
- LOCK_UN
```
public static final int LOCK_UN
```
  See Also:
  
  Constant Field Values
- LOCK_NB
```
public static final int LOCK_NB
```
  See Also:
  
  Constant Field Values
- FNM_PATHNAME
```
public static final int FNM_PATHNAME
```
  See Also:
  
  Constant Field Values
- FNM_NOESCAPE
```
public static final int FNM_NOESCAPE
```
  See Also:
  
  Constant Field Values
- FNM_PERIOD
```
public static final int FNM_PERIOD
```
  See Also:
  
  Constant Field Values
- FNM_CASEFOLD
```
public static final int FNM_CASEFOLD
```
  See Also:
  
  Constant Field Values
- GLOB_MARK
```
public static final int GLOB_MARK
```
  See Also:
  
  Constant Field Values
- GLOB_NOSORT
```
public static final int GLOB_NOSORT
```
  See Also:
  
  Constant Field Values
- GLOB_NOCHECK
```
public static final int GLOB_NOCHECK
```
  See Also:
  
  Constant Field Values
- GLOB_NOESCAPE
```
public static final int GLOB_NOESCAPE
```
  See Also:
  
  Constant Field Values
- GLOB_BRACE
```
public static final int GLOB_BRACE
```
  See Also:
  
  Constant Field Values
- GLOB_ONLYDIR
```
public static final int GLOB_ONLYDIR
```
  See Also:
  
  Constant Field Values
- GLOB_ERR
```
public static final int GLOB_ERR
```
  See Also:
  
  Constant Field Values
- PATHINFO_DIRNAME
```
public static final int PATHINFO_DIRNAME
```
  See Also:
  
  Constant Field Values
- PATHINFO_BASENAME
```
public static final int PATHINFO_BASENAME
```
  See Also:
  
  Constant Field Values
- PATHINFO_EXTENSION
```
public static final int PATHINFO_EXTENSION
```
  See Also:
  
  Constant Field Values
- PATHINFO_FILENAME
```
public static final int PATHINFO_FILENAME
```
  See Also:
  
  Constant Field Values
- SEEK_SET
```
public static final int SEEK_SET
```
  See Also:
  
  Constant Field Values
- SEEK_CUR
```
public static final int SEEK_CUR
```
  See Also:
  
  Constant Field Values
- SEEK_END
```
public static final int SEEK_END
```
  See Also:
  
  Constant Field Values

Constructor Detail
- FileModule
```
public FileModule()
```

Method Detail

getIniDefinitions
```
public IniDefinitions getIniDefinitions()
```
Returns the default quercus.ini values.

Specified by:

getIniDefinitions in interface QuercusModule

Overrides:

getIniDefinitions in class AbstractQuercusModule

getConstMap
```
public java.util.Map<StringValue,Value> getConstMap()
```
Returns the constants defined by this module.

Specified by:

getConstMap in interface QuercusModule

Overrides:

getConstMap in class AbstractQuercusModule

basename

public static Value basename(StringValue path,
                             StringValue suffix)

Returns the base name of a string.

chdir

public static boolean chdir(Env env,
                            Path path)

Changes the working directory

Parameters:: path - the path to change to

chroot

public static boolean chroot(Env env,
                             Path path)

Changes the working directory, forming a virtual root

Parameters:: path - the path to change to

chgrp

public static boolean chgrp(Env env,
                            Path file,
                            Value group)

Changes the group of the file.

Parameters:: env - the PHP executing environment; file - the file to change the group of; group - the group id to change to

chmod
```
public static boolean chmod(Env env,
                            Path file,
                            int mode)
```
Changes the permissions of the file.

Parameters:

env - the PHP executing environment

file - the file to change the group of

mode - the mode id to change to

chown

public static boolean chown(Env env,
                            Path file,
                            Value user)

Changes the ownership of the file.

Parameters:: env - the PHP executing environment; file - the file to change the group of; user - the user id to change to

clearstatcache

public static void clearstatcache(Env env,
                                  boolean clearRealPathCache,
                                  java.lang.String fileName)

Clears the stat cache for the file

Parameters:: env - the PHP executing environment

copy

public static boolean copy(Env env,
                           StringValue src,
                           StringValue dst)

Copies a file to the destination.

Parameters:: src - the source path; dst - the destination path

dir

public static Value dir(Env env,
                        StringValue filename)

Opens a directory

Parameters:: path - the path to change to

dirname

public StringValue dirname(Env env,
                           StringValue path)

Returns the directory name of a string.

disk_free_space

public static Value disk_free_space(Env env,
                                    Path directory)

Returns the free space for disk partition containing the directory

Parameters:: directory - the disk directory

disk_total_space

public static Value disk_total_space(Env env,
                                     Path directory)

Returns the total space for disk partition containing the directory

Parameters:: directory - the disk directory

diskfreespace

public static Value diskfreespace(Env env,
                                  Path directory)

Returns the total space for disk partition containing the directory

Parameters:: directory - the disk directory

fclose

public static boolean fclose(Env env,
                             BinaryStream s)

Closes a file.

feof

public static boolean feof(Env env,
                           BinaryStream binaryStream)

Checks for the end of file.

fflush

public static boolean fflush(Env env,
                             BinaryOutput os)

Flushes a file.

fgetc

public static Value fgetc(Env env,
                          BinaryInput is)

Returns the next character as a byte

fgetcsv

public Value fgetcsv(Env env,
                     BinaryInput is,
                     int length,
                     java.lang.String delimiter,
                     java.lang.String enclosure)

Parses a comma-separated-value line from a file.

Parameters:: file - the file to read; length - the maximum line length; delimiter - optional comma replacement; enclosure - optional quote replacement

fgets

public static Value fgets(Env env,
                          BinaryInput is,
                          int length)

Returns the next line

fgetss

public static Value fgetss(Env env,
                           BinaryInput is,
                           int length,
                           Value allowedTags)

Returns the next line stripping tags

file

public static Value file(Env env,
                         StringValue filename,
                         int flags,
                         Value context)

Parses the file, returning it in an array. Binary-safe.

Parameters:: filename - the file's name; useIncludePath - if 1, use the include path; context - the resource context

fileatime

public static Value fileatime(Env env,
                              StringValue filename)

Returns the file access time

Parameters:: path - the path to check

filectime

public static Value filectime(Env env,
                              StringValue filename)

Returns the file create time

Parameters:: path - the path to check

filegroup

public static Value filegroup(Env env,
                              Path path)

Returns the file's group

Parameters:: path - the path to check

fileinode

public static Value fileinode(Env env,
                              Path path)

Returns the file's inocde

Parameters:: path - the path to check

filemtime

public static Value filemtime(Env env,
                              StringValue filename)

Returns the file modified time

Parameters:: path - the path to check

fileowner

public static Value fileowner(Env env,
                              StringValue filename)

Returns the file's owner

Parameters:: path - the path to check

fileperms

public static Value fileperms(Env env,
                              Path path)

Returns the file's permissions

Parameters:: path - the path to check

filesize

public static Value filesize(Env env,
                             StringValue filename)

Returns the file's size

Parameters:: path - the path to check

filetype

public static Value filetype(Env env,
                             Path path)

Returns the file's type

Parameters:: path - the path to check

file_exists

public static boolean file_exists(Env env,
                                  StringValue filename)

Returns true if file exists

Parameters:: path - the path to check

file_get_contents

public static StringValue file_get_contents(Env env,
                                            StringValue filename,
                                            boolean useIncludePath,
                                            Value context,
                                            long offset,
                                            long maxLen)

Parses the file, returning it as a string array.

Parameters:: filename - the file's name; useIncludePath - if true, use the include path; context - the resource context

file_put_contents

public static Value file_put_contents(Env env,
                                      StringValue filename,
                                      Value data,
                                      int flags,
                                      Value context)

Writes data to a file.

flock

public static boolean flock(Env env,
                            LockableStream fileV,
                            int operation,
                            Value wouldBlock)

Advisory locking

Parameters:: fileV - the file handle; operation - the locking operation; wouldBlock - the resource context

fnmatch

public static boolean fnmatch(Env env,
                              java.lang.String pattern,
                              java.lang.String string,
                              int flags)

Returns true if the given string matches the given glob pattern.

fopen

public static BinaryStream fopen(Env env,
                                 StringValue filename,
                                 java.lang.String mode,
                                 boolean useIncludePath,
                                 Value contextV)

Opens a file.

Parameters:: filename - the path to the file to open; mode - the mode the file should be opened as.; useIncludePath - if true, search the current include path

openForAppend

public static BinaryStream openForAppend(Env env,
                                         StringValue filename,
                                         boolean isUseIncludePath)
                                  throws java.io.IOException

Throws:: java.io.IOException

fpassthru

public Value fpassthru(Env env,
                       BinaryInput is)

Output the filepointer data to the output stream.

fputcsv

public Value fputcsv(Env env,
                     BinaryOutput os,
                     ArrayValue value,
                     StringValue delimiter,
                     StringValue enclosure)

Parses a comma-separated-value line from a file.

Parameters:: file - the file to read; delimiter - optional comma replacement; enclosure - optional quote replacement

fputs

public static Value fputs(Env env,
                          BinaryOutput os,
                          java.io.InputStream value,
                          int length)

Writes a string to the file.

fread

public static Value fread(Env env,
                          BinaryInput is,
                          int length)

Reads content from a file.

Parameters:: is - the file

fscanf

public static Value fscanf(Env env,
                           BinaryInput is,
                           StringValue format,
                           Value[] args)

Reads and parses a line.

fseek

public static Value fseek(Env env,
                          BinaryStream binaryStream,
                          long offset,
                          int whence)

Sets the current position.

Parameters:: is - the stream to test
Returns:: 0 on success, -1 on error.

fstat

public static Value fstat(Env env,
                          BinaryStream stream)

Returns the status of the given file pointer.

ftell

public static Value ftell(Env env,
                          BinaryStream binaryStream)

Returns the current position.

Parameters:: file - the stream to test
Returns:: position in file or FALSE on error.

ftruncate

public static boolean ftruncate(Env env,
                                BinaryOutput handle,
                                long size)

Truncates a file.

fwrite

public static Value fwrite(Env env,
                           BinaryOutput os,
                           java.io.InputStream value,
                           int length)

Writes a string to the file.

glob

public static Value glob(Env env,
                         java.lang.String pattern,
                         int flags)

Matches all files with the given pattern.

getcwd
```
public static java.lang.String getcwd(Env env)
```
Returns the current working directory.

Returns:

the current directory

is_dir

public static boolean is_dir(Env env,
                             StringValue filename)

Returns true if the path is a directory.

Parameters:: path - the path to check

is_executable

public static boolean is_executable(Env env,
                                    Path path)

Returns true if the path is an executable file

Parameters:: path - the path to check

is_file
```
public static boolean is_file(Path path)
```
Returns true if the path is a file.

Parameters:

path - the path to check

is_link

public static boolean is_link(Env env,
                              Path path)

Returns true if the path is a symbolic link

Parameters:: path - the path to check

is_readable
```
public static boolean is_readable(Path path)
```
Returns true if the path is readable

Parameters:

path - the path to check

is_uploaded_file

public static boolean is_uploaded_file(Env env,
                                       Path path)

Returns true for an uploaded file.

Parameters:: path - the temp name of the uploaded file

is_writable

public static boolean is_writable(Env env,
                                  StringValue filename)

Returns true if the path is writable

Parameters:: path - the path to check

is_writeable

public static boolean is_writeable(Env env,
                                   StringValue filename)

Returns true if the path is writable

Parameters:: path - the path to check

link

public boolean link(Env env,
                    Path source,
                    Path destination)

Creates a hard link

linkinfo

public static long linkinfo(Env env,
                            Path path)

lstat

public static Value lstat(Env env,
                          StringValue filename)

Returns file statistics

mkdir

public static boolean mkdir(Env env,
                            StringValue dirname,
                            int mode,
                            boolean recursive,
                            Value context)

Makes the directory

Parameters:: path - the directory to make

move_uploaded_file

public static boolean move_uploaded_file(Env env,
                                         Path src,
                                         StringValue dst)

Moves the uploaded file.

Parameters:: path - the temp name of the uploaded file; dst - the destination path

opendir

public static Value opendir(Env env,
                            StringValue pathName,
                            Value context)

Opens a directory

Parameters:: pathName - the directory to open

parse_ini_file

public static Value parse_ini_file(Env env,
                                   Path path,
                                   boolean processSections)

Parses the ini file.

pathinfo

public static Value pathinfo(Env env,
                             java.lang.String path,
                             Value optionsV)

Parses the path, splitting it into parts.

pclose

public static int pclose(Env env,
                         BinaryStream stream)

popen

public static BinaryStream popen(Env env,
                                 java.lang.String command,
                                 StringValue mode)

readdir

public static Value readdir(Env env,
                            Directory dir)

Reads the next entry

Parameters:: dirV - the directory resource

readfile

public Value readfile(Env env,
                      StringValue filename,
                      boolean useIncludePath,
                      Value context)

Read the contents of a file and write them out.

readlink

public static Value readlink(Env env,
                             Path path)

The readlink

realpath

public static Value realpath(Env env,
                             Path path)

Returns the actual path name.

rename

public static boolean rename(Env env,
                             StringValue from,
                             StringValue to)

Renames a file

Parameters:: fromPath - the path to change to; toPath - the path to change to

rewind

public static Value rewind(Env env,
                           BinaryStream binaryStream)

Rewinds the stream.

Parameters:: is - the file resource

rewinddir

public static void rewinddir(Env env,
                             Directory dir)

Rewinds the directory listing

Parameters:: dirV - the directory resource

rmdir

public static boolean rmdir(Env env,
                            StringValue filename,
                            Value context)

remove a directory

closedir

public static Value closedir(Env env,
                             Directory dir)

Closes the directory

Parameters:: dirV - the directory resource

scandir

public static Value scandir(Env env,
                            StringValue fileName,
                            int order,
                            Value context)

Scan the directory

Parameters:: fileName - the directory

set_file_buffer

public static int set_file_buffer(Env env,
                                  BinaryOutput stream,
                                  int bufferSize)

Sets the write buffer.

stat

public static Value stat(Env env,
                         StringValue filename)

Returns file statistics

symlink

public boolean symlink(Env env,
                       Path source,
                       Path destination)

Creates a symlink

tempnam

public static java.lang.String tempnam(Env env,
                                       Path dir,
                                       java.lang.String prefix)

Creates a temporary file.

tmpfile

public static FileInputOutput tmpfile(Env env)

Creates a temporary file.

touch

public static boolean touch(Env env,
                            StringValue filename,
                            int time,
                            int atime)

sets the time to the current time

umask

public static int umask(Env env,
                        int maskV)

umask call

unlink

public static boolean unlink(Env env,
                             StringValue filename,
                             Value context)

remove call

Class FileModule

Field Summary

Fields inherited from class com.caucho.quercus.module.AbstractQuercusModule

Constructor Summary

Method Summary

Methods inherited from class com.caucho.quercus.module.AbstractQuercusModule

Methods inherited from class java.lang.Object

Field Detail

DIRECTORY_SEPARATOR

PATH_SEPARATOR

UPLOAD_ERR_OK

UPLOAD_ERR_INI_SIZE

UPLOAD_ERR_FORM_SIZE

UPLOAD_ERR_PARTIAL

UPLOAD_ERR_NO_FILE

UPLOAD_ERR_NO_TMP_DIR

UPLOAD_ERR_CANT_WRITE

UPLOAD_ERR_EXTENSION

FILE_USE_INCLUDE_PATH

FILE_IGNORE_NEW_LINES

FILE_SKIP_EMPTY_LINES

FILE_APPEND

LOCK_SH

LOCK_EX

LOCK_UN

LOCK_NB

FNM_PATHNAME

FNM_NOESCAPE

FNM_PERIOD

FNM_CASEFOLD

GLOB_MARK

GLOB_NOSORT

GLOB_NOCHECK

GLOB_NOESCAPE

GLOB_BRACE

GLOB_ONLYDIR

GLOB_ERR

PATHINFO_DIRNAME

PATHINFO_BASENAME

PATHINFO_EXTENSION

PATHINFO_FILENAME

SEEK_SET

SEEK_CUR

SEEK_END

Constructor Detail

FileModule