Download the PHP package digipolisgent/robo-digipolis-helpers without Composer

On this page you can find all versions of the php package digipolisgent/robo-digipolis-helpers. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Informations about the package robo-digipolis-helpers

Robo Digipolis Helpers

Latest Stable Version Latest Unstable Version Total Downloads License

Build Status Maintainability Test Coverage

Used by digipolis, generic commands/skeleton do execute deploys and syncs between environments.

Getting started

To let this package know about your database configuration, please read [the robo-digipolis-deploy package's documentation] (https://github.com/district09/robo-digipolis-deploy#use-events-for-default-configuration).

We make a couple of assumptions, most of which can be overwritten. See default.properties.yml for all default values, and the properties.yml documentation for all available configuration options.

By default, we assume a capistrano-like directory structure on your servers:

This package provides a couple of commands. You can use vendor/bin/robo list and vendor/bin/robo help [command] to find out what they do. Most importantly these commands follow a "skeleton", in which each step of the command fires an event, and the event listeners return an EventHandlerWithPriority. The default event listeners provided by this package are in the DigipolisHelpersDefaultHooksCommands class. Each method of that class is an event listener, and returns an event handler. The default handlers provided by this package can be found in src/EventHandler/DefaultHandler. If you want to overwrite or alter the behavior of a certain step in the command, all you have to do is create an event listener by using the on-event hook for the right event, and let it return your custom handler. Handlers are executed in order of priority (lower numbers executed first), the priority of default handlers is 999. If your handler calls $event->stopPropagation() in its handle method, handlers that come after it, won't get executed. For further information, see the list of available events;

properties.yml

You need to provide a properties.yml file in your project root as well, so the script knows what symlinks to create, where to put backups, ...

Below is an example of some sensible defaults:

As you can see, you can reference values from within properties.yml by using following notation: ${path.to.property}. There are also other tokens available:

List of available events

Event arguments can be retrieved with $event->getArgument($argumentName);

digipolis:backup-remote

The handler for this event should return a task that creates a backup on a host, based on options that are passed.

Default handler: BackupRemoteHandler
Event arguments:

digipolis:build-task

The handler for this event should return a task that creates a release archive of the current codebase to upload to an environment.

Default handler: BuildTaskHandler
Event arguments:

digipolis:clean-dirs

The handler for this event should return a task that cleans the releases directory by removing the older releases.

Default handler: CleanDirsHandler
Event arguments:

digipolis:clear-cache

The handler for this event should return a task that clears the cache on the remote host.

Default handler: ClearCacheHandler
Event arguments:

digipolis:clear-remote-opcache

The handler for this event should return a task that clears the opcache on the remote host.

Default handler: ClearRemoteOpcacheHandler
Event arguments:

digipolis:compress-old-release

The handler for this event should return a task that compresses old releases on the host for the given app.

Default handler: CompressOldReleaseHandler
Event arguments:

digipolis:current-project-root

The handler for this event should return the path to the current project root for the given app on the given host. This means the actual path, not a task that will return it when executed.

Default handler: CurrentProjectRootHandler
Event arguments:

digipolis:download-backup

The handler for this event should return a task that downloads a backup of an app from a host.

Default handler: DownloadBackupHandler
Event arguments:

digipolis:install

The handler for this event should return a task that executes the install script on the host.

Default handler: InstallHandler
Event arguments:

digipolis:is-site-installed

The handler for this event should return a boolean indicating whether or not there already is an active installation of the app on the host. This means the actual boolean, not a task that will return it when executed. This helps us to determine whether the install or the update script should be ran when deploying the app.

Default handler: IsSiteInstalledHandler
Event arguments:

digipolis:get-local-settings

The handler for this event should return the settings for the local installation of the app as parsed from properties.yml.

Default handler: LocalSettingsHandler
Event arguments:

digipolis:mirror-dir

The handler for this event should return a task that mirrors everything (files, symlink, subdirectories, ...) from one directory to another.

Default Handler: MirrorDirHandler
Event arguments:

digipolis:post-symlink

The handler for this event should return a task that will be executed after creating the symlinks (as parsed from properties.yml) on the remote host.

Default Handler: PostSymlinkHandler
Event arguments:

digipolis:pre-local-sync-files

The handler for this event should return a task that should be executed before syncing files from a remote installation to your local installation.

Default Handler: PreLocalSyncFilesHandler
Event arguments:

digipolis:pre-restore-backup-remote

The handler for this event should return a task that should be executed before restoring a backup on a host.

Default Handler: PreRestoreBackupRemoteHandler
Event arguments:

digipolis:pre-symlink

The handler for this event should return a task that should be executed before the symlinks on the remote host are created.

Default Handler: PreSymlinkHandler
Event arguments:

digipolis:push-package

The handler for this event should return a task that pushes a release archive to a host.

Default Handler: PushPackageHandler
Event arguments:

digipolis:realpath

The handler for this event should return the realpath of the given path. This means the actual path, not a task that will return it when executed. The default handler supports replacing ~ (tilde) with the user's homedir.

Default handler: RealpathHandler
Event arguments:

digipolis:get-remote-settings

The handler for this event should return the settings for the remote installation of the app as parsed from properties.yml. This means the actual settings, not a task that will return it when executed.

Default handler: RemoteSettingsHandler
Event arguments:

digipolis:remote-switch-previous

The handler for this event should return a task that will switch the current symlink to the previous release (mostly used on rollback of a failed release).

Default Handler: RemoteSwitchPreviousHandler
Event arguments:

digipolis:remote-symlink

The handler for this event should return a task that will create the symlinks as defined in properties.yml.

Default Handler: RemoteSymlinkPreviousHandler
Event arguments:

digipolis:remove-backup-remote

The handler for this event should return a task that removes a backup from the host.

Default Handler: RemoveBackupRemoteHandler
Event arguments:

digipolis:remove-failed-release

The handler for this event should return a task that removes a failed release from the host.

Default Handler: RemoveFailedReleaseHandler
Event arguments:

digipolis:remove-local-backup

The handler for this event should return a task that removes a backup from your local machine.

Default Handler: RemoveLocalBackupHandler
Event arguments:

digipolis:restore-backup-db-local

The handler for this event should return a task that restores a database backup on your local machine.

Default Handler: RestoreBackupDbLocalHandler
Event arguments:

digipolis:restore-backup-files-local

The handler for this event should return a task that restores a files backup on your local machine.

Default Handler: RestoreBackupFilesLocalHandler
Event arguments:

digipolis:restore-backup-remote

The handler for this event should return a task that restores a backup on a host.

Default Handler: RestoreBackupRemoteHandler
Event arguments:

digipolis:rsync-files-between-hosts

The handler for this event should return a task that rsyncs files between two hosts.

Default Handler: RsyncFilesBetweenHostsHandler
Event arguments:

digipolis:rsync-files-to-local

The handler for this event should return a task that rsyncs files to your local machine.

Default Handler: RsyncFilesToLocalHandler
Event arguments:

digipolis:switch-previous

The handler for this event should return a task that will switch the current symlink to the previous release (mostly used on rollback of a failed release). The difference with the (digipolis:remote-switch-previous)[#digipolisremote-switch-previous] event is that this will be executed directly on the host, and thus doesn't need an ssh connection, while the (digipolis:remote-switch-previous)[#digipolisremote-switch-previous] will be executed from your deployment server, or your local machine, and thus will need an ssh connection to the host.

Default Handler: SwitchPreviousHandler
Event arguments:

digipolis:timeout-setting

The handler for this event should return the the timeout setting of the given type in seconds. This means the actual setting, not a task that will return it when executed.

Default handler: TimeoutSettingHandler
Event arguments:

digipolis:update

The handler for this event should return a task that executes the update script on the host.

Default handler: UpdateHandler
Event arguments:

digipolis:upload-backup

The handler for this event should return a task that uploads a backup of an app to a host.

Default handler: UploadBackupHandler
Event arguments:


All versions of robo-digipolis-helpers with dependencies

PHP Build Version
Package Version
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package digipolisgent/robo-digipolis-helpers contains the following files

Loading the files please wait ....