Download the PHP package oxidprojects/oxrun without Composer

On this page you can find all versions of the php package oxidprojects/oxrun. 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 oxrun

Oxrun

oxrun ci Coverage Status

Oxrun provides a cli toolset for the OXID eShop Community Edition.

Documentation

Installation

composer require oxidprojects/oxrun.

After installation manually clear the cache via ./vendor/bin/oxrun-light cache:clear to make all oxrun commands available.

Usage

./vendor/bin/oe-console is standard call.

Available commands

cache

cache:clear

Clear OXID cache

Usage

Clear OXID cache

Options

--force|-f

Try to delete the cache anyway. [danger or permission denied]

config:get

Gets a config value

Usage

Gets a config value

Arguments

variableName

Variable name

Options

--moduleId

--json

Output as json

--yaml

Output as YAML (default)

deploy:config

Sets multiple configuration values that are not in module settings

Usage

This command can import settings into the database that are not found in the module settings. If they are module settings, they are stored in the module configuration yaml, not in the database.

The file path is relative to the shop installation_root_path/var/oxrun_config/. You can also pass a YAML string on the command line.

To create YAML use command oe-console deploy:generate:configration --help

YAML example:

Example: malls.yml.dist

If you want, you can also specify a YAML string on the command line instead of a file, e.g.:

Arguments

configfile

The file containing the config values, see example/malls.yml.dist. (e.g. dev.yml, stage.yml, prod.yml)

Options

--force-db|-f

Still write everything into the database.

--production

For "production" system

--staging

For "staging" system

--development

For "development" system

--testing

For "testing" system

config:set

Sets a config value

Usage

Sets a config value

Arguments

variableName

Variable name

variableValue

Variable value

Options

--variableType

Variable type

--moduleId

config:shop:get

Gets a shop config value

Usage

Gets a shop config value

Arguments

variableName

Variable name

config:shop:set

Sets a shop config value

Usage

Sets a shop config value

Arguments

variableName

Variable name

variableValue

Variable value

db:anonymize

Anonymize relevant OXID db tables

Usage

Anonymizes user relevant data in the OXID database. Relevant tables are: Array ( [0] => oxnewssubscribed [1] => oxuser [2] => oxvouchers [3] => oxaddress [4] => oxorder )

Options

--debug

Debug SQL queries generated

--domain|-d

Domain to use for all anonymized usernames /email addresses, default is "@oxrun.com"

--keepdomain|-k

Domain which should NOT be anonymized, default is "@foobar.com". Data with this domain in the email address will NOT be anonymized.

db:dump

Create a dump, with mysqldump

Usage

Create a dump from the current database.

usage:

oe-console db:dump --withoutTableData oxseo,oxvou%
- To dump all Tables, but `oxseo`, `oxvoucher`, and `oxvoucherseries` without data.
  possibilities: oxseo%,oxuser,%logs%

oe-console db:dump --table %user%
- to dump only those tables `oxuser` `oxuserbasketitems` `oxuserbaskets` `oxuserpayments`

oe-console db:dump --anonymous # Perfect for Stage Server
- Those table without data: `oxseo`, `oxseologs`, `oxseohistory`, `oxuser`, `oxuserbasketitems`, `oxuserbaskets`, `oxuserpayments`, `oxnewssubscribed`, `oxremark`, `oxvouchers`, `oxvoucherseries`, `oxaddress`, `oxorder`, `oxorderarticles`, `oxorderfiles`, `oepaypal_order`, `oepaypal_orderpayments`.

oe-console db:dump -v
- With verbose mode you will see the mysqldump command
  (`mysqldump -u 'root' -h 'oxid_db' -p ... `)

oe-console db:dump --file dump.sql 
- Put the Output into a File

** Only existing tables will be exported. No matter what was required.

System requirement:

* php
* MySQL CLI tools.

Options

--file

Save dump at this location.

--table|-t

Only names of tables are dumped. Default all tables. Use comma separated list and or pattern e.g. %voucher%

--ignoreViews|-i

Ignore views

--anonymous|-a

Export not table with person related data.

--withoutTableData|-w

Export tables only with their CREATE statement. So without content. Use comma separated list and or pattern e.g. %voucher%

db:import

Import a sql file

Usage

