Publick methods within jqScheduler
setUrl( $curl )
Set the url from where to get the data after the scdedule is created.
Parameters:
API Tags:
Access: public
setLocale( $lng )
Set the language used in the schedule. After this string we add a inc suffix and search for this file.
Parameters:
- string $lng: The name of the language file. default is English
API Tags:
Access: public
setTemplate( $html, string [$css=''] )
Set the template and css files used for rendering and editing the events
Parameters:
- string $html: The name of the html file. Deafult is calendar.html
- string $css: The the name of the css file. Default is calendar.css
API Tags:
Access: public
getOption( $option )
Return the option of the event calendar
Parameters:
- string $option: existing option
API Tags:
Access: public
setOption($option, $value=null)
Set options for the event calender. See options
Parameters:
- mixed $option: the option name for the event calender. Can be a string or array. When used as array a key value pair should be defined, where the key is the name
- mixed $value is the value option in case the $option is string
API Tags:
Access: public
setEvent( $event, $code )
Set a valid javascript calendar event
Parameters:
- string $event: Valid event
- string $code: Javascript code which will be executed when the event raises
API Tags:
Access: public
setUser( $user_id, $usesession=true )
Set the current user used in event calendar. The function uses sessions to store the current user. This is done if the second parameter is set to true.
Parameters:
- integer $user_id: the user
- boolean $usesession: is set to true a session is used, otherwiese a custom mechanism should be used
API Tags:
Access: public
setUserNames( $anames )
Set the pair value names of the currently used calendar (users). This represent different calendars for the curren user.
Parameters:
- array $anames: associative array for the the calendars
API Tags:
Access: public
setUserDateFormat ($newformat)
Set the user date format for entering and displaying dates. A PHP convensions should be used. Default is d/m/Y
Parameters:
- string $newformat: new date format
API Tags:
Access: public
setPdfOptions( $apdf )
Set options for PDF export.
Parameters:
API Tags:
Access: public
exportEvents( )
Export events to iCal format. A start and end parameters should be send in
Parameters:
None
API Tags:
Access: public
printEvents( )
Print the result either as html or as pdf depending on the $printformat variable
Parameters:
None
API Tags:
Access: public
render( [$script], [$echo] )
Create the scheduler after all options and events are set and the do all the thing regarding adding, editing printing and etc things
Parameters:
- boolean $script: if true a javascript tag is outputed
- boolean $echo : if false a the string is returned (where possible)
API Tags:
Access: public