Magento 2 Documentation  2.3
Documentation for Magento 2 CMS v2.3 (December 2018)
Public Member Functions
ConnectionValidator Class Reference

Public Member Functions

 __construct (ConnectionFactory $connectionFactory)
 
 isConnectionValid ( $host, $port, $user, $password='', $virtualHost='', bool $ssl=false, array $sslOptions=null)
 

Detailed Description

Class ConnectionValidator - validates Amqp related settings

Definition at line 14 of file ConnectionValidator.php.

Constructor & Destructor Documentation

◆ __construct()

__construct ( ConnectionFactory  $connectionFactory)
Parameters
ConnectionFactory$connectionFactory

Definition at line 24 of file ConnectionValidator.php.

25  {
26  $this->connectionFactory = $connectionFactory;
27  }

Member Function Documentation

◆ isConnectionValid()

isConnectionValid (   $host,
  $port,
  $user,
  $password = '',
  $virtualHost = '',
bool  $ssl = false,
array  $sslOptions = null 
)

Checks Amqp Connection

Parameters
string$host
string$port
string$user
string$password
string$virtualHost
bool$ssl
string[]|null$sslOptions
Returns
bool true if the connection succeeded, false otherwise

Definition at line 41 of file ConnectionValidator.php.

49  {
50  try {
51  $options = new FactoryOptions();
52  $options->setHost($host);
53  $options->setPort($port);
54  $options->setUsername($user);
55  $options->setPassword($password);
56  $options->setVirtualHost($virtualHost);
57  $options->setSslEnabled($ssl);
58 
59  if ($sslOptions) {
60  $options->setSslOptions($sslOptions);
61  }
62 
63  $connection = $this->connectionFactory->create($options);
64 
65  $connection->close();
66  } catch (\Exception $e) {
67  return false;
68  }
69 
70  return true;
71  }
$user
Definition: dummy_user.php:13
$connection
Definition: bulk.php:13

The documentation for this class was generated from the following file: