bool addCompressionMethod(
str
$method
)
|
|
Add a decompression method to use
file "write.$method.inc" must exist in data directory called automaticly by addPathDownload()
Parameters:
void addInstallerPages(
)
|
|
Add the file-copying steps to the installer
bool addMetaFile(
str
$name, str
$filePath, str
$contentType, [array
$replace = array()]
)
|
|
Add a file to the installer.
Access it like this: installer.php?file=NAME
Parameters:
str |
$name: |
|
str |
$filePath: |
|
str |
$contentType: |
|
array |
$replace: |
|
int addPage(
str
$title, str
$content, [array
$fields = array()], [array
$buttons = array()]
)
|
|
add a page to the installer
Parameters:
str |
$title: |
Title of the page |
str |
$content: |
PHP content |
array |
$fields: |
list of input fields to use |
array |
$buttons: |
status of buttons array('next'=>bool,'back'=>bool,'disabled'=>bool) |
API Tags:
void addPath(
str
$path, [str
$to = '/']
)
|
|
Add a directory of files to the installer
Parameters:
str |
$path: |
file/directory to read from |
str |
$to: |
path to extract to in installer |
bool addPathDownload(
str
$url, [str
$to = '/'], [str
$type = 'zip'], [mixed
$required = false]
)
|
|
Add a path that the user downloads
Parameters:
str |
$url: |
Download URL |
str |
$to: |
path to extract to |
str |
$type: |
file type/extraction method to use |
bool addWriteMethod(
str
$method
)
|
|
Add a method of creating files for example, over FTP, ect.
the file method is enabled by default
Parameters:
str |
$method: |
file "write.$method.inc" must exist in data directory |
void dataDir(
str
$path
)
|
|
set the engine data directory
Parameters:
string file(
string
$name
)
|
|
Get a name of a resource file to be used
Parameters:
API Tags:
Return: | file contents |
Access: | protected |
void generate(
[str
$output = 'installer.php']
)
|
|
Generate the installer file
Parameters:
str |
$output: |
Path to write file |
void generateTarGz(
unknown_type
$file, [unknown_type
$format = 'gz'], [bool
$installer = null]
)
|
|
Generate a tar/tgz/bz file If you define $installer, this function will also put in the archive a file (si)
Parameters:
unknown_type |
$file: |
|
unknown_type |
$format: |
|
bool |
$installer: |
filename for an instaler file |
bool ignored_file(
str
$fname
)
|
|
is this an ignored file?
Parameters:
API Tags:
Return: | true for ignored, false to include |
Access: | protected |
void message(
str
$message, [int
$state = 0]
)
|
|
Send a message to the installer console.
Parameters:
str |
$message: |
|
int |
$state: |
prints short sucess/fail message after message |
str stripPath(
str
$path
)
|
|
strip extra slashes out of a file path
Parameters:
str valid_chars(
str
$str, [array
$valid = null]
)
|
|
strip invalid chars from a string
Parameters:
str |
$str: |
Input string |
array |
$valid: |
array of okay characters, defaults to these: a-z A-z 0-9 _ |
API Tags:
void _add_file(
mixed
$from, str
$to, [bool
$output = true], str
$base
)
|
|
Add a file or directory to installer Use addFile() instead (it uses this)
Parameters:
str |
$base: |
main directory to read from |
str |
$to: |
directory in installer to write to |
bool |
$output: |
|
API Tags:
str _get_name_from_str(
str
$name, int
$length
)
|
|
Compound a filename from a sentence
Parameters:
str |
$name: |
Input |
int |
$length: |
max length of output |