phpDocumentor Upgrade
[ class tree: Upgrade ] [ index: Upgrade ] [ all elements ]

Class: SystemChecksStep

Source Location: /upgrade/steps/SystemChecksStep.class

Class SystemChecksStep

Method Summary
void   CheckFileDirective()  
void   CheckManifest()  
void   CheckStorageDirectory()  
void   processRequest()  
void   renderFileList()   Render a file-list in a minimizable block with a heading and an optional notice text.
void   stepName()  
array   _checkStorageSubDirectory()   Check up to $max files / dirs in a directory tree if they are still read/writeable
array(boolean   _executeSql()   Execute a series of SQL statements.
void   _getBytes()  
array   _testPrivileges()   Check if the user has the most basic database privileges required to finish the upgrade

[ Top ]
Methods
CheckFileDirective  [line 529]

  void CheckFileDirective( )



[ Top ]
CheckManifest  [line 609]

  void CheckManifest( &$statusMonitor, $useSetTimeLimit  )

Parameters:
   &$statusMonitor: 
   $useSetTimeLimit: 


[ Top ]
CheckStorageDirectory  [line 539]

  void CheckStorageDirectory( )



[ Top ]
processRequest  [line 55]

  void processRequest( )



Redefinition of:
UpgradeStep::processRequest()

[ Top ]
renderFileList  [line 681]

  void renderFileList( array $files, string $blockId, string $heading, [string $notice = null]  )

Render a file-list in a minimizable block with a heading and an optional notice text.

Parameters:
array   $files: 
string   $blockId:  The HTML id for the block toggle mechanism
string   $heading:  Heading for the block
string   $notice:  (optional) A longer notice to be shown on top of the file list


[ Top ]
stepName  [line 30]

  void stepName( )



Redefinition of:
UpgradeStep::stepName()

[ Top ]
_checkStorageSubDirectory  [line 575]

  array _checkStorageSubDirectory( string $dirname, &$tested, int $max, int $tested  )

Check up to $max files / dirs in a directory tree if they are still read/writeable

Parameters:
string   $dirname:  directory
int   $tested:  number of already tested files / dirs
int   $max:  max files/dirs to check
   &$tested: 

API Tags:
Return:  a list of files with insufficient permissions


[ Top ]
_executeSql  [line 786]

  array(boolean _executeSql( string $buffer, string $tablePrefix  )

Execute a series of SQL statements.

Parameters:
string   $buffer:  the SQL statements
string   $tablePrefix:  prefix for table names

API Tags:
Return:  success, string error message)


[ Top ]
_getBytes  [line 38]

  void _getBytes( $val  )

Parameters:
   $val: 


[ Top ]
_testPrivileges  [line 699]

  array _testPrivileges( )

Check if the user has the most basic database privileges required to finish the upgrade

steps successfully. Check:

  • CREATE TABLE, ALTER TABLE, DROP TABLE
  • CREATE INDEX, DROP INDEX
  • CREATE SEQUENCE, DROP SEQUENCE


API Tags:
Return:  (boolean success, string errors)


[ Top ]

Documentation generated on Fri, 03 Oct 2008 06:14:42 -0700 by phpDocumentor 1.3.0RC6