Download the PHP package cymapgt/console without Composer

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

console

package for exposing PHP services via a console interface, providing build in authentication if needed

Description

The console package allows other packages to implement an interface that allows them to provide command line functionality to their classes in with minimal duplication of code. A NetConsoleInterface aware class can be registered to the console API; which offers among other things automatic help generation as well as an authentication interface prior to accessing registered namespaces.

Installing

Install application via Composer

require "cymapgt/console" : "^1.0.0"

Usage

Overview

Using the Console package

Writing a NetConsole aware class

The package comes with two demo Classes that implement the NetConsoleInterface. See the files src/DemoApi.php and src/DemoRpi.php for template which you can use to implement your NetConsole class. Copy the files and customize as required.

Authentication to NetConsole

The default NetConsole authentication comes with some assumptions:

1.You auth data store is a database, with a table named user; and fields for username and password

2.You have an active user named console in the datastore

If you adhere to the above, your console authentication will work out of the box (assuming as well that the NetworkBootstrap is properly configured).

If you would like to implement your own Authentication, replace the file src/helper/ConsoleCredentials.php and in it

1.Create a class named ConsoleCredentials

2.Creat a public static method named authenticate() that will implement your custom authentication logic

Core NetConsole Commands

The core of NetConsole implements the NetConsoleInterface. There are a number of reserved keywords:

1.ADD COMMAND:

add serviceName serviceNamespace

COMMANDS AND SWITCHES:

COMMANDS

serviceName - The name of the service as registered in the console, or one of the sticky services.

serviceNamespace - The fully qualified namespace for the service being registered to the netconsole API

SWITCHES

None

EXAMPLE:

add bootstrap cymapgt\core\utility\bootstrap\console\BootstrapConsole;

2.HELP COMMAND:

help serviceName [-v="..."] [-m="..."]

COMMANDS AND SWITCHES:

COMMANDS

serviceName - The name of the service as registered in the console, or one of the sticky services.

SWITCHES

-v - The verbosity level of the help documentation

-m - Specifying a method name here will filter the help to provide only docs for that specific method

EXAMPLES

help bootstrap -m=config-all -v=3

help add

3.REMOVE COMMAND:

remove serviceName

COMMANDS AND SWITCHES:

COMMANDS

serviceName - The name of the service as registered in the console, or one of the sticky services.

SWITCHES

None

EXAMPLE:

remove bootstrap

4.QUIT COMMAND:

quit

COMMANDS AND SWITCHES:

COMMANDS

None

SWITCHES

None

EXAMPLE:

quit

5.CUSTOM COMMANDS:

Your PHP services functionality is exposed by implementing the NetConsoleInterface

After this implementation, you need to register your package with NetConsole by using the add command.

Successfully adding the package will expose all of the commands and switches you defined in the console configuration. The package can thus be used for managing tasks such as application installations within a controlled environment if you are distributing your proprietary logic.

It can also be used to quickly convert PHP services to console applications.

Testing

PHPUnit Tests are provided with the package

Contribute

License

BSD 3-clause


All versions of console with dependencies

PHP Build Version
Package Version
Requires php Version >=7.2.0
doctrine/orm Version ~2.6.0
hoa/console Version ~3.0
cymapgt/logger Version ^3.0.0
cymapgt/db Version ^3.0.0
cymapgt/usercredential Version ^3.0.0
cymapgt/validator Version ^3.0.0
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 cymapgt/console contains the following files

Loading the files please wait ....