apidoc
[ class tree: apidoc ] [ index: apidoc ] [ all elements ]
Packages:
PEAR_Frontend_Gtk2


Classes:
PEAR_Frontend_Gtk2
   PEAR_Frontend_Gtk2
   PEAR_Frontend_Gtk2_About
   PEAR_Frontend_Gtk2_ChannelDialog
   PEAR_Frontend_Gtk2_Channels
   PEAR_Frontend_Gtk2_Config
   PEAR_Frontend_Gtk2_Installation
   PEAR_Frontend_Gtk2_Package
   PEAR_Frontend_Gtk2_Packages

Class: PEAR_Frontend_Gtk2_Installation

Source Location: /PEAR_Frontend_Gtk2-1.1.0/PEAR/Frontend/Gtk2/Installation.php

Class Overview

PEAR_Frontend
   |
   --PEAR_Frontend_Gtk2_Installation

Installation dialog and user interaction interface for the PEAR Gtk2 installer


Author(s):

Variables

Methods

Inherited Variables

Inherited Methods

Class Details

[line 11]
Installation dialog and user interaction interface for the PEAR Gtk2 installer


[ Top ]

Class Variables

$arRequestedWidgets = array(
        'dlgInstalling', 'imgInstalling', 'progBarInstaller', 'btnCloseInstalling',
        'lblInstalling', 'txtInstalling', 'expLog'
    )

[line 54]

The widgets which shall be loaded from the glade

file into the $arWidgets array

  • Access: protected

Type:   array


[ Top ]

$arWidgets = array()

[line 41]

Array with widgets from the glade file. They

are loaded in the buildDialog() methods

  • Access: protected

Type:   array


[ Top ]

$bQuitLoopOnClose =  true

[line 43]

  • Access: protected

Type:   mixed


[ Top ]

$bSeriousError =  false

[line 34]

If the log detects an unrecoverable error (e.g. failed dependency) an error symbol is shown, no matter if the callback for "uninstall ok" is called.
  • Access: protected

Type:   boolean


[ Top ]

$dlgInstalling =  null

[line 15]

  • Access: protected

Type:   mixed


[ Top ]

$dlgParent =  null

[line 13]

  • Access: protected

Type:   mixed


[ Top ]

$glade =  null

[line 14]

  • Access: protected

Type:   mixed


[ Top ]

$nPercentage =  0

[line 45]

  • Access: protected

Type:   mixed


[ Top ]

$strChannel =  null

[line 19]

  • Access: protected

Type:   mixed


[ Top ]

$strCommand =  null

[line 25]

The command which shall be executed (upgrade or uninstall)
  • Access: protected

Type:   string


[ Top ]

$strPackage =  null

[line 18]

  • Access: protected

Type:   mixed


[ Top ]

$txtLog =  null

[line 16]

  • Access: protected

Type:   mixed


[ Top ]


Method Detail

__construct (Constructor)   [line 61]

PEAR_Frontend_Gtk2_Installation __construct( GtkWidget $parent, GladeXML $glade)

  • Access: public

Parameters:

GtkWidget   $parent   — 
GladeXML   $glade   — 

[ Top ]

addPercentage   [line 303]

void addPercentage( $nPercentToAdd)

Add some percent to the progress bar
  • Access: protected

Parameters:

   $nPercentToAdd   — 

[ Top ]

appendToLog   [line 246]

void appendToLog( $strText)

  • Access: protected

Parameters:

   $strText   — 

[ Top ]

buildDialog   [line 73]

void buildDialog( )

load the glade file, load the widgets, connect the signals
  • Access: protected

[ Top ]

channelCommand   [line 163]

void channelCommand( string $strCommand, string $strChannel)

Executes a channel command
  • Access: public

Parameters:

string   $strCommand   —  The command (delete, update, discover)
string   $strChannel   —  The channel name (or the url for discovering)

[ Top ]

clearLog   [line 257]

void clearLog( )

  • Access: protected

[ Top ]

deleteWindow   [line 239]

void deleteWindow( )

The user may not close the window by hand
  • Access: public

[ Top ]

hideMe   [line 225]

void hideMe( )

  • Access: public

[ Top ]

installPackage   [line 98]

void installPackage( string $strChannel, string $strPackage, string $strVersion, [boolean $bInstall = true], [ $strDepOptions = null], [ $bForce = false])

Installs (or uninstalls) the given package.

If you want to install a file, set $strChannel and $strVersion to NULL.

  • Access: public

Parameters:

string   $strChannel   —  The channel on which the package can be found
string   $strPackage   —  The package to install
string   $strVersion   —  Package version to install
boolean   $bInstall   —  If the package shall be installed (true) or uninstalled (false)
   $strDepOptions   — 
   $bForce   — 

[ Top ]

log   [line 413]

void log( $msg, [ $append_crlf = true])

  • Access: public

Parameters:

   $msg   — 
   $append_crlf   — 

[ Top ]

outputData   [line 337]

void outputData( $data, [ $command = null])

All functions which might be expected in a PEAR_Frontend go here
  • Access: public

Parameters:

   $data   — 
   $command   — 

[ Top ]

prepareFresh   [line 203]

void prepareFresh( )

Prepares the widgets to have a fresh look.

Use it before starting the actual work

  • Access: protected

[ Top ]

setCurrentAction   [line 265]

void setCurrentAction( $strText)

  • Access: protected

Parameters:

   $strText   — 

[ Top ]

setCurrentIcon   [line 277]

void setCurrentIcon( int $nId)

Set the icon for the dialog
  • Access: protected

Parameters:

int   $nId   —  The stock item id

[ Top ]

setFinished   [line 310]

void setFinished( )

  • Access: protected

[ Top ]

setPercentage   [line 287]

void setPercentage( $nPercent)

Set the progress bar progress in percent (0-100)
  • Access: protected

Parameters:

   $nPercent   — 

[ Top ]

show   [line 188]

void show( $strAction, [ $bQuitLoopOnClose = false])

Use this method to run commands by hand, and you need the interface to be shown.
  • Access: public

Parameters:

   $strAction   — 
   $bQuitLoopOnClose   — 

[ Top ]

showMe   [line 215]

void showMe( )

  • Access: protected

[ Top ]

userConfirm   [line 439]

void userConfirm( string $prompt, [string $default = 'yes'])

Ask the user a question
  • Access: public

Parameters:

string   $prompt   —  The question to ask
string   $default   —  The default value

[ Top ]

__call   [line 323]

void __call( $function, $arguments)

  • Access: public

Parameters:

   $function   — 
   $arguments   — 

[ Top ]
Documentation generated on Mon, 11 Mar 2019 15:46:47 -0400 by phpDocumentor 1.4.4. PEAR Logo Copyright © PHP Group 2004.