Stud.IP  4.0
 All Data Structures Namespaces Files Functions Variables Groups
Calendar_ScheduleController Class Reference
Inheritance diagram for Calendar_ScheduleController:
AuthenticatedController StudipController

Public Member Functions

 before_filter (&$action, &$args)
 
 index_action ($days=false)
 
 new_entry_action ()
 
 addEntry_action ($id=null)
 
 entry_action ($id=null, $cycle_id=null)
 
 entryajax_action ($id, $cycle_id=null)
 
 groupedentry_action ($start, $end, $seminars, $day)
 
 delete_action ($id)
 
 editseminar_action ($seminar_id, $cycle_id)
 
 addvirtual_action ($seminar_id)
 
 adminbind_action ($seminar_id, $cycle_id, $visible, $ajax=null)
 
 unbind_action ($seminar_id, $cycle_id=null, $ajax=null)
 
 bind_action ($seminar_id, $cycle_id, $ajax=null)
 
 settings_action ()
 
 storesettings_action ($start_hour=false, $end_hour=false, $days=false, $semester_id=false)
 
- Public Member Functions inherited from StudipController
 before_filter (&$action, &$args)
 
 erase_response ()
 
 perform ($unconsumed_path)
 
 after_filter ($action, $args)
 
 validate_args (&$args, $types=null)
 
 url_for ($to= '')
 
 link_for ($to= '')
 
 redirect ($to)
 
 relocate ($to)
 
 rescue ($exception)
 
 render_json ($data)
 
 render_csv ($data, $filename=null, $delimiter= ';', $enclosure= '"')
 
 render_file ($file, $filename=null, $content_type=null, $content_disposition= 'attachment', Closure $callback=null, $chunk_size=262144)
 
 render_temporary_file ($file, $filename=null, $content_type=null, $content_disposition= 'attachment', Closure $callback=null, $chunk_size=262144)
 
 relay ($to_uri)
 
 relayWithRedirect (...$args)
 
 perform_relayed ($unconsumed)
 
 render_template_as_string ($template, $layout=null)
 
 __call ($method, $arguments)
 
 has_action ($action)
 
 action_url ($action)
 
 action_link ($action)
 
 validate_datetime ($datetime, $format= 'H:i')
 

Additional Inherited Members

- Protected Member Functions inherited from StudipController
 render_pdf (TCPDF $pdf, $filename, $inline=false)
 
 controller_path ()
 
 getBodyElementIdForControllerAndAction ($unconsumed_path)
 
- Protected Attributes inherited from AuthenticatedController
 $with_session = true
 
 $allow_nobody = false
 
- Protected Attributes inherited from StudipController
 $with_session = false
 
 $allow_nobody = true
 
 $_autobind = false
 

Member Function Documentation

addEntry_action (   $id = null)

this action is called whenever a new entry shall be modified or added to the schedule

Parameters
string$idoptional, if id given, the entry with this id is updated
addvirtual_action (   $seminar_id)

Adds the appointments of a course to your schedule.

Parameters
string$seminar_idthe ID of the course
Returns
void
adminbind_action (   $seminar_id,
  $cycle_id,
  $visible,
  $ajax = null 
)

Set the visibility of the course.

Parameters
string$seminar_idthe ID of the course
string$cycle_idthe ID of the cycle
string$visiblevisibility; either '1' or '0'
string$ajaxif you give this optional param, it signals an Ajax request
Returns
void
before_filter ( $action,
$args 
)

Callback function being called before an action is executed. If this function does not return FALSE, the action will be called, otherwise an error will be generated and processing will be aborted. If this function already #rendered or #redirected, further processing of the action is withheld.

Parameters
stringName of the action to perform.
arrayAn array of arguments to the action.
bind_action (   $seminar_id,
  $cycle_id,
  $ajax = null 
)

Show the given appointment.

Parameters
string$seminar_idthe ID of the course
string$cycle_idthe ID of the cycle
string$ajaxif you give this optional param, it signals an Ajax request
Returns
void
delete_action (   $id)

delete the entry of the submitted id (only entry belonging to the current use can be deleted)

Parameters
string$idthe id of the entry to delete
Returns
void
editseminar_action (   $seminar_id,
  $cycle_id 
)

store the color-settings for the seminar

Parameters
string$seminar_id
string$cycle_id
Returns
void
entry_action (   $id = null,
  $cycle_id = null 
)

this action keeps the entry of the submitted_id and enables displaying of the entry-dialog. If no id is submitted, an empty entry_dialog is displayed.

Parameters
string$idthe id of the entry to edit (if any), false otherwise.
string$cycle_idan optional cycle's ID
entryajax_action (   $id,
  $cycle_id = null 
)

Return an HTML fragment containing a form to edit an entry

Parameters
stringthe ID of a course
stringan optional cycle's ID
Returns
void
groupedentry_action (   $start,
  $end,
  $seminars,
  $day 
)

Returns an HTML fragment of a grouped entry in the schedule of an institute.

Parameters
string$startthe start time of the group, e.g. "1000"
string$endthe end time of the group, e.g. "1200"
string$seminarsthe IDs of the courses
string$daynumeric day to show
Returns
void
index_action (   $days = false)

this action is the main action of the schedule-controller, setting the environment for the timetable, accepting a comma-separated list of days.

Parameters
string$daysa list of an arbitrary mix of the numbers 0-6, separated with a comma (e.g. 1,2,3,4,5 (for Monday to Friday, the default))
new_entry_action ( )
settings_action ( )

Show the settings' form.

Returns
void
storesettings_action (   $start_hour = false,
  $end_hour = false,
  $days = false,
  $semester_id = false 
)

Store the settings

Parameters
stringthe start time of the calendar to show, e.g. "1000"
stringthe end time of the calendar to show, e.g. "1200"
stringthe days to show
stringthe ID of the semester
Returns
void
unbind_action (   $seminar_id,
  $cycle_id = null,
  $ajax = null 
)

Hide the give appointment.

Parameters
string$seminar_idthe ID of the course
string$cycle_idthe ID of the cycle
string$ajaxif you give this optional param, it signals an Ajax request
Returns
void

The documentation for this class was generated from the following file: