mazahaler/project-connection-checker

该扩展允许检查数据库连接、邮件操作和secrets.json文件的合规性

1.0.1 2021-04-02 08:09 UTC

This package is auto-updated.

Last update: 2024-09-12 14:30:22 UTC


README

该扩展允许检查项目的secrets.json文件和secrets的合规性,同时也允许检查数据库连接和邮件操作。

要求

  • PHP 7.4.及以上;
  • Yii 2.0.及以上。

安装

安装此扩展的首选方式是通过composer

运行以下命令

php composer.phar require --prefer-dist mazahaler/project-connection-checker

或将其添加到composer.json文件的require部分:

"mazahaler/project-connection-checker": "*"

```

使用方法

<?php

use mazahaler\ProjectConnectionChecker\ProjectConnectionChecker;

/**
* Check secrets, db connections and mailing
 * @param 1: Root path of the project
 * @param 2: Path to secrets.json
 * @param 3: \yii\swiftmailer\Mailer class
 * @param 4: Array of db connections in format: ['Your connection title(used for error output)' => [Instance of \yii\db\Connection | \yii\mongodb\Connection]]
 */
ProjectConnectionChecker::checkAll(\Yii::getAlias('@app'), \Yii::getAlias('@app') . '/secrets/secrets.json', \Yii::$app->mailer, ['mysql' => [\Yii::$app->db], 'mongodb' => [\Yii::$app->mongodb]]);

// OR check it separately:

ProjectConnectionChecker::checkSecrets(\Yii::getAlias('@app'), \Yii::getAlias('@app') . '/secrets/secrets.json');

ProjectConnectionChecker::checkMailing(\Yii::$app->mailer);

ProjectConnectionChecker::checkConnections(['mysql' => [\Yii::$app->db], 'mongodb' => [\Yii::$app->mongodb]]);