\PluginFusioninventoryTimeslot

Manage the timeslot for tasks. It's the time in the week the task run.

Summary

Methods
Properties
Constants
getTypeName()
getSearchOptions()
defineTabs()
getTimeslotEntries()
getCurrentActiveTimeslots()
getTimeslotCursor()
showForm()
$dohistory
$rightname
No constants found
No protected methods found
No protected properties found
N/A
No private methods found
No private properties found
N/A

Properties

$dohistory

$dohistory : boolean

We activate the history.

Type

boolean

$rightname

$rightname : string

The right name for this class

Type

string

Methods

getTypeName()

getTypeName(integer  $nb) : string

Get name of this type by language of the user connected

Parameters

integer $nb

number of elements

Returns

string —

name of this type

getSearchOptions()

getSearchOptions() : array

Get search function for the class

Returns

array

defineTabs()

defineTabs(array  $options = array()) : array

Define tabs to display on form page

Parameters

array $options

Returns

array —

containing the tabs name

getTimeslotEntries()

getTimeslotEntries(array  $timeslot_ids = array(), string  $weekdays = null) 

Get Timeslot entries according to the requested day of week.

Parameters

array $timeslot_ids

A list of timeslot's ids.

string $weekdays

The day of week (ISO-8601 numeric representation). return array the list of timeslots entries organized by timeslots ids : array( [timeslot #0] => array( [timeslot_entry #2] => array( ...timeslot_entry fields... ) [timeslot_entry #3] => array( ...timeslot_entry fields... ) ), [timeslot #5] => array( [timeslot_entry #9] => array( ...timeslot_entry fields... ) [timeslot_entry #66] => array( ...timeslot_entry fields... ) ) )

getCurrentActiveTimeslots()

getCurrentActiveTimeslots() : array

Get all current active timeslots

Returns

array

getTimeslotCursor()

getTimeslotCursor(null|object  $datetime = null) : integer

Get Timeslot cursor (ie. seconds since 00:00) according to a certain datetime

Parameters

null|object $datetime

The date and time we want to transform into cursor. If null the default value is now()

Returns

integer

showForm()

showForm(integer  $ID, array  $options = array()) : true

Display form for agent configuration

Parameters

integer $ID

ID of the agent

array $options

Returns

true