[ PHPXref.com ] [ Generated: Sun Jul 20 17:51:59 2008 ] [ Flyspray 0.9.8 ]
[ Index ]     [ Variables ]     [ Functions ]     [ Classes ]     [ Constants ]     [ Statistics ]

title

Body

[close]

/setup/ -> index.php (summary)

(no description)

File Size: 2246 lines (81 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 4 files
 includes/template.php
 includes/version.php
 includes/archive_tar.php
 includes/functions.inc.php

Defines 1 class

Setup:: (49 methods):
  Setup()
  ScanIncludePath()
  CheckAdodbLibrary()
  CheckConfigFile()
  CheckCacheFolder()
  CheckDatabaseSupport()
  CheckPreStatus()
  CheckPhpCompatibility()
  CheckPhpCli()
  CheckPostedData()
  DisplayAdministration()
  DisplayCompletion()
  DisplayDatabaseSetup()
  DisplayPreInstall()
  DisplayLicense()
  FetchThroughCurl()
  FilterGpc()
  DataSlasher()
  DownloadFileToServer()
  GetAdminInput()
  GetDatabaseOutput()
  GetIniSetting()
  GetPageMessage()
  GetParamValue()
  GetPhpSettings()
  GetReminderDaemonSelection()
  GetSetupOptions()
  InstallAdodb()
  InstallPointNineEight()
  InstallPointNineSeven()
  IsWriteable()
  MakePassword()
  OutputHtmlList()
  ProcessActions()
  ProcessAdminConfig()
  ProcessDatabaseSetup()
  BackupTables()
  DeleteTables()
  DeleteSequences()
  BackupDeleteTables()
  PopulateDb()
  ReturnStatus()
  SetUpgradeLogin()
  SplitSql()
  TrimArgs()
  UncompressFile()
  UpgradePointNineSeven()
  VerifyVariableTypes()
  OutputPage()


Class: Setup  - X-Ref

Setup()   X-Ref


ScanIncludePath($includeFile, $additionalPath = '')   X-Ref
Function to scan include path and any additional paths for files

param: string $includeFile Name of file to scan for
param: string $additionalPath An additional path to scan for. eg Application path
return: boolean/string FALSE/actual path of file

CheckAdodbLibrary()   X-Ref
Function to check the availability of ADOdb libraries. It calls another
function to scan the inlcude paths and you can include the application path
to be scanned as well.

return: string HTML formatted status

CheckConfigFile()   X-Ref
Function to check the permission of the config file

param: void
return: string An html formatted boolean answer

CheckCacheFolder()   X-Ref
Function to check the permission of the cache folder

param: void
return: string An html formatted boolean answer

CheckDatabaseSupport()   X-Ref
Function to check the availability of the Database support

param: void
return: void

CheckPreStatus()   X-Ref
No description

CheckPhpCompatibility()   X-Ref
Function to check the version of PHP available compared to the
Applications requirements

param: void
return: string An html formatted boolean answer

CheckPhpCli()   X-Ref
No description

CheckPostedData($expectedFields = array()   X-Ref
Function to check the posted data from forms.

param: array $expectedFields Array of field names which needs processing

DisplayAdministration()   X-Ref
No description

DisplayCompletion()   X-Ref
No description

DisplayDatabaseSetup()   X-Ref
No description

DisplayPreInstall()   X-Ref
Function to prepare template output


DisplayLicense()   X-Ref
No description

FetchThroughCurl($url, $downloadTo)   X-Ref
No description

FilterGpc($filter = 'strip', $what = 'gpc')   X-Ref
To add/strip slashes depending on the status of magic_quotes_gpc

param: string $filter The type of filter to execute addslashes()
param: string $what The Super global type to filter. It could be
return: void

DataSlasher($rawData)   X-Ref
To filter the data ie. to slash/unslash

This is a function which may be called recursively depending on the
variable type. If it is an array it recurses back to this same function.

param: string $gpcData the string which needs to be filtered
return: string $data the string after being filtered

DownloadFileToServer($url, $downloadTo, $alternate_url = '')   X-Ref
Function to download a file from a remote server and store it to flyspray server

param: string $url The URL of the file to download
param: string $downloadTo The destination folder to where the file will be saved on the server.
return: boolean TRUE if success else error message

GetAdminInput($field, $value, $label)   X-Ref
No description

GetDatabaseOutput()   X-Ref
No description

GetIniSetting($option)   X-Ref
Function to get the php ini config values

param: string $option The ini setting name to check the status for
return: string The status of the setting either "On" or "OFF"

GetPageMessage()   X-Ref
Function to get the error messages and generate an error output for the template

return: string $message The message which needs outputting

GetParamValue(&$arr, $name, $default=null )   X-Ref
Utility function to return a value from a named array or a specified default

param: array &$arr The array to get the values from
param: string $name The name of the key to check the value for
param: string $default The default value if the value is not set with the array
return: string $value The value to be returned

GetPhpSettings()   X-Ref
Function to get a listing of recommended and actual settings
for php.

param: void
return: string $output HTML formatted string.

GetReminderDaemonSelection($value)   X-Ref
No description

GetSetupOptions()   X-Ref
No description

InstallAdodb()   X-Ref
Function to install ADOdb library


InstallPointNineEight($data)   X-Ref
No description

InstallPointNineSeven($data)   X-Ref
No description

IsWriteable($fileSystem)   X-Ref
Function to check if a particular folder/file is writeable.

param: string $fileSystem Path to check

MakePassword($passwordLength)   X-Ref
No description

OutputHtmlList($list_array = array()   X-Ref
Function to Output an Ordered/Un-ordered list from an array. Default list type is un-ordered.

param: array() $list_array An array list of data to be made into a list.
return: string $list An HTML list

ProcessActions()   X-Ref
Function to act on all the actions during Flyspray Setup
The Post variables are extracted for deciding which function to call.


ProcessAdminConfig($data)   X-Ref
No description

ProcessDatabaseSetup($data)   X-Ref
No description

BackupTables($data, $table_list)   X-Ref
No description

DeleteTables($data, $table_list)   X-Ref
No description

DeleteSequences($data)   X-Ref
No description

BackupDeleteTables($data)   X-Ref
No description

PopulateDb($data)   X-Ref
Function to populate the database with the sql constructs which is in an sql file

param: array $data The actual database configuration values
return: boolean

ReturnStatus($boolean, $type = 'yes')   X-Ref
Function to return status of boolean results in html format

param: boolean $boolean The status of the result in True/False form
param: string $type The type of html format to return
return: string Depending on the type of format to return

SetUpgradeLogin($data, $cookiesalt)   X-Ref
No description

SplitSql($sql, $db_type)   X-Ref
Function to split the SQL queries from a SQL file into individual queries
Thanks to Ben Balbo http://www.benbalbo.com for the code comments

param: string $sql The sql queries which was grabbed from a SQL file

TrimArgs($arg)   X-Ref
To verify if a string was empty or not.

Usually used to validate user input. If the user has inputted empty data
or just blank spaces, we need to trim of such empty data and see if
anything else is left after trimming. If there is data remaining, then
the return value will be greater than 0 else it will be 0 (zero) which
equates to a TRUE/FALSE scenario

param: string $arg The data to be checked
return: The result of the check.

UncompressFile($from_location, $filename, $to_location)   X-Ref
Function to un-compress file archives

param: $from_location Location where archive resides
param: $filename The name of the file to un-compress
param: $to_location The location where to un-compress the archive
return: boolean TRUE else error message

UpgradePointNineSeven($data)   X-Ref
No description

VerifyVariableTypes($type, $value)   X-Ref
No description

OutputPage($templates = array()   X-Ref
Function to output the templates

param: array $templates The collection of templates with their associated variables



[ Powered by PHPXref - Served by Debian GNU/Linux ]