Merge branch 'dev-anno' into dev-5

baserproject · Oct 20, 2023 · 83a2ad1 · 83a2ad1
2 parents bb08295 + 3189ed6
commit 83a2ad1
Show file tree

Hide file tree

Showing 20 changed files with 185 additions and 90 deletions.
diff --git a/plugins/bc-mail/src/Controller/Admin/MailConfigsController.php b/plugins/bc-mail/src/Controller/Admin/MailConfigsController.php
@@ -11,20 +11,24 @@
 
 namespace BcMail\Controller\Admin;
 
-use BaserCore\Utility\BcUtil;
 use BcMail\Service\MailConfigsServiceInterface;
+use Psr\Http\Message\ResponseInterface;
+use BaserCore\Annotation\UnitTest;
+use BaserCore\Annotation\NoTodo;
+use BaserCore\Annotation\Checked;
 
 /**
  * メールフォーム設定コントローラー
- *
  */
 class MailConfigsController extends MailAdminAppController
 {
 
     /**
      * [ADMIN] メールフォーム設定
      *
-     * @return void
+     * @return void|ResponseInterface
+     * @checked
+     * @noTodo
      */
     public function index(MailConfigsServiceInterface $service)
     {

diff --git a/plugins/bc-mail/src/Controller/Admin/MailFieldsController.php b/plugins/bc-mail/src/Controller/Admin/MailFieldsController.php
@@ -51,6 +51,8 @@ public function initialize(): void
      * beforeFilter
      *
      * @return void
+     * @checked
+     * @noTodo
      */
     public function beforeFilter(EventInterface $event)
     {
@@ -73,6 +75,8 @@ public function beforeFilter(EventInterface $event)
 
     /**
      * プラグインの環境をチェックする
+     * @checked
+     * @noTodo
      */
     protected function _checkEnv()
     {

diff --git a/plugins/bc-mail/src/Controller/Admin/MailMessagesController.php b/plugins/bc-mail/src/Controller/Admin/MailMessagesController.php
@@ -51,6 +51,8 @@ public function initialize(): void
      * beforeFilter
      *
      * @return void
+     * @checked
+     * @noTodo
      */
     public function beforeFilter(EventInterface $event)
     {
@@ -152,6 +154,10 @@ public function delete(
 
     /**
      * メールフォームに添付したファイルを開く
+     * @param MailMessagesServiceInterface $service
+     * @return void
+     * @checked
+     * @noTodo
      */
     public function attachment(MailMessagesServiceInterface $service)
     {
@@ -179,6 +185,8 @@ public function attachment(MailMessagesServiceInterface $service)
      *
      * @param int $mailContentId
      * @return void
+     * @checked
+     * @noTodo
      */
     public function download_csv(MailMessagesAdminServiceInterface $service, int $mailContentId)
     {

diff --git a/plugins/bc-mail/src/Controller/Api/MailMessagesController.php b/plugins/bc-mail/src/Controller/Api/MailMessagesController.php
@@ -29,6 +29,14 @@
 class MailMessagesController extends BcApiController
 {
 
+    /**
+     * Before Filter
+     *
+     * @param EventInterface $event
+     * @return \Cake\Http\Response|void
+     * @checked
+     * @noTodo
+     */
     public function beforeFilter(EventInterface $event)
     {
         $this->Security->setConfig('validatePost', false);

diff --git a/plugins/bc-mail/src/Controller/MailController.php b/plugins/bc-mail/src/Controller/MailController.php
@@ -27,6 +27,7 @@
 use BaserCore\Annotation\UnitTest;
 use BaserCore\Annotation\NoTodo;
 use BaserCore\Annotation\Checked;
+use Psr\Http\Message\ResponseInterface;
 
 /**
  * お問い合わせメールフォーム用コントローラー
@@ -68,6 +69,7 @@ public function initialize(): void
      * beforeFilter.
      *
      * @return void
+     * @checked
      */
     public function beforeFilter(EventInterface $event)
     {
@@ -80,6 +82,7 @@ public function beforeFilter(EventInterface $event)
         $mailMessagesService = $this->getService(MailMessagesServiceInterface::class);
         $mailMessagesService->MailMessages->setup($this->request->getParam('entityId'), $this->getRequest()->getData());
 
+        // TODO ucmitz 未確認
         return;
         $this->dbDatas['mailContent'] = $this->MailMessage->mailContent;
         $this->dbDatas['mailFields'] = $this->MailMessage->mailFields;
@@ -115,6 +118,7 @@ public function beforeFilter(EventInterface $event)
      * beforeRender
      *
      * @return void
+     * @checked
      */
     public function beforeRender(EventInterface $event): void
     {
@@ -320,7 +324,11 @@ public function submit(
     /**
      * [PUBIC] メール送信完了
      *
-     * @return void
+     * @param MailFrontServiceInterface $service
+     * @param MailContentsServiceInterface $mailContentsService
+     * @return void|ResponseInterface
+     * @checked
+     * @noTodo
      */
     public function thanks(MailFrontServiceInterface $service, MailContentsServiceInterface $mailContentsService)
     {
@@ -342,7 +350,11 @@ public function thanks(MailFrontServiceInterface $service, MailContentsServiceIn
     /**
      * 認証用のキャプチャ画像を表示する
      *
+     * @param BcCaptchaServiceInterface $service
+     * @param string $token
      * @return void
+     * @checked
+     * @noTodo
      */
     public function captcha(BcCaptchaServiceInterface $service, string $token)
     {

diff --git a/plugins/bc-mail/src/Model/Entity/MailContent.php b/plugins/bc-mail/src/Model/Entity/MailContent.php
@@ -58,6 +58,8 @@ class MailContent extends Entity
      * メッセージ件数を取得する
      *
      * @return int
+     * @checked
+     * @noTodo
      */
     public function getNumberOfMessages()
     {

diff --git a/plugins/bc-mail/src/Model/Table/MailContentsTable.php b/plugins/bc-mail/src/Model/Table/MailContentsTable.php
@@ -90,6 +90,8 @@ public function initialize(array $config): void
      *
      * @param Validator $validator
      * @return Validator
+     * @checked
+     * @noTodo
      */
     public function validationDefault(Validator $validator): Validator
     {
@@ -176,6 +178,8 @@ public function validationDefault(Validator $validator): Validator
      *
      * @param array $check チェック対象文字列
      * @return boolean
+     * @checked
+     * @noTodo
      */
     public function checkSslUrl($value)
     {
@@ -256,9 +260,10 @@ public function createSearchIndex($data)
      * @param int $newAuthorId 新しいユーザーID
      * @param int $newSiteId 新しいサイトID
      * @return mixed mailContent|false
+     * @checked
      */
     public function copy(
-        int $id,
+        ?int $id,
         int $newParentId,
         string $newTitle,
         int $newAuthorId,

diff --git a/plugins/bc-mail/src/Model/Table/MailFieldsTable.php b/plugins/bc-mail/src/Model/Table/MailFieldsTable.php
@@ -11,6 +11,7 @@
 
 namespace BcMail\Model\Table;
 
+use BcMail\Model\Entity\MailField;
 use Cake\Datasource\EntityInterface;
 use Cake\Validation\Validator;
 use BaserCore\Annotation\UnitTest;
@@ -49,9 +50,10 @@ public function initialize(array $config): void
     /**
      * MailField constructor.
      *
-     * @param bool $id
-     * @param null $table
-     * @param null $ds
+     * @param Validator $validator
+     * @return Validator
+     * @checked
+     * @noTodo
      */
     public function validationDefault(Validator $validator): Validator
     {
@@ -142,6 +144,8 @@ public function validationDefault(Validator $validator): Validator
      *
      * @param string $field
      * @return array source
+     * @checked
+     * @noTodo
      */
     public function getControlSource($field = null)
     {
@@ -188,6 +192,8 @@ public function getControlSource($field = null)
      * @param string $value
      * @param array $context
      * @return boolean
+     * @checked
+     * @noTodo
      */
     public function duplicateMailField(string $value, array $context)
     {
@@ -210,6 +216,8 @@ public function duplicateMailField(string $value, array $context)
      *
      * @param string $value
      * @return boolean
+     * @checked
+     * @noTodo
      */
     public function halfTextMailField(string $value)
     {
@@ -223,6 +231,8 @@ public function halfTextMailField(string $value)
      * @param string $value
      * @param array $context
      * @return bool
+     * @checked
+     * @noTodo
      */
     public function sourceMailField(string $value, array $context)
     {
@@ -240,13 +250,13 @@ public function sourceMailField(string $value, array $context)
      * フィールドデータをコピーする
      *
      * @param int $id
-     * @param array $data
+     * @param MailField $data
      * @param array $options
      * @return EntityInterface|false
      * @checked
      * @noTodo
      */
-    public function copy($id, $data = null, $options = [])
+    public function copy(?int $id, MailField $data = null, array $options = [])
     {
         $options = array_merge([
             'sortUpdateOff' => false,
@@ -303,6 +313,8 @@ public function copy($id, $data = null, $options = [])
      * | の対応は後方互換として残しておく
      * @param string $source 選択リストソース
      * @return string 整形後選択リストソース
+     * @checked
+     * @noTodo
      */
     public function formatSource($source)
     {

diff --git a/plugins/bc-mail/src/Model/Table/MailMessagesTable.php b/plugins/bc-mail/src/Model/Table/MailMessagesTable.php
@@ -119,6 +119,8 @@ public function setMailFields(int $mailContentId)
      *
      * @param Validator $validator
      * @return Validator
+     * @checked
+     * @noTodo
      */
     public function validationDefault(Validator $validator): Validator
     {
@@ -187,6 +189,9 @@ public function setupUpload(int $mailContentId)
      * After Marshal
      *
      * @param Event $event
+     * @return void
+     * @checked
+     * @noTodo
      */
     public function afterMarshal(Event $event)
     {
@@ -490,6 +495,8 @@ public function convertToDb(ResultSetInterface $mailFields, EntityInterface $mai
      *
      * @param array $dbDatas
      * @return array $dbDatas
+     * @checked
+     * @noTodo
      * @TODO ヘルパー化すべきかも
      */
     public function convertDatasToMail($data, $options)
@@ -540,11 +547,12 @@ public function createFullTableName($mailContentId)
     /**
      * 受信メッセージの内容を表示状態に変換する
      *
-     * @param int $id
-     * @param $messages
+     * @param array $messages
      * @return array
+     * @checked
+     * @noTodo
      */
-    public function convertMessageToCsv($messages)
+    public function convertMessageToCsv(array $messages)
     {
         // フィールド名とデータの変換に必要なヘルパーを読み込む
         $maildataHelper = new MaildataHelper(new View());

diff --git a/plugins/bc-mail/src/Model/Validation/MailMessageValidation.php b/plugins/bc-mail/src/Model/Validation/MailMessageValidation.php
@@ -27,6 +27,7 @@ class MailMessageValidation extends Validation
      * 文字列日付チェック
      *
      * @return bool
+     * @checked
      * @unitTest
      * @noTodo
      */

diff --git a/plugins/bc-mail/src/Plugin.php b/plugins/bc-mail/src/Plugin.php
@@ -24,30 +24,6 @@
  */
 class Plugin extends BcPlugin
 {
-    /**
-     * プラグインをインストールする
-     *
-     * @param array $options
-     *  - `plugin` : プラグイン名
-     *  - `connection` : コネクション名
-     */
-    public function install($options = []) : bool
-    {
-        // ここに必要なインストール処理を記述
-        return parent::install($options);
-    }
-
-    /**
-     * プラグインをアンインストールする
-     *  - `plugin` : プラグイン名
-     *  - `connection` : コネクション名
-     *  - `target` : ロールバック対象バージョン
-     */
-    public function uninstall($options = []): bool
-    {
-        // ここに必要なアンインストール処理を記述
-        return parent::uninstall();
-    }
 
     /**
      * services

diff --git a/plugins/bc-mail/src/Service/Admin/MailMessagesAdminService.php b/plugins/bc-mail/src/Service/Admin/MailMessagesAdminService.php
@@ -80,13 +80,15 @@ public function getViewVarsForView(int $mailContentId, int $mailMessageId)
      * @param ServerRequest $request
      * @return array
      * @unitTest
+     * @checked
+     * @noTodo
      */
     public function getViewVarsForDownloadCsv(int $mailContentId, ServerRequest $request)
     {
         $this->setup($mailContentId);
         return [
             'encoding' => $request->getQuery('encoding') ?? 'utf-8',
-            'messages' => $this->MailMessages->convertMessageToCsv($this->getIndex()->all()),
+            'messages' => $this->MailMessages->convertMessageToCsv($this->getIndex()->all()->toArray()),
             'contentName' => $request->getAttribute('currentContent')->name,
         ];
     }

diff --git a/plugins/bc-mail/src/Service/Front/MailFrontService.php b/plugins/bc-mail/src/Service/Front/MailFrontService.php
@@ -157,6 +157,8 @@ public function getViewVarsForConfirm(EntityInterface $mailContent, EntityInterf
      * @param array $postData
      * @return EntityInterface
      * @unitTest
+     * @checked
+     * @noTodo
      */
     public function confirm(EntityInterface $mailContent, array $postData): EntityInterface
     {
@@ -304,6 +306,8 @@ public function getUserMail(ResultSetInterface $mailFields, EntityInterface $mai
      * @param EntityInterface $mailMessage
      * @return array
      * @unitTest
+     * @checked
+     * @noTodo
      */
     public function getAttachments(ResultSetInterface $mailFields, EntityInterface $mailMessage): array
     {

diff --git a/plugins/bc-mail/src/Service/MailContentsService.php b/plugins/bc-mail/src/Service/MailContentsService.php
@@ -255,6 +255,8 @@ public function copy($postData)
      * @param int|null $siteId
      * @return \Cake\Datasource\ResultSetInterface
      * @unitTest
+     * @checked
+     * @noTodo
      */
     public function getPublishedAll(int $siteId = null)
     {