StudipController Class Reference

Inheritance diagram for StudipController:

Collaboration diagram for StudipController:

Public Member Functions
	before_filter (&$action, &$args)
	perform ($unconsumed_path)
	after_filter ($action, $args)
	validate_args (&$args, $types=null)
	url_for ($to='')
	link_for ($to='')
	relocate ($to)
	rescue ($exception)
	render_json ($data)
	render_csv ($data, $filename=null, $delimiter=';', $enclosure='"')
	relay ($to_uri)
	perform_relayed ($unconsumed)
	render_template_as_string ($template, $layout=null)
	__call ($method, $arguments)
	has_action ($action)
	action_url ($action)
	action_link ($action)

Protected Member Functions
	controller_path ()

Protected Attributes
	$with_session = false
	$allow_nobody = true
	$_autobind = false

Member Function Documentation

__call()

__call	(		$method,
			$arguments
	)

Magic methods that intercepts all unknown method calls. If a method is called that matches an action on this controller, an url to that action is generated.

Basically, this:

$controller->url_for('foo/bar/baz/' . $param)

is equal to calling this on the Foo_BarController:

$controller->baz($param)

Parameters

String	$method	Called method name
array	$argumetns	Provided arguments

Returns

url to the requested action

Exceptions

Trails_UnknownAction

if no action matches the method

Here is the call graph for this function:

action_link()

action_link

(

$action

)

Generates the link for an action on this controller without the neccessity to provide the full "path" to the action (since it is implicitely known).

Basically, this:

$controller->link_for('foo/bar/baz/' . $param)

is equal to calling this on the Foo_BarController:

$controller->action_link('baz/' . $param)

Parameters

string

$action

Name of the action

Returns

url to the requested action

Here is the call graph for this function:

action_url()

action_url

(

$action

)

Generates the url for an action on this controller without the neccessity to provide the full "path" to the action (since it is implicitely known).

Basically, this:

$controller->url_for('foo/bar/baz/' . $param)

is equal to calling this on the Foo_BarController:

$controller->action_url('baz/' . $param)

Parameters

string

$action

Name of the action

Returns

url to the requested action

Here is the call graph for this function:

after_filter()

after_filter	(		$action,
			$args
	)

Callback function being called after an action is executed.

Parameters

string	Name of the action to perform.
array	An array of arguments to the action.

Returns

void

Reimplemented in Course_AdmissionController, Course_CancelDatesController, Course_ScmController, MyCoursesController, Resources_HelpersController, Search_ModuleController, Settings_SettingsController, and Studiengaenge_StudiengaengeController.

Here is the call graph for this function:

before_filter()

before_filter	(	&	$action,
		&	$args
	)

Reimplemented in Admin_AdditionalController, Admin_ApiController, Admin_AutoinsertController, Admin_BannerController, Admin_ConfigurationController, Admin_ContentTermsOfUseController, Admin_CoursesController, Admin_CourseWizardStepsController, Admin_Cronjobs_LogsController, Admin_Cronjobs_SchedulesController, Admin_Cronjobs_TasksController, Admin_DatafieldsController, Admin_DomainController, Admin_HolidaysController, Admin_IliasInterfaceController, Admin_LockrulesController, Admin_LoginStyleController, Admin_LtiController, Admin_PluginController, Admin_RoleController, Admin_SemClassesController, Admin_SemesterController, Admin_SmileysController, Admin_SpecificationController, Admin_StatusgroupsController, Admin_UserController, Admin_WebserviceAccessController, Admission_CoursesetController, Admission_RestrictedCoursesController, Admission_RuleController, Admission_RuleAdministrationController, Admission_UserListController, Api_AuthorizationsController, Api_OauthController, ArchiveController, BbController, Calendar_CalendarController, Calendar_GroupController, Calendar_ScheduleController, Calendar_SingleController, Consultation_AdminController, ConsultationController, Consultation_ExportController, Consultation_OverviewController, ContactController, Course_AdmissionController, Course_BlockAppointmentsController, Course_CancelDatesController, Course_ChangeViewController, Course_DatesController, Course_DetailsController, Course_ElearningController, Course_EnrolmentController, Course_FilesController, Course_GroupingController, Course_IliasInterfaceController, Course_LiteratureController, Course_LtiController, Course_LvgselectorController, Course_ManagementController, Course_MembersController, Course_OverviewController, Course_RoomRequestsController, Course_ScmController, Course_StatusgroupsController, Course_StudyAreasController, Course_StudygroupController, Course_TimesroomsController, Course_TopicsController, Course_WizardController, ElearningController, EventLogController, Fachabschluss_AbschluesseController, Fachabschluss_FaecherController, Fachabschluss_KategorienController, FilesController, FilesDashboardController, GlobalSearchController, HelpContentController, iCalController, IliasAuthController, Institute_BasicdataController, Institute_CalendarController, Institute_FilesController, Institute_MembersController, Institute_OverviewController, JsupdaterController, LiteratureController, LtiController, Lvgruppen_LvgruppenController, Materialien_DokumenteController, MediaProxyController, MessagesController, Module_InstituteController, Module_ModuleController, MVVController, MyCoursesController, MyIliasAccountsController, MyInstitutesController, MyStudygroupsController, NewsController, NotificationsController, OnlineController, ProfileController, ProfileModulesController, PublicCoursesController, QuestionnaireController, ScoreController, Search_AngebotController, Search_CoursesController, Search_ModuleController, Search_StgtableController, Search_StudiengaengeController, Seminar_DetailsController, Settings_AccountController, Settings_CalendarController, Settings_CategoriesController, Settings_DeputiesController, Settings_DetailsController, Settings_GeneralController, Settings_MessagingController, Settings_NotificationController, Settings_PasswordController, Settings_PrivacyController, Settings_SettingsController, Settings_StatusgruppenController, Settings_StudiesController, Settings_UserdomainsController, Shared_ModulController, SiteinfoController, SmileysController, StartController, Studiengaenge_StgteilbezeichnungenController, Studiengaenge_StudiengaengeController, Studiengaenge_StudiengangteileController, Studiengaenge_VersionenController, StudygroupController, TermsController, TourController, Userfilter_FieldController, Userfilter_FilterController, WidgetsController, and WikiController.

