Class BeditaBaseShell

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

Shell

Extended by

BeditaBaseShell

Direct known subclasses

AddressbookShell, BeditaShell, MailShell, MediaShell, MigrationDateItemsShell, ModuleShell, NewsletterShell, PublicationShell, RedisShell, RelationShell, ThumbShell, CacheShell, CleanupDataTask, CleanupTask, DataShell, DbadminShell, DeployShell, EditorialContentsShell, FrontendShell

Located at vendors/shells/bedita_base.php

Methods summary

`public`	# `__construct( ShellDispatcher $dispatch )` Call parent::__construct and set up exception handler Call parent::__construct and set up exception handler Parameters `$dispatch`
`public`	# `handleExceptions( Exception $exception )` Handle Exceptions Handle Exceptions Parameters `$exception`
`public`	# `initialize( )` Initializes the Shell Setup self::verbose param Initializes the Shell Setup self::verbose param
`protected`	# `initConfig( )` Init configuration for all bedita shells, called in startup() Init configuration for all bedita shells, called in startup()
`public`	# `startup( )` Default shell startup, call initConfig (may raise db/model errors!), to override in subclasses Default shell startup, call initConfig (may raise db/model errors!), to override in subclasses See Shell::startup()
`public`	# `help( )`
`public`	# `title( $title )`
`protected`	# `check_sys_get_temp_dir( )`
`protected`	# `setupTempDir( )`
`protected`	# `cleanTempDir( )`
`protected`	# `mandatoryArgument( unknown_type $opt, unknown_type $errMsg )` Read mandatory shell argument ($opt), exit with err message if parameter not present Read mandatory shell argument ($opt), exit with err message if parameter not present Parameters `$opt` `$errMsg`
`protected`	# `readInputArgs( )` Read shell input argument from file, through reerved argument -input input file in "properties" form: Read shell input argument from file, through reerved argument -input input file in "properties" form: param1=value param2=value
`public`	# `test( )`
`protected`	# `checkExportFile( $expFile )`
`protected`	# `isUrl( $str )`
`protected`	# `checkUrl( $url )`
`protected`	# `checkDir( $dir )`
`protected`	# `__clean( $path, $removeDirs = true )`
`protected`	# `verbose( string $message = null, integer $newlines = 1 )` Verbose output. Verbose output. Parameters `$message` Message. `$newlines` New-lines. See Shell::out()

Properties summary

`private boolean`	`$verbose` Verbose mode. Verbose mode.	# `false`
`private boolean`	`$debug` Debug mode. Debug mode.	# `false`