Imports an SQL file on the current shop database.

Requires php exec and MySQL CLI tools installed on your system.

Arguments

file

The sql file which is to be imported

db:info

Show a Table with size of all Tables

Usage

Show a Table with size of all Tables

Options

--tableSize

Size of all Tables

--databaseSize

Size of the Databases

db:list

List of all Tables

Usage

List Tables

usage: oe-console db:list --pattern oxseo%,oxuser

Options

--plain|-p

print list as comma separated.

--pattern|-t

table name pattern test. e.g. oxseo%,oxuser

db:query

Executes a query

Usage

Executes an SQL query on the current shop database. Wrap your SQL in quotes.

If your query produces a result (e.g. a SELECT statement), the output will be returned via the table component. Add the raw option for raw output.

Requires php exec and MySQL CLI tools installed on your system.

Arguments

query

The query which is to be executed

Options

--raw

Raw output

deploy:config

Sets multiple configuration values that are not in module settings

Usage

This command can import settings into the database that are not found in the module settings. If they are module settings, they are stored in the module configuration yaml, not in the database.

The file path is relative to the shop installation_root_path/var/oxrun_config/. You can also pass a YAML string on the command line.

To create YAML use command oe-console deploy:generate:configration --help

YAML example:

Example: malls.yml.dist

If you want, you can also specify a YAML string on the command line instead of a file, e.g.:

Arguments

configfile

The file containing the config values, see example/malls.yml.dist. (e.g. dev.yml, stage.yml, prod.yml)

Options

--force-db|-f

Still write everything into the database.

--production

For "production" system

--staging

For "staging" system

--development

For "development" system

--testing

For "testing" system

deploy:generate:configuration

Generate a yaml with configuration from Database. For command deploy:config

Usage

Configration that is not included in the modules can be saved. With the command: deploy:config they can be read again

Options

--update|-u

Update an exited config file, with data from DB

--configfile|-c

The config file to update or create if not exits

--oxvarname

Dump configs by oxvarname. One name or as comma separated List

--oxmodule

Dump configs by oxmodule. One name or as comma separated List

--no-descriptions|-d

No descriptions are added.

--language|-l

Speech selection of the descriptions.

--list

list all saved configrationen

--production

For "production" system

--staging

For "staging" system

--development

For "development" system

--testing

For "testing" system

deploy:generate:module-activator

Generate a yaml file for command deploy:module-activator

Usage

Generate a yaml file for command deploy:module-activator

Options

--configfile|-c

The Config file to change or create if not exits

--whitelist|-w

Takes modules that are always activated. All others remain deactive.

--blacklist|-b

Takes modules that always need to be disabled. All others are activated.

deploy:link:environment

Links the environment configration files. Ideal for CI/CD

Usage

In files structure you has multiple files per shop in var/configuration/environment directory. e.g. production.1.yaml, staging.1.yaml This might be useful when deploying files to some specific environment. @see: Modules configuration deployment

Options

--rm

Remove the links

--production

For "production" system

--staging

For "staging" system

--development

For "development" system

--testing

For "testing" system

deploy:module-activator

Activates multiple modules, based on a YAML file

Usage

usage: oe-console deploy:module-activator modules.yml

Example:

Supports either a "whitelist" and or a "blacklist" entry with multiple shop ids and the desired module ids to activate (whitelist) or to exclude from activation (blacklist).

With "priorities", you can define the order (per subshop) in which the modules will be activated.

If you want, you can also specify a YAML string on the command line instead of a file, e.g.:

Arguments

yaml

YAML module list filename or YAML string. The file path is relative to /var/www/oxid-esale/var/oxrun_config/

Options

--skipDeactivation|-s

Skip deactivation of modules, only activate.

--clearModuleData|-d

Clear module data in oxconfig.

deploy:module-apply-configuration-light

It the same as oe:module:apply-configuration but faster.

Usage

The module configurations will ONLY written into the database.

WARNING: If you make changes on metadata.php::controllers|::extend then this command doesn't work.

That automatic activate or deactive module with the param configured: true|false. It the same as oe:module:apply-configuration but faster!

deploy:update-module-config

Update the module configuration yaml with the data from the database

Usage

Is the reverse command from oe:module:apply-configuration.

Options

