Horde_Pear_Package_Xml_Element_File
in package
Handles a XML file node in the contents list.
Tags
Table of Contents
- $_file : DOMNode
- The file node.
- $_level : int
- The level in the tree.
- $_name : string
- The name of this file.
- $_parent : Horde_Pear_Package_Xml_Element_Directory
- The parent directory
- $_replace : array<string|int, mixed>
- The replacement tasks for this file.
- $_role : string
- The role of this file.
- $_xml : Horde_Pear_Package_Xml
- The package.xml handler to operate on.
- __construct() : mixed
- Constructor.
- delete() : null
- Remove the file entry from the XML.
- getFileNode() : DOMNode
- Get the DOM node of the file entry.
- insert() : null
- Insert the file entry into the XML at the given point.
- setFileNode() : null
- Set the DOM node of the file entry.
Properties
$_file
The file node.
private
DOMNode
$_file
$_level
The level in the tree.
private
int
$_level
$_name
The name of this file.
private
string
$_name
$_parent
The parent directory
private
Horde_Pear_Package_Xml_Element_Directory
$_parent
$_replace
The replacement tasks for this file.
private
array<string|int, mixed>
$_replace
$_role
The role of this file.
private
string
$_role
$_xml
The package.xml handler to operate on.
private
Horde_Pear_Package_Xml
$_xml
Methods
__construct()
Constructor.
public
__construct(string $name, Horde_Pear_Package_Xml_Element_Directory $parent[, string $role = null ][, array<string|int, mixed> $replace = array() ]) : mixed
Parameters
- $name : string
-
The name of the directory.
- $parent : Horde_Pear_Package_Xml_Element_Directory
-
The parent directory.
- $role : string = null
-
The file role.
- $replace : array<string|int, mixed> = array()
-
Replacement tasks.
Return values
mixed —delete()
Remove the file entry from the XML.
public
delete() : null
Return values
null —getFileNode()
Get the DOM node of the file entry.
public
getFileNode() : DOMNode
Return values
DOMNode —The file node.
insert()
Insert the file entry into the XML at the given point.
public
insert([DOMNode $point = null ]) : null
Parameters
- $point : DOMNode = null
-
Insertion point.
Return values
null —setFileNode()
Set the DOM node of the file entry.
public
setFileNode(DOMNode $file) : null
Parameters
- $file : DOMNode