Overview

Namespaces

  • AnalyseModule
    • Models
  • BaseModule
    • Exceptions
    • Models
    • Repository
    • Services
  • DispatchModule
    • Helpers
    • Models
    • Tools
  • PredictModule
  • SearchModule

Classes

  • AnnotationDbTool
  • BaseTool
  • Cppredict2Tool
  • DbTool
  • SimilarityTool
  • TaxonomyDbTool

Interfaces

  • ToolInterface
  • Overview
  • Namespace
  • Class

Class BaseTool

BaseTool contains default implementation of some mandatory tool methods - serves only as a helper (reduces code duplicity)

Nette\Object
Extended by BaseModule\Services\BaseService
Extended by DispatchModule\Tools\BaseTool

Direct known subclasses

BaseModule\Services\DbService, DispatchModule\Tools\Cppredict2Tool, DispatchModule\Tools\DbTool, DispatchModule\Tools\SimilarityTool

Indirect known subclasses

DispatchModule\Tools\AnnotationDbTool, DispatchModule\Tools\TaxonomyDbTool
Abstract
Namespace: DispatchModule\Tools
Located at DispatchModule/BaseTool.php
Methods summary
public boolean
# used( )

Tells whether any sequence is set

Tells whether any sequence is set

Returns

boolean
public boolean
# requireParameter( string $parameter )

Indicates, whether tool needs parameter with specified name

Indicates, whether tool needs parameter with specified name

Parameters

$parameter
name

Returns

boolean
true, if specified parameter is required by the tool
public string
# getName( )

Gets lowercase tool class name without postfix (so for "BaseTool", "base" is returned)

Gets lowercase tool class name without postfix (so for "BaseTool", "base" is returned)

Returns

string
lowercased tool name without postfix
public array
# getWantedParameters( )

Get parameters, that tool wants

Get parameters, that tool wants

Returns

array
array of wanted parameters (indexed by its name)
Methods inherited from BaseModule\Services\BaseService
__construct()
Properties summary
protected array $wantedParameters

List of all wanted parameters by the tool in format 'parameterName' => array('parameterType', 'parameterLabel', possiblyAnotherOptions) parameterType depends on \Base\Form

List of all wanted parameters by the tool in format 'parameterName' => array('parameterType', 'parameterLabel', possiblyAnotherOptions) parameterType depends on \Base\Form

# array()
public string $description

Short description of the tool

Short description of the tool

#
public string $fileName

Default file name for tool temp files (without ext)

Default file name for tool temp files (without ext)

#
public array $completeData

additional data for tool (basically data collected from POST of HTTP request)

additional data for tool (basically data collected from POST of HTTP request)

#
Properties inherited from BaseModule\Services\BaseService
$container
API documentation generated by ApiGen