Check.php

Go to the documentation of this file.

<?php

namespace Rsi\Fred\Security;

abstract class Check extends \Rsi\Fred\Component{

  public $delay = null; //!< Time (seconds) a ban stays in the registry (empty = use default).

  /**
   * Perform the check.
   * @param bool $expected  True if this is an expected call.
   * @return bool  True if everything is fine. False if something is wrong. Null if something is wrong, but it is not
   *   significant enough to add a ban for it (e.g. repeated error).
   */
  abstract public function check($expected = false);

  public function clientConfig(){
    return [];
  }
  /**
   * Unban a client's IP address.
   * @param string $addr
   * @return bool  True if he ban was successful deleted.
   */
  public function unBan($addr){
    return true;
  }

}