Drupal\tripal_chado\Controller\ChadoProjectAutocompleteController Class Reference

Inheritance diagram for Drupal\tripal_chado\Controller\ChadoProjectAutocompleteController:

Collaboration diagram for Drupal\tripal_chado\Controller\ChadoProjectAutocompleteController:

Public Member Functions
	handleAutocomplete (Request $request, int $count=5, int $type_id=0)
Public Member Functions inherited from Drupal\tripal_chado\Controller\ChadoGenericAutocompleteController
	handleGenericAutocomplete (Request $request, string $base_table, string $column_name, string $type_column, string $property_table, int $match_limit=10, int $type_id=0,)

Static Public Member Functions
static	getProjectId (string $project)
static	getProjectName (int $project)
Static Public Member Functions inherited from Drupal\tripal_chado\Controller\ChadoGenericAutocompleteController
static	getDefaultOptions ()
static	getQuery (string $string, array $options)
static	getPkeyId (string $value)

Additional Inherited Members
Protected Attributes inherited from Drupal\tripal_chado\Controller\ChadoGenericAutocompleteController
bool	$include_pkey = TRUE
string	$match_operator = 'CONTAINS'
Static Protected Attributes inherited from Drupal\tripal_chado\Controller\ChadoGenericAutocompleteController
static array	$default_options = []

Detailed Description

Controller, Chado Project Autocomplete.

Member Function Documentation

getProjectId()

static Drupal\tripal_chado\Controller\ChadoProjectAutocompleteController::getProjectId ( string  $project )

static

Fetch the project id number, given a project name value.

Parameters

string

$project

Project name value. This table column has a unique constraint, so we are guaranteed either zero or one matches.

Returns

integer Project id number of the project with this name name, or 0 if no matching project record was found.

getProjectName()

static Drupal\tripal_chado\Controller\ChadoProjectAutocompleteController::getProjectName ( int  $project )

static

Fetch the project name, given a project id number.

Parameters

int

$project

Project id number value.

Returns

string Corresponding project name of the project id number, or an empty string if no matching project record was found.

handleAutocomplete()

Drupal\tripal_chado\Controller\ChadoProjectAutocompleteController::handleAutocomplete	(	Request	$request,
		int	$count = 5,
		int	$type_id = 0
	)

Controller method, autocomplete project name.

Parameters

	Request	request
int	$count	Desired number of matching names to suggest. Default to 5 items. Must be declared in autocomplete route parameter i.e. ['count' => 5].
int	$type_id	Project type set in projectprop.type_id to restrict projects to specific type. Default to 0, return projects regardless of type. Must be declared in autocomplete route parameter i.e. ['type_id' => 0].

Returns

Json Object Matching project rows in an array where project name is both the value to the array keys label and value.

---

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

• tripal_chado/src/Controller/ChadoProjectAutocompleteController.php