Drupal 8  8.0.2
BanDelete Class Reference
Inheritance diagram for BanDelete:

Public Member Functions

 __construct (BanIpManagerInterface $ip_manager)
 
 getFormId ()
 
 getQuestion ()
 
 getConfirmText ()
 
 getCancelUrl ()
 
 buildForm (array $form, FormStateInterface $form_state, $ban_id= '')
 
 submitForm (array &$form, FormStateInterface $form_state)
 
- Public Member Functions inherited from ConfirmFormBase
 getDescription ()
 
 getConfirmText ()
 
 getCancelText ()
 
 getFormName ()
 
 buildForm (array $form, FormStateInterface $form_state)
 
- Public Member Functions inherited from FormInterface
 validateForm (array &$form, FormStateInterface $form_state)
 

Static Public Member Functions

static create (ContainerInterface $container)
 

Protected Attributes

 $banIp
 

Detailed Description

Provides a form to unban IP addresses.

Constructor & Destructor Documentation

__construct ( BanIpManagerInterface  $ip_manager)

Constructs a new BanDelete object.

Parameters
\Drupal\ban\BanIpManagerInterface$ip_managerThe IP manager.

Member Function Documentation

buildForm ( array  $form,
FormStateInterface  $form_state,
  $ban_id = '' 
)

{}

Parameters
string$ban_idThe IP address record ID to unban.
static create ( ContainerInterface  $container)
static

{}

getCancelUrl ( )

{Returns the route to go to if the user cancels the action.

Returns
A URL object.
}

Implements ConfirmFormInterface.

Referenced by BanDelete\submitForm().

Here is the caller graph for this function:

getConfirmText ( )

{Returns a caption for the button that confirms the action.

Returns
string The form confirmation text.
}

Implements ConfirmFormInterface.

References t().

Here is the call graph for this function:

getFormId ( )

{Returns a unique string identifying the form.

Returns
string The unique string identifying the form.
}

Implements FormInterface.

getQuestion ( )

{Returns the question to ask the user.

Returns
string The form question. The page title will be set to this value.
}

Implements ConfirmFormInterface.

References t().

Here is the call graph for this function:

submitForm ( array &  $form,
FormStateInterface  $form_state 
)

{Form submission handler.

Parameters
array$formAn associative array containing the structure of the form.
\Drupal\Core\Form\FormStateInterface$form_stateThe current state of the form.
}

Implements FormInterface.

References BanDelete\getCancelUrl(), Drupal\logger(), FormStateInterface\setRedirectUrl(), and t().

Here is the call graph for this function:


The documentation for this class was generated from the following file: