Drupal\tripal_chado\Form\ChadoManagerForm Class Reference

Inheritance diagram for Drupal\tripal_chado\Form\ChadoManagerForm:

Collaboration diagram for Drupal\tripal_chado\Form\ChadoManagerForm:

Public Member Functions
	getFormId ()
	buildForm (array $form, FormStateInterface $form_state)
	buildMainForm (array $form, FormStateInterface $form_state)
	submitForm (array &$form, FormStateInterface $form_state)
	goBackForm (array &$form, FormStateInterface $form_state)
	validateNewSchemaForm (array &$form, FormStateInterface $form_state)
	buildConfirmForm (array $form, FormStateInterface $form_state)
	buildRenameForm (array $form, FormStateInterface $form_state)
	submitRenameForm (array &$form, FormStateInterface $form_state)
	buildCloneForm (array $form, FormStateInterface $form_state)
	submitCloneForm (array &$form, FormStateInterface $form_state)
	buildUpgradeForm (array $form, FormStateInterface $form_state)
	submitUpgradeForm (array &$form, FormStateInterface $form_state)

Public Attributes
const	RENAME_TASK = 'rename'
const	SET_DEFAULT_TASK = 'set_default'
const	INTEGRATE_TASK = 'integrate'
const	CLONE_TASK = 'clone'
const	DROP_TASK = 'remove'
const	UPGRADE_TASK = 'upgrade'

Protected Member Functions
	setDefaultSchema (string $schema_name)
	runTask (string $task_service, array $parameters, $success_message)
	integrateSchema (string $schema_name)
	dropSchema (string $schema_name)

Detailed Description

Class ChadoManagerForm.

Member Function Documentation

buildCloneForm()

Drupal\tripal_chado\Form\ChadoManagerForm::buildCloneForm	(	array	$form,
		FormStateInterface	$form_state
	)

Builds clone schema form.

Parameters

array	$form	An associative array containing the structure of the form.
\Drupal\Core\Form\FormStateInterface	$form_state	The current state of the form.

buildConfirmForm()

Drupal\tripal_chado\Form\ChadoManagerForm::buildConfirmForm	(	array	$form,
		FormStateInterface	$form_state
	)

Builds a confirmation form.

Parameters

array	$form	An associative array containing the structure of the form.
\Drupal\Core\Form\FormStateInterface	$form_state	The current state of the form.

buildForm()

Drupal\tripal_chado\Form\ChadoManagerForm::buildForm	(	array	$form,
		FormStateInterface	$form_state
	)

{}

buildMainForm()

Drupal\tripal_chado\Form\ChadoManagerForm::buildMainForm	(	array	$form,
		FormStateInterface	$form_state
	)

Builds default form with Chado instance table.

Parameters

array	$form	An associative array containing the structure of the form.
\Drupal\Core\Form\FormStateInterface	$form_state	The current state of the form.

buildRenameForm()

Drupal\tripal_chado\Form\ChadoManagerForm::buildRenameForm	(	array	$form,
		FormStateInterface	$form_state
	)

Builds rename form.

Parameters

array	$form	An associative array containing the structure of the form.
\Drupal\Core\Form\FormStateInterface	$form_state	The current state of the form.

buildUpgradeForm()

Drupal\tripal_chado\Form\ChadoManagerForm::buildUpgradeForm	(	array	$form,
		FormStateInterface	$form_state
	)

Builds upgrade schema form.

Parameters

array	$form	An associative array containing the structure of the form.
\Drupal\Core\Form\FormStateInterface	$form_state	The current state of the form.

dropSchema()

Drupal\tripal_chado\Form\ChadoManagerForm::dropSchema ( string  $schema_name )

protected

Drops the given Chado schema.

Parameters

string

$schema_name

The schema name to drop.

getFormId()

Drupal\tripal_chado\Form\ChadoManagerForm::getFormId

(

)

End of "defgroup chado_manager_form_tasks". {}

goBackForm()

Drupal\tripal_chado\Form\ChadoManagerForm::goBackForm	(	array &	$form,
		FormStateInterface	$form_state
	)

Go back submission.

Parameters

array	$form	An associative array containing the structure of the form.
\Drupal\Core\Form\FormStateInterface	$form_state	The current state of the form.

integrateSchema()

Drupal\tripal_chado\Form\ChadoManagerForm::integrateSchema ( string  $schema_name )

protected

Integrates a Chado schema into Tripal.

Parameters

string

$schema_name

The schema name to integrate to Tripal.

runTask()

Drupal\tripal_chado\Form\ChadoManagerForm::runTask ( string  $task_service, array  $parameters,   $success_message  )

protected

Live-runs a task on a Chado schema.

Parameters

string	$task_service	The name of the task service to use.
array	$parameters	Task parameters.

setDefaultSchema()

Drupal\tripal_chado\Form\ChadoManagerForm::setDefaultSchema ( string  $schema_name )

protected

Sets default Chado schema.

Parameters

string

$schema_name

The schema name that will be used as default Chado schema. It should correspond to an existing Chado instance integrated in Tripal.

submitCloneForm()

Drupal\tripal_chado\Form\ChadoManagerForm::submitCloneForm	(	array &	$form,
		FormStateInterface	$form_state
	)

Submit clone form.

Parameters

array	$form	An associative array containing the structure of the form.
\Drupal\Core\Form\FormStateInterface	$form_state	The current state of the form.

submitForm()

Drupal\tripal_chado\Form\ChadoManagerForm::submitForm	(	array &	$form,
		FormStateInterface	$form_state
	)

{}

submitRenameForm()

Drupal\tripal_chado\Form\ChadoManagerForm::submitRenameForm	(	array &	$form,
		FormStateInterface	$form_state
	)

Submit rename form.

Parameters

array	$form	An associative array containing the structure of the form.
\Drupal\Core\Form\FormStateInterface	$form_state	The current state of the form.

submitUpgradeForm()

Drupal\tripal_chado\Form\ChadoManagerForm::submitUpgradeForm	(	array &	$form,
		FormStateInterface	$form_state
	)

Submit upgrade form.

Parameters

array	$form	An associative array containing the structure of the form.
\Drupal\Core\Form\FormStateInterface	$form_state	The current state of the form.

validateNewSchemaForm()

Drupal\tripal_chado\Form\ChadoManagerForm::validateNewSchemaForm	(	array &	$form,
		FormStateInterface	$form_state
	)

Validates forms that create a new schema.

Parameters

array	$form	An associative array containing the structure of the form.
\Drupal\Core\Form\FormStateInterface	$form_state	The current state of the form.

---

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

• tripal_chado/src/Form/ChadoManagerForm.php