Ibuildings - Docs For Class atkTmpFile

Docs For Class atkTmpFile

Home

Documentation home

Atk index

Docs For Class atkTmpFile [ package: atk ]

Class: atkTmpFile

Source Location: /utils/class.atktmpfile.inc

Class atkTmpFile

Class Overview

Temporary file handler.

This class can be used to create, read and remove temporary files. The files are stored in ATK's temporary directory. An ideal application of this class is writing small php include files with cached data.

Note: superseded for caching by atkCache.

Located in /utils/class.atktmpfile.inc [line 33]

Wiki documentation

Author(s):

Ivo Jansch <ivo@achievo.org>

Information Tags:

Properties

Methods

[ Top ]

Property Summary

string	$m_basedir	base directory. This allows
string	$m_filename	Filename as given to constructor.
resource	$m_fp	Internal file pointer.
string	$m_mode	Mode the file is opened in.

[ Top ]

Method Summary

atkTmpFile	atkTmpFile()	Create a new temporary file handler.
bool	appendToFile()	Append data to a file.
bool	close()	Close the current (open) file
atkTmpFile	create()	Create a new temporary file handler.
bool	createDirectoryStructure()	Recursively creates the directory structure for this file.
bool	exists()	Wether or not the file exists.
int	fileAge()	Returns the file age in seconds
int	filecTime()	Returns the time the file was last changed, or FALSE in case of an error.
bool	fpassthru()	Send the file contents directly to the browser.
void	getBasedir()	Get the base directory for writing
string	getPath()	Get the complete path of the file
bool	open()	Open the file with a specific mode (see PHPs fopen).
mixed	read()	Returns the contents of the file in an array, split by newline (see PHPs 'file' function).
string	readFile()	Returns the contents of the file in a string.
bool	remove()	Removes a file.
bool	setBasedir()	Set the base directory for writing instead of the default atktmp dir
mixed	write()	Write data to the current (open) file.
bool	writeAsPhp()	Exports a PHP variable to a file, makes the file a PHP file.
bool	writeFile()	Write data to the file (creates the file if it does not exist and override any existing content).

[ Top ]

Properties

string $m_basedir [line 67]

base directory. This allows

you to set a different directory then the default atktmp dir for writing tmp files

API Tags:

Access:

protected

[ Top ]

string $m_filename [line 41]

Filename as given to constructor.

Don't use this! Public because of bwc.

API Tags:

Access:

public

[ Top ]

resource $m_fp [line 49]

Internal file pointer.

Don't use this! Public because of bwc.

API Tags:

Access:

public

[ Top ]

string $m_mode [line 57]

Mode the file is opened in.

Don't use this! Public because of bwc.

API Tags:

Access:

public

[ Top ]

Methods

Constructor atkTmpFile [line 75]

atkTmpFile atkTmpFile(
string
$filename 
)

Create a new temporary file handler.

Parameters:

string

$filename:

API Tags:

Access:

public

[ Top ]

appendToFile [line 192]

bool appendToFile(
string
$data 
)

Append data to a file.

Parameters:

string

$data:

Data to append

API Tags:

Return:	Wether appending succeeded
Access:	public

[ Top ]

close [line 344]

bool close(
)

Close the current (open) file

API Tags:

Return:	Wether we could close the file
Access:	public

[ Top ]

create [line 89]

atkTmpFile create(
string
$filename, [
$baseDirectory = null], string
$base 
)

Create a new temporary file handler.

Factory method, allowing a shorter syntax.

Parameters:

string	$filename:
string	$base:	directory for writing (default atktempdir)
	$baseDirectory:

API Tags:

Access:

public

[ Top ]

createDirectoryStructure [line 363]

bool createDirectoryStructure(
)

Recursively creates the directory structure for this file.

API Tags:

Return:	Wether we succeeded
Access:	public

[ Top ]

exists [line 221]

bool exists(
)

Wether or not the file exists.

API Tags:

Return:	Exists?
Access:	public

[ Top ]

fileAge [line 243]

int fileAge(
)

Returns the file age in seconds

API Tags:

Return:	Seconds of file age.
Access:	public

[ Top ]

filecTime [line 232]

int filecTime(
)

Returns the time the file was last changed, or FALSE in case of an error.

The time is returned as a Unix timestamp.

API Tags:

Return:	Timestamp last changed
Access:	public

[ Top ]

fpassthru [line 142]

bool fpassthru(
)

Send the file contents directly to the browser.

API Tags:

Return:	Wether the action succeeded
Access:	public

[ Top ]

getBasedir [line 289]

void getBasedir(
)

Get the base directory for writing

Will default to the atktmp dir

API Tags:

Access:

public

[ Top ]

getPath [line 258]

string getPath(
)

Get the complete path of the file

Example:

$file->getPath(); => ./atktmp/tempdir/tempfile.inc

API Tags:

Return:	Path for the file
Access:	public

[ Top ]

open [line 308]

bool open(
string
$mode 
)

Open the file with a specific mode (see PHPs fopen).

Close it first if it's already open with a different mode. And create the directory structure if we are writing to the file.

Parameters:

string

$mode:

Mode to open the file with

API Tags:

Return:	Wether opening succeeded
Access:	public

[ Top ]

read [line 109]

mixed read(
)

Returns the contents of the file in an array, split by newline (see PHPs 'file' function).

Returns false if the file does not exist.

API Tags:

Access:

public

[ Top ]

readFile [line 124]

string readFile(
)

Returns the contents of the file in a string.

Returns false if the file does not exist.

API Tags:

Access:

public

[ Top ]

remove [line 208]

bool remove(
)

Removes a file.

API Tags:

Return:	Wether removing succeeded
Access:	public

[ Top ]

setBasedir [line 270]

bool setBasedir(
string
$dir 
)

Set the base directory for writing instead of the default atktmp dir

Parameters:

string

$dir:

base directory

API Tags:

Access:

public

[ Top ]

write [line 334]

mixed write(
string
$data 
)

Write data to the current (open) file.

Parameters:

string

$data:

Data to write to the file

API Tags:

Return:	Number of bytes written or false for error
Access:	public

[ Top ]

writeAsPhp [line 177]

bool writeAsPhp(
string
$varname, string
$data 
)

Exports a PHP variable to a file, makes the file a PHP file.

Parameters:

string	$varname:	Name of the variable
string	$data:	Variable data

API Tags:

Return:	Wether the action succeeded
Access:	public

[ Top ]

writeFile [line 159]

bool writeFile(
string
$data 
)

Write data to the file (creates the file if it does not exist and override any existing content).

Parameters:

string

$data:

Data to write to the file

API Tags:

Return:	Wether writing succeeded
Access:	public

[ Top ]