--production

For "production" system

--staging

For "staging" system

--development

For "development" system

--testing

For "testing" system

deploy:generate:configuration

Generate a yaml with configuration from Database. For command deploy:config

Usage

Configration that is not included in the modules can be saved. With the command: deploy:config they can be read again

Options

--update|-u

Update an exited config file, with data from DB

--configfile|-c

The config file to update or create if not exits

--oxvarname

Dump configs by oxvarname. One name or as comma separated List

--oxmodule

Dump configs by oxmodule. One name or as comma separated List

--no-descriptions|-d

No descriptions are added.

--language|-l

Speech selection of the descriptions.

--list

list all saved configrationen

--production

For "production" system

--staging

For "staging" system

--development

For "development" system

--testing

For "testing" system

deploy:generate:module-activator

Generate a yaml file for command deploy:module-activator

Usage

Generate a yaml file for command deploy:module-activator

Options

--configfile|-c

The Config file to change or create if not exits

--whitelist|-w

Takes modules that are always activated. All others remain deactive.

--blacklist|-b

Takes modules that always need to be disabled. All others are activated.

misc:phpstorm:metadata

Generate a PhpStorm metadata file for auto-completion and a oxid module chain.Ideal for psalm or phpstan

Usage

Generate a PhpStorm metadata file for auto-completion and a oxid module chain.Ideal for psalm or phpstan

Options

--output-dir|-o

Writes the metadata for PhpStorm to the specified directory.

misc:register:command

Extends the service.yaml file with the commands. So that they are found in oe-console.

Usage

Extends the service.yaml file with the commands. So that they are found in oe-console.

Arguments

command-dir

The folder where the commands are located or Module with option --isModule

Options

--isModule

Just write the Module and the path and the service-yaml will be found automatically.

--service-yaml|-s

The service.yaml file that will be updated (default: var/configuration/configurable_services.yaml)

--yaml-inline|-y

The level where you switch to inline YAML

module:generate

Generates a module skeleton

Usage

Generates a module skeleton

Options

--skeleton|-s

Zip of a Oxid Module Skeleton

--name

Module name

--vendor

Vendor

--description

Description of your Module: OXID eShop Module ...

--author

Author of Module

--email

Email of Author

module:list

Lists all modules

Usage

Lists all modules

deploy:module-activator

Activates multiple modules, based on a YAML file

Usage

usage: oe-console deploy:module-activator modules.yml

Example:

Supports either a "whitelist" and or a "blacklist" entry with multiple shop ids and the desired module ids to activate (whitelist) or to exclude from activation (blacklist).

With "priorities", you can define the order (per subshop) in which the modules will be activated.

If you want, you can also specify a YAML string on the command line instead of a file, e.g.:

Arguments

yaml

YAML module list filename or YAML string. The file path is relative to /var/www/oxid-esale/var/oxrun_config/

Options

--skipDeactivation|-s

Skip deactivation of modules, only activate.

--clearModuleData|-d

Clear module data in oxconfig.

module:reload

Deactivate and activate a module

Usage

Deactivate and activate a module

Arguments

module

Module name

Options

--force-cache|-f

cache:clear with --force option

--skip-cache-clear|-s

skip cache:clear command

--based-on-config|-c

Checks if module is allowed to be reloaded based on the deploy:module-activator yaml file.

oxid:shops

Lists the shops

Usage

Lists the shops

Options

--only-ids|-i

show only Shop id's. eg. "oe-console oxid:shops --only-ids | xargs -tn1 oe-console ... --shop-id "

route:debug

Returns the route. Which controller and parameters are called.

Usage

Returns the route. Which controller and parameters are called.

Arguments

url

Website URL. Full or Path

Options

--copy|-c

Copy file path from the class to the clipboard (only MacOS)

user:create

Creates a new user

Usage

Creates a new user

user:password

Sets a new password

Usage

Sets a new password

Arguments

username

Username

password

New password

views:update

Updates the views

Usage

Updates the views

All versions of oxrun with dependencies

PHP Build Version
Package Version
Requires oxid-esales/oxideshop-ce Version ^v6.5
guzzlehttp/guzzle Version *
nelexa/zip 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 oxidprojects/oxrun contains the following files

Loading the files please wait ....