<?php
declare(strict_types=1);
namespace yii\gitea\models;

use yii\base\{Model};

/**
 * Represents the GPG verification of a commit.
 */
class PayloadCommitVerification extends Model {

  /**
   * @var bool Value indicating whether the verification has succeeded.
   */
  public $isVerified = false;

  /**
   * @var string A custom message sent with the verification request.
   */
  public $payload = '';

  /**
   * @var string A message providing details about the verification.
   */
  public $reason = '';

  /**
   * @var string The signing key used for the verification.
   */
  public $signature = '';

  /**
   * Creates a new commit from the specified JSON map.
   * @param object $map A JSON map representing a commit.
   * @return static The instance corresponding to the specified JSON map.
   */
  static function fromJson(object $map): self {
    return new static([
      'isVerified' => isset($map->verified) && is_bool($map->verified) ? $map->verified : false,
      'payload' => isset($map->payload) && is_string($map->payload) ? $map->payload : '',
      'reason' => isset($map->reason) && is_string($map->reason) ? $map->reason : '',
      'signature' => isset($map->signature) && is_string($map->signature) ? $map->signature : ''
    ]);
  }

  /**
   * Returns the list of fields that should be returned by default.
   * @return array The list of field names or field definitions.
   */
  function fields(): array {
    return [
      'payload',
      'reason',
      'signature',
      'verified' => 'isVerified'
    ];
  }

  /**
   * Returns the validation rules for attributes.
   * @return array[] The validation rules.
   */
  function rules(): array {
    return [
      [['payload', 'reason', 'signature'], 'trim'],
      ['isVerified', 'boolean', 'falseValue' => false, 'trueValue' => true]
    ];
  }
}