Here is the call graph for this function:

controller_path()

controller_path ( )

protected

Returns the url path to this controller.

Returns

url path to this controller

Here is the call graph for this function:

Here is the caller graph for this function:

has_action()

has_action

(

$action

)

Returns whether this controller has the specificed action.

Parameters

string

$action

Name of the action

Returns

true if action is defined, false otherwise

Here is the caller graph for this function:

link_for()

link_for

(

$to = ''

)

Returns an escaped URL to a specified route to your Trails application. without first parameter the current action is used if route begins with a / then the current controller ist prepended if second parameter is an array it is passed to URLHeper

Parameters

string	a string containing a controller and optionally an action
strings	optional arguments

Returns

string a URL to this route

Here is the call graph for this function:

Here is the caller graph for this function:

perform()

perform

(

$unconsumed_path

)

Hooked perform method in order to inject body element id creation.

In order to avoid clashes, these body element id will be joined with a minus sign. Otherwise the controller "x" with action "y_z" would be given the same id as the controller "x/y" with the action "z", namely "x_y_z". With the minus sign this will result in the ids "x-y_z" and "x_y-z".

Plugins will always have a leading 'plugin-' and the decamelized plugin name in front of the id.

Parameters

String

$unconsumed_path

Path segment containing action and optionally arguments or format

Returns

Trails_Response from parent controller

Here is the call graph for this function:

perform_relayed()

perform_relayed

(

$unconsumed

)

perform a given action/parameter string from an relayed request before_filter and after_filter methods are not called

See also

perform

Parameters

string

$unconsumed

Returns

Trails_Response

Here is the caller graph for this function:

relay()

relay

(

$to_uri

)

relays current request to another controller and returns the response the other controller is given all assigned properties, additional parameters are passed through

Parameters

string

$to_uri

a trails route

Returns

Trails_Response

Here is the caller graph for this function:

relocate()

relocate

(

$to

)

Relocate the user to another location. This is a specialized version of redirect that differs in two points:

• relocate() will force the browser to leave the current dialog while redirect would refresh the dialog's contents
• relocate() accepts all the parameters that url_for() accepts so it's no longer neccessary to chain url_for() and redirect()

Parameters

String

$to

Location to redirect to

Reimplemented in Course_TimesroomsController.

Here is the call graph for this function:

Here is the caller graph for this function:

render_csv()

render_csv	(		$data,
			$filename = null,
			$delimiter = ';',
			$enclosure = '"'
	)

Render given data as csv, data is assumed to be utf-8. The first row of data may contain column titles.

Parameters

array	$data	data as two dimensional array
string	$filename	download file name (optional)
string	$delimiter	field delimiter char (optional)
string	$enclosure	field enclosure char (optional)

Here is the call graph for this function:

Here is the caller graph for this function:

render_json()

render_json

(

$data

)

render given data as json, data is converted to utf-8

Parameters

unknown

$data

Here is the caller graph for this function:

render_template_as_string()

render_template_as_string	(		$template,
			$layout = null
	)

Renders a given template and returns the resulting string.

Parameters

string	$template	Name of the template file
mixed	$layout	Optional layout

Returns

string

Here is the caller graph for this function:

rescue()

rescue

(

$exception

)

Exception handler called when the performance of an action raises an exception.

Parameters

object

the thrown exception

url_for()

url_for

(

$to = ''

)

Returns a URL to a specified route to your Trails application. without first parameter the current action is used if route begins with a / then the current controller ist prepended if second parameter is an array it is passed to URLHeper

Parameters

string	a string containing a controller and optionally an action
strings	optional arguments

Returns

string a URL to this route

Reimplemented in Settings_SettingsController.

Here is the call graph for this function:

validate_args()

validate_args	(	&	$args,
			$types = null
	)

Validate arguments based on a list of given types. The types are: 'int', 'float', 'option'. If the list of types is NULL or shorter than the argument list, 'option' is assumed for all remaining arguments. 'option' differs from Request::option() in that it also accepts the charaters '-' and ',' in addition to all word charaters.

Since Stud.IP 4.0 it is also possible to directly inject SimpleORMap objects. If types is NULL, the signature of the called action is analyzed and any type hint that matches a sorm class will be used to create an object using the argument as the id that is passed to the object's constructor.

If $_autobind is set to true, the created object is also assigned to the controller so that it is available in a view.

Parameters

array	an array of arguments to the action
array	list of argument types (optional)

Reimplemented in FileController, and FilesController.

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$_autobind

$_autobind = false

protected

$allow_nobody

$allow_nobody = true

protected

$with_session

$with_session = false

protected

---

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

• app/controllers/studip_controller.php