Class: PHPFile

Source Location: /filesystem/PHPFile.class.php

Class Overview

Files
   |
   --PHPFile

A class to create php-files who using this class-library.

Author(s):

Daniel Plücken <daniel@debakel.net>

Version:

0.1.3

Copyright:

Copyright (c) 2003 Daniel Plücken <daniel@debakel.net>
This library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 2.1 of the License.
This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public License along with this library; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA

Variables

Methods

Inherited Variables

Class: Files

Files::$content
Files::$filename
Files::$filesize
Files::$parentfolder
Files::$path
Files::$tmp_fh

Inherited Methods

Class: Files

Files::Files(): Constructor
Files::deleteTmp(): Deletes the temporary file of this object.
Files::equals(): Compares the given Files object with this one. If both equal each other it will be returned true, otherwise false. The two file objects will be accounted as equal, if the the filenames and pathes match each other.
Files::get(): Returns the content of this file object. This function is an alias for the function getContent().
Files::getContent(): Returns the content of this file object.
Files::getExtension(): Returns the file extension of the given filename.
Files::getFilesize(): Sets the content of this file object.
Files::getName(): Returns the filename of this file object.
Files::getPath(): Returns the path to the file of this file object.
Files::load(): Loads the content of this file object from the filesystem and sets the content to this object.
Files::save(): Saves the file of this object.
Files::saveAs(): Saves the file of this object with given name.
Files::saveTmp(): Saves the file of this object in a temporary file.
Files::setContent(): Sets the content of this file object.
Files::setFilesize(): Sets the content of this file object.
Files::setParentFolder(): Sets the parent folder of this file object that there is a back reference up to the root of the filesystem tree,

Class Details

[line 47]
A class to create php-files who using this class-library.

Tags:

author:	Daniel Plücken <daniel@debakel.net>
version:	0.1.3
copyright:	Copyright (c) 2003 Daniel Plücken <daniel@debakel.net> This library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 2.1 of the License. This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details. You should have received a copy of the GNU Lesser General Public License along with this library; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
license:	GNU Lesser General Public License

[ Top ]

Class Variables

$htmldoc =

[line 63]

Tags:

access:

public

Type:

HTMLDocument

[ Top ]

$includes = array( "html/HTMLDocument.inc.php" )

[line 58]

Tags:

access:

public

Type:

array

[ Top ]

$pathtoclasses =

[line 53]

Tags:

access:

public

Type:

string

[ Top ]

Class Methods

constructor PHPFile [line 80]

PHPFile PHPFile(
string
$path_and_filename, string
$path, string
$filename)

Constructor

Tags:

author:	Daniel Plücken <daniel@debakel.net>
version:	1.0
since:	0.1.0
access:	public

Parameters:

string	$path_and_filename
string	$path
string	$filename

[ Top ]

method addInclude [line 134]

void addInclude(
string
$string)

Adds a sourcepath to the array "includes" of this object.

Tags:

author:	Daniel Plücken <daniel@debakel.net>
version:	1.0
since:	0.1.0
access:	public

Parameters:

string

$string

The path to a script in the class-library.

[ Top ]

method addItem [line 162]

string addItem(

&$item_ref, HTMLDocument
$item_ref)

Adds items to the object that is referenced in the object's variable "htmldoc".

Tags:

author:	Daniel Plücken <daniel@debakel.net>
version:	1.0
since:	0.1.0
access:	public

Parameters:

HTMLDocument	$item_ref
	&$item_ref

[ Top ]

method get [line 177]

string get(
)

Returns the source of the generated php-file.

Tags:

author:	Daniel Plücken <daniel@debakel.net>
version:	1.0
since:	0.1.0
access:	public

Overrides Files::get() (Returns the content of this file object. This function is an alias for the function getContent().)

[ Top ]

method setDocument [line 119]

void setDocument(

&$doc_ref, HTMLDocument
$doc_ref)

Sets htmldoc, the variable of this object, that should contain the object's reference of the html-document whose sourcecode will be written if this object will be printed.

Tags:

author:	Daniel Plücken <daniel@debakel.net>
version:	1.0
since:	0.1.0
access:	public

Parameters:

HTMLDocument	$doc_ref	The path to the class-library relativly from the location of this file.
	&$doc_ref

[ Top ]

method setPathToClasses [line 101]

void setPathToClasses(
string
$string)

Sets pathtoclasses, the variable of this object, that should contain the path to the class library relatively from the location of this file.

Tags:

author:	Daniel Plücken <daniel@debakel.net>
version:	1.0
since:	0.1.0
access:	public

Parameters:

string

$string

the path to the class-library relativly from the location of this file.

[ Top ]

Documentation generated on Thu, 05 Jun 2008 19:14:43 +0200 by phpDocumentor 1.4.1