Class: File

Source Location: Program_Root/File/File.php

Class Overview

File is a simple class to keep basic file information gathering structured and readable. Stores everything as a property of the class instead of as methods, so that it integrates easily with the Template class.

Author(s)

John Luxford <mailto:lux@simian.ca>

Version

2.2, 2003-09-29, $Id: File.php,v 1.2 2005/07/06 15:30:56 lux Exp $

Copyright

Variables

Methods

Inherited Variables

Inherited Methods

Class Details

[line 78]
File is a simple class to keep basic file information gathering structured and readable. Stores everything as a property of the class instead of as methods, so that it integrates easily with the Template class.

New in 1.2:

Added $filemtime, $gid, $uid, $perms, $filesize, $formatted_perms, $group, and $owner properties, and a formatPerms() method.

New in 1.4:

Added setStatus(), getStatus(), and clearStatus() methods.

New in 1.6:

Added a $content property and a contents() method.

New in 1.8:

Happy St. Valentine's day!
Had a fling with a Windows bug today. :)

New in 2.0:

Removed getStatus(), setStatus(), and clearStatus(). The status functionality is now part of saf.App.Versioning.Rev.

New in 2.2:

Added overwrite() and append() methods, and functions file_overwrite() and file_append() as aliases to them.


1     <?php
2     
3      $file = new File ('/absolute/path/to/file.txt', '/web/path');
4     
5      // check if the file is a directory
6      if ($file->is_dir) {
7          // file is a directory
8      }
9     
10     // output the file's name, size and date it was last modified
11     echo $file->name;
12     echo $file->size;
13     echo $file->last_modified;
14    
15     ? >

Tags:

access:	public
version:	2.2, 2003-09-29, $Id: File.php,v 1.2 2005/07/06 15:30:56 lux Exp $
license:	http://www.sitellite.org/index/license
copyright:	Copyright (C) 2001-2003, Simian Systems Inc.
author:	John Luxford <mailto:lux@simian.ca>

[ Top ]

Class Variables

$absolute = ""

[line 134]

The absolute path to the file, including its name.

Tags:

access:

public

Type:

mixed

[ Top ]

Class Methods

constructor File [line 254]

File File(
[string
$abs_file_path = ''], [string
$www_file_path = ''])

Constructor method. $abs_file_path is the absolute directory path to the file, including its name. $www_file_path is the path from the web document root to same, minus the file name.

Tags:

access:

public

Parameters:

string	$abs_file_path
string	$www_file_path

[ Top ]

method append [line 558]

boolean append(
string
$data, [string
$file = ''])

Append to the specified file (or the file contained in the $absolute property) with the specified $data.

Tags:

access:

public

Parameters:

string	$data
string	$file

[ Top ]

method contains [line 383]

boolean contains(
string
$string, [boolean
$regex = 0], [string
$file = ''], [boolean
$count = false], [string
$filter = false])

Opens a file and returns whether or not it contains a specified string or pattern. Can be called using the File::contains syntax, as well as through an instantiated object.

Tags:

access:

public

Parameters:

string	$string
boolean	$regex
string	$file
boolean	$count
string	$filter

[ Top ]

method contents [line 357]

string contents(
[string
$file = ''])

Returns the contents of the file as a string. If the $file is not specified, it uses the $absolute property of the current File object. Also stores it in the $content property so you don't have to read it from the file system twice.

method determine [line 621]

string determine(
array
$list, [string
$path = false])

Selects the first file that exists from the specified list.

This can be used to cascade possible choices for displaying images, including templates, or other context-sensitive data.

Tags:

access:

public

Parameters:

array	$list
string	$path

[ Top ]

method formatPerms [line 472]

string formatPerms(
integer
$mode)

Reads an octal mode value and returns a string of the

format -rwxrwxrwx, similar to what is returned by an "ls -al" command on a Unix command prompt. This method was borrowed from the user-contributed notes at http://www.php.net/fileperms

method format_filesize [line 304]

string format_filesize(
[integer
$size = 0])

Formats the size of the file into a string appropriate for human consumption.

method overwrite [line 531]

boolean overwrite(
string
$data, [string
$file = ''])

Overwrite the specified file (or the file contained in the $absolute property) with the specified $data.

Tags:

access:

public

Parameters:

string	$data
string	$file

[ Top ]

method rand [line 586]

string rand(
string
$path, [mixed
$ext = false])

Select a random file from the specified directory. The $ext is an optional extension, or array of extensions, to limit the selection to. Also automatically eliminates dot-files and folders.

Tags:

access:

public

Parameters:

string	$path
mixed	$ext

[ Top ]

Packages

Classes

Files

Class: File

Class Overview

Author(s)

Version

Copyright

Variables

Methods

Inherited Variables

Inherited Methods

Class Details

Tags:

Class Variables

$absolute = ""

Tags:

$content = false

Tags:

$description = "Unknown Document Type"

Tags:

$extension = ""

Tags:

$filemtime =

Tags:

$filesize =

Tags:

$formatted_perms =

Tags:

$gid =

Tags:

$group = ''

Tags:

$icon = "pix/icons/unknown.gif"

Tags:

$is_dir = false

Tags:

$is_writeable = false

Tags:

$last_modified = ""

Tags:

$name = ""

Tags:

$owner = ''

Tags:

$path = ""

Tags:

$perms =

Tags:

$size = ""

Tags:

$type = "ascii"

Tags:

$uid =

Tags:

Class Methods

constructor File [line 254]

Tags:

Parameters:

method append [line 558]

Tags:

Parameters:

method contains [line 383]

Tags:

Parameters:

method contents [line 357]

Tags:

Parameters:

method determine [line 621]

Tags:

Parameters:

method formatPerms [line 472]

Tags:

Parameters:

method format_filesize [line 304]

Tags:

Parameters:

method overwrite [line 531]

Tags:

Parameters: