Download the PHP package perfect-code/module-verify-connection-button without Composer

On this page you can find all versions of the php package perfect-code/module-verify-connection-button. 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?

Example code of perfect-code/module-verify-connection-button

Informations about the package module-verify-connection-button

Overview

This module helps you to add to your stores/configuration section button to check some connection with some system.

Usage

There are two ways how to use this module. Here is comparison between two possible ways. It's up to you which to use.

Step Easy and Quick More Scalable Way Description
Implement an AdapterInterface + + All in all you need to create an Adapter to verify the connection.
Create routes.xml +
Create controller + It will be an empty controller extended from original. Further injection will be inside di.xml
Inject Adapter implementation + + In easy way we use Original block and controller. In second way we use new created controller and virtual block.
Use block in config + + In first way we use original block. In second - virtual.

Easy and quick start.

Useful for cases when you simply need only one button in your store. And you do not worry about perfect code.

To add a validation button, you need:

1. Implement AdapterInterface.

Implement an interface where you make an attempt to establish a connection with the service you need. Examples of fields usage are described in comments to this file.

2. Inject implementation from the previous step.

Then add your Service Connector (Adapter) to etc/adminhtml/di.xml

3. Use the block from this module in your config.

Add the button to your etc/adminhtml/system.xml

Alternative (more dependency inversion principle way)

According to soli[D] - DIP we need to work with abstractions. That's why I would recommend creating your own controller and create your own block.

1. Implement AdapterInterface.

Implement an interface where you make an attempt to establish a connection with the service you need. Examples of fields usage are described in comments to this file.

2. Create routes configuration.

Create etc/adminhtml/routes.xml

3. Create your controller and extend from existing.

Your controller can be empty like this one below (we will inject our Adapter through di.xml)

4. Inject dependencies using di.xml

This will be almost the same as in 'Easy Way'. The only thing - we will use our own controller. It's unable to be done via "virtual controller", because magento need its physical persistence. More info can be found here: \Magento\Framework\App\Router\ActionList::validateActionClass.

We still need to inject our Adapter. Of course this can be done in your PHP class (but in my vision this is more DIP way).

Do not forget to pass your new controller action to the block which is virtual now (module/controller/action).

5. Use our virtual block in configuration.

Add the button to your etc/adminhtml/system.xml Pay attention. Not real but virtual block.

All versions of module-verify-connection-button with dependencies

PHP Build Version
Package Version
Requires php Version ^8.1
magento/framework Version *
magento/module-backend Version *
magento/module-config Version *
magento/magento-composer-installer 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 perfect-code/module-verify-connection-button contains the following files

Loading the files please wait ....