Class Setting

(Abstract) base class for all specific Setting classes.

Direct known subclasses

hrm\setting\AnalysisSetting, hrm\setting\ParameterSetting, hrm\setting\TaskSetting

Indirect known subclasses

hrm\setting\JobAnalysisSetting, hrm\setting\JobParameterSetting, hrm\setting\JobTaskSetting

Abstract
Namespace: hrm\setting\base
Package: hrm
Located at setting/base/Setting.php

Methods summary

`public`	# `__clone( )` Deep copy method. Deep copy method. Call: $settingClone = clone $setting to get a deep copy of the original object.
`public hrm\param\base\Parameter\|null`	# `parameter( string $name )` Returns the Parameter of given name. Returns the Parameter of given name. Parameters `$name` Name of the Parameter to return. Returns `hrm\param\base\Parameter`\|null A Parameter object or NULL if the Parameter does not exist.
`public`	# `set( hrm\param\base\Parameter $parameter )` Sets a Parameter. The Parameter is stored in the Setting under its name. Sets a Parameter. The Parameter is stored in the Setting under its name. Parameters `$parameter` Parameter to be stored.
`public string`	# `message( )` Returns the last (error) message. Returns the last (error) message. Returns string (Error) message.
`public array`	# `parameterNames( )` Return all Parameter names Return all Parameter names Returns array Array of parameter names
`public hrm\user\UserV2`	# `owner( )` Returns the User owner of the Setting. Returns the User owner of the Setting. Returns `hrm\user\UserV2` Owner of the Setting.
`public`	# `setOwner( hrm\user\UserV2 $owner )` Sets the User owner of the Setting. Sets the User owner of the Setting. Parameters `$owner` The owner of the Setting.
`public string`	# `name( )` Returns the name of the Setting. Returns the name of the Setting. Returns string The name of the Setting.
`public`	# `setName( string $name )` Sets the name of the Setting, Sets the name of the Setting, Parameters `$name` Name of the Setting.
`public boolean`	# `isDefault( )` Checks whether the Setting is the user's default setting. Checks whether the Setting is the user's default setting. Returns boolean True if the Setting is the default Setting, false otherwise.
`public`	# `beDefault( )` Sets current Setting as the default Setting for the user. Sets current Setting as the default Setting for the user.
`public`	# `resetDefault( )` Resets current Setting as no longer the default Setting for the user. Resets current Setting as no longer the default Setting for the user.
`public`	# `copyParameterFrom( hrm\setting\base\Setting $setting )` Copies the Parameter values from another Setting. Copies the Parameter values from another Setting. Parameters `$setting` The other Setting object from which the values are copied.
`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. This method must be reimplemented. Returns string Table name. Throws Exception This method must be reimplemented.
`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(). This method must be reimplemented. Returns string Table name. Throws Exception This method must be reimplemented. See `hrm\setting\base\Setting::table()`
`public hrm\setting\base\Setting`	# `load( )` Loads the Parameter values into current Setting. Loads the Parameter values into current Setting. Returns `hrm\setting\base\Setting` The loaded Setting.
`public boolean`	# `save( )` Saves all Parameter values from current Setting to the database. Saves all Parameter values from current Setting to the database. Returns boolean True if saving was successful, false otherwise.
`public boolean`	# `shareWith( string $username )` Shares the selected setting with the given user. Shares the selected setting with the given user. Parameters `$username` Name of the user to share with. Returns boolean True if sharing was successful, false otherwise.
`public`	# `setNumberOfChannels( integer $channels )` Sets the number of channels for the Setting. Sets the number of channels for the Setting. All variable channels Parameter objects in the Setting will updated. Parameters `$channels` Number of channels (between 1 and 6).