Componentes

Os componentes do Shieldon são conjuntos de controladores que permitem adicionar regras personalizadas para permitir ou negar antes de detectar o comportamento do usuário.

TrustedBot

O componente TrustedBot permite que os mecanismos de busca populares acessem seu site sem limites. Carregue esse componente pelo menos.

Ip

O componente Ip permite definir IPs únicos ou intervalos de IP na lista branca ou na lista negra.

UserAgent

O componente UserAgent bloqueia os bots maliciosos conhecidos por padrão. Você pode adicionar sua lista na lista negra do UserAgent.

Header

O componente Header bloqueia visitantes sem informações de cabeçalho comum no modo restrito.

Rdns

O componente Rdns bloqueia visitantes sem registro Rdns ou quando o Rdns não corresponde ao endereço IP no modo restrito.

setStrict($bool)

  • param bool $bool - Defina como true para habilitar o modo restrito e false para desabilitá-lo.
  • return void
$component->setStrict(true);

Trait de Negado (Denied Trait)

  • setDeniedItem
  • setDeniedItems
  • getDeniedItem
  • getDeniedItems
  • removeDeniedItem
  • removeDeniedItems
  • hasDeniedItem
  • getDenyWithPrefix
  • removeDenyWithPrefix
  • isDenied

setDeniedItem($value, $key)

  • param string|array $value - O valor dos dados.
  • param string $key - A chave dos dados.
  • return void

Adiciona um item à lista negra.

Exemplo:

$component->setDeniedItem($string);

setDeniedItems($itemList)

  • param array $itemList - Lista de strings.
  • return void

Adiciona itens à lista negra.

Exemplo:

$component->setDeniedItems($stringList);

getDeniedItem($key)

  • param string $key - A chave do campo de dados.
  • return string|array

Obtém um item da lista negra.

Exemplo:

$item = $component->getDeniedItems('this_item');

getDeniedItems()

  • return array

Obtém os itens da lista negra.

$list = $component->getDeniedItems();

removeDeniedItem($key)

  • param string $key - A chave dos dados.
  • return void

Remove um item negado se existir.

$component->removeDeniedItem($string);

removeDeniedItems()

  • return void

Remove todos os itens negados.

$component->removeDeniedItems();

hasDeniedItem($key)

  • param string $key - A chave dos dados.
  • return bool

Verifica se um item negado existe.

Exemplo:

if ($component->hasDeniedItem('test')) {
    echo 'item existe';
} else {
    echo 'item não existe';
}

getDenyWithPrefix($key)

  • param string $key - A chave dos dados.
  • return array

Verifica se existem itens negados com o mesmo prefixo.

Exemplo:

$deniedList = $component->getDenyWithPrefix('test');

removeDenyWithPrefix($key)

  • param string $key - A chave dos dados.
  • return void

Remove itens negados com o mesmo prefixo.

$component->removeDenyWithPrefix('test');

isDenied()

  • return bool

Este método deve ser ajustado na classe estendida, se necessário.


if ($component->isDenied()) {
    echo 'Este usuário foi negado.';
}

Trait de Permitido (Allowed Trait)

  • setAllowedItem
  • setAllowedItems
  • getAllowedItem
  • getAllowedItems
  • removeAllowedItem
  • removeAllowedItems
  • hasAllowedItem
  • getDenyWithPrefix
  • removeDenyWithPrefix
  • isAllowed

setAllowedItem($value, $key)

  • param string|array $value - O valor dos dados.
  • param string $key - A chave dos dados.
  • return void

Adiciona um item à lista branca.

Exemplo:

$component->setAllowedItem($string);

setAllowedItems($itemList)

  • param array $itemList - Lista de strings.
  • return void

Adiciona itens à lista branca.

Exemplo:

$component->setAllowedItems($stringList);

getAllowedItem($key)

  • param string $key - A chave do campo de dados.
  • return string|array

Obtém um item da lista branca.

Exemplo:

$item = $component->getAllowedItems('this_item');

getAllowedItems()

  • return array

Obtém os itens da lista branca.

$list = $component->getAllowedItems();

removeAllowedItem($key)

  • param string $key - A chave dos dados.
  • return void

Remove um item permitido se existir.

$component->removeAllowedItem($string);

removeAllowedItems()

  • return void

Remove todos os itens permitidos.

$component->removeAllowedItems();

hasAllowedItem($key)

  • param string $key - A chave dos dados.
  • return bool

Verifica se um item permitido existe.

Exemplo:

if ($component->hasAllowedItem('test')) {
    echo 'item existe';
} else {
    echo 'item não existe';
}

getDenyWithPrefix($key)

  • param string $key - A chave dos dados.
  • return array

Verifica se um item permitido existe com o mesmo prefixo.

Exemplo:

$allowedList = $component->getDenyWithPrefix('test');

removeDenyWithPrefix($key)

  • param string $key - A chave dos dados.
  • return void

Remove itens permitidos com o mesmo prefixo.

$component->removeDenyWithPrefix('test');

isAllowed()

  • return bool

Este método deve ser ajustado na classe estendida, se necessário.


if ($component->isAllowed()) {
    echo 'Este usuário foi permitido.';
}