OpenBroadcaster Documentation
models / schedules_model.php

SchedulesModel

Model

Manages schedules and shows.

public  get_shows ( start, end, player, not_entry=false )

Get shows scheduled on a player.

Parameters
start
end
player
not_entry Exclude a specific entry from search. Default FALSE.
Returns shows
public  get_show_by_id ( id, recurring=false )

Get a show by ID.

Parameters
id
recurring Boolean for recurring shows. Default FALSE.
Returns show
public  delete_show ( id, recurring=false )

Delete a show by ID.

Parameters
id
recurring Boolean for recurring shows. Default FALSE.
public  validate_show ( data, id=false, skip_permission_check=false )

Validate a show

Parameters
data
id Set when updating existing show. Default FALSE.
Returns [is_valid, msg]
public  collision_timeslot_check ( data, id=false, edit_recurring=false, skip_timeslot_check = false )

Check if this collides with another scheduled item (excluding item with id = $id).

Parameters
data
id Item to exclude. Default FALSE.
edit_recurring Whether editing a recurring item. Default FALSE.
Returns [is_colliding, msg]
public  save_show ( data, id = false, edit_recurring = false )

Save a show.

Parameters
data
id Set when updating an existing show. Unset by default.
edit_recurring Whether editing a recurring show. Unset by default.
private  order_schedule ( a, b )

Private method to get the order of two schedules. Return 1 if A starts after B, -1 otherwise.

Parameters
a
b
Returns 1|-1