Public Member Functions | Protected Member Functions

BeditaBaseShell Class Reference

Base class for bedita shell scripts: provides common filesystem related methods. More...

Inheritance diagram for BeditaBaseShell:
AddressbookShell BeditaShell CleanupTask DataShell DbadminShell FrontendShell MailShell MigrationDateItemsShell ModuleShell NewsletterShell PublicationShell

List of all members.

Public Member Functions

 __construct ($dispatch)
 Call parent::__construct and set up exception handler.
 handleExceptions (Exception $exception)
 Handle Exceptions.
 initialize ()
 Initializes the Shell Setup self::verbose param.
 startup ()
 Default shell startup, call initConfig (may raise db/model errors!), to override in subclasses.
 help ()
 title ($title)
 test ()

Protected Member Functions

 initConfig ()
 Init configuration for all bedita shells, called in startup().
 check_sys_get_temp_dir ()
 setupTempDir ()
 cleanTempDir ()
 mandatoryArgument ($opt, $errMsg)
 Read mandatory shell argument ($opt), exit with err message if parameter not present.
 readInputArgs ()
 Read shell input argument from file, through reerved argument -input input file in "properties" form:
 checkExportFile ($expFile)
 isUrl ($str)
 checkUrl ($url)
 checkDir ($dir)
 __clean ($path, $removeDirs=true)
 verbose ($message=null, $newlines=1)
 Verbose output.

Detailed Description

Base class for bedita shell scripts: provides common filesystem related methods.

Definition at line 27 of file bedita_base.php.


Constructor & Destructor Documentation

BeditaBaseShell::__construct ( dispatch  ) 

Call parent::__construct and set up exception handler.

Parameters:
ShellDispatcher $dispatch

Definition at line 39 of file bedita_base.php.


Member Function Documentation

BeditaBaseShell::handleExceptions ( Exception $  exception  ) 

Handle Exceptions.

Parameters:
Exception $exception
Returns:
void

Definition at line 50 of file bedita_base.php.

BeditaBaseShell::mandatoryArgument ( opt,
errMsg 
) [protected]

Read mandatory shell argument ($opt), exit with err message if parameter not present.

Parameters:
unknown_type $opt
unknown_type $errMsg

Definition at line 176 of file bedita_base.php.

BeditaBaseShell::readInputArgs (  )  [protected]

Read shell input argument from file, through reerved argument -input input file in "properties" form:

param1=value param2=value

Definition at line 192 of file bedita_base.php.

BeditaBaseShell::startup (  ) 

Default shell startup, call initConfig (may raise db/model errors!), to override in subclasses.

See also:
Shell::startup()

Reimplemented in BeditaShell, MailShell, MigrationDateItemsShell, ModuleShell, NewsletterShell, and CleanupTask.

Definition at line 89 of file bedita_base.php.

References initConfig().

BeditaBaseShell::verbose ( message = null,
newlines = 1 
) [protected]

Verbose output.

Parameters:
string Message.
integer New-lines.
See also:
Shell::out()

Definition at line 285 of file bedita_base.php.

Referenced by initialize().


The documentation for this class was generated from the following file:
Generated on Fri Dec 11 2015 15:29:46 by Doxygen 1.7.1  BEditaBEdita 3.7 Corylus