Class AnalysisSetting

An AnalysisSetting is a complete set of analysis parameters.

hrm\setting\base\Setting

Extended by

hrm\setting\AnalysisSetting

Direct known subclasses

hrm\setting\JobAnalysisSetting

Namespace: hrm\setting
Package: hrm
Located at setting/AnalysisSetting.php

Methods summary

`public`	# `__construct( )` AnalysisSetting constructor. AnalysisSetting constructor.
`public static string`	# `table( )` Returns the name of the database table in which the list of Setting names are stored. Returns the name of the database table in which the list of Setting names are stored. Besides the name, the table contains the Setting's name, owner and the standard (default) flag. Returns string The table name. Throws Exception This method must be reimplemented. Overrides `hrm\setting\base\Setting::table`
`public static string`	# `sharedTable( )` Returns the name of the database table in which the list of shared Setting names are stored. Returns the name of the database table in which the list of shared Setting names are stored. Returns string The shared table name.
`public static string`	# `parameterTable( )` Returns the name of the database table in which all the Parameters for the Settings stored in the table specified in table(). Returns the name of the database table in which all the Parameters for the Settings stored in the table specified in table(). Returns string The parameter table name. Throws Exception This method must be reimplemented. See `hrm\setting\AnalysisSetting::table()` Overrides `hrm\setting\base\Setting::parameterTable`
`public static string`	# `sharedParameterTable( )` Returns the name of the database table to use for sharing settings. Returns the name of the database table to use for sharing settings. Returns string The shared parameter table name. See `hrm\setting\AnalysisSetting::sharedTable()`
`public boolean`	# `checkPostedAnalysisParameters( array $postedParameters )` Checks that the posted analysis Parameters are all defined and valid. Checks that the posted analysis Parameters are all defined and valid. Parameters `$postedParameters` The array of posted parameters. Returns boolean True if all Parameters are defined and valid, false otherwise.
`public integer`	# `numberOfChannels( )` Returns the number of channels of the Setting Returns the number of channels of the Setting Returns integer The number of channels for the Setting.
`public string`	# `displayString( integer $numberOfChannels = 0, string\|null $micrType = NULL )` Displays the setting as a text containing Parameter names and their values. Displays the setting as a text containing Parameter names and their values. Parameters `$numberOfChannels` Number of channels (ignored). `$micrType` Microscope type (ignored). Returns string Parameter names and their values as a string.
`public static array`	# `getTemplatesSharedWith( string $username )` Get the list of templates shared with the given user. Get the list of templates shared with the given user. Parameters `$username` Name of the user to query for. Returns array List of shared templates with the user.
`public static array`	# `getTemplatesSharedBy( string $username )` Get the list of templates shared by the given user. Get the list of templates shared by the given user. Parameters `$username` Name of the user to query for. Returns array List of shared templates by the user.

Methods inherited from hrm\setting\base\Setting

__clone(), beDefault(), copyParameterFrom(), isDefault(), load(), message(), name(), owner(), parameter(), parameterNames(), resetDefault(), save(), set(), setName(), setNumberOfChannels(), setOwner(), shareWith()