Horde_Pear_Package_Xml_Contents
in package
Handles the XML contents list.
Tags
Table of Contents
- $_dir_list : Horde_Pear_Package_Xml_Directory
- The list of directories in the contents section.
- $_filelist : DOMNode
- The root of the file list section.
- $_install_list : array<string|int, mixed>
- The list of files in the "filelist" section.
- $_xml : Horde_Pear_Package_Xml
- The package.xml handler to operate on.
- __construct() : mixed
- Constructor.
- add() : null
- Add a file to the list.
- delete() : null
- Delete a file from the list.
- update() : null
- Update the file list.
- _getInstallInsertionPoint() : mixed
- Identify the insertion point for a new file.
- _populateFileList() : null
- Populate the existing file list from the XML.
Properties
$_dir_list
The list of directories in the contents section.
private
Horde_Pear_Package_Xml_Directory
$_dir_list
$_filelist
The root of the file list section.
private
DOMNode
$_filelist
$_install_list
The list of files in the "filelist" section.
private
array<string|int, mixed>
$_install_list
= array()
$_xml
The package.xml handler to operate on.
private
Horde_Pear_Package_Xml
$_xml
Methods
__construct()
Constructor.
public
__construct(Horde_Pear_Package_Xml $xml, DOMNode $contents, DOMNode $filelist) : mixed
Parameters
- $xml : Horde_Pear_Package_Xml
-
The package.xml handler to operate on.
- $contents : DOMNode
-
The root node for the "contents" listing.
- $filelist : DOMNode
-
The root node for the "filelist" listing.
Return values
mixed —add()
Add a file to the list.
public
add(string $file, array<string|int, mixed> $params) : null
Parameters
- $file : string
-
The file name.
- $params : array<string|int, mixed>
-
Additional file parameters.
Return values
null —delete()
Delete a file from the list.
public
delete(string $file) : null
Parameters
- $file : string
-
The file name.
Return values
null —update()
Update the file list.
public
update(Horde_Pear_Package_Contents $contents) : null
Parameters
- $contents : Horde_Pear_Package_Contents
Return values
null —_getInstallInsertionPoint()
Identify the insertion point for a new file.
private
_getInstallInsertionPoint(string $new) : mixed
Parameters
- $new : string
-
The key for the new element.
Return values
mixed —The insertion point.
_populateFileList()
Populate the existing file list from the XML.
private
_populateFileList() : null