Settings_SettingsController Class Reference

Inheritance diagram for Settings_SettingsController:

Public Member Functions
	before_filter (&$action, &$args)
	url_for ($to='')
	get_default_template ($action)
	render_nothing ($text='')
	shallChange ($field, $attribute=null, $value=null)
	after_filter ($action, $args)
Public Member Functions inherited from AuthenticatedController
	before_filter (&$action, &$args)
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)
	render_form (\Studip\Forms\Form $form)
	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')
	render_spreadsheet (array $header, array $data, string $format, string $filename, ?string $filepath=null)

Protected Member Functions
	check_ticket ()
	postPrivateMessage ($message)
Protected Member Functions inherited from AuthenticatedController
	keepRequest ()
Protected Member Functions inherited from StudipController
	render_pdf (TCPDF $pdf, $filename, $inline=false)
	controller_path ()
	getBodyElementIdForControllerAndAction ($unconsumed_path)

Protected Attributes
	$private_messages = []
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

after_filter()

after_filter	(		$action,
			$args
	)

The after filter handles the sending of private messages via email, if present. Also, if an action requires the user to be logged out, this is accomplished here.

Parameters

String	$action	Name of the action that has been invoked
Array	$args	Arguments of the action

before_filter()

before_filter	(	&	$action,
		&	$args
	)

Sets up the controller

Parameters

String	$action	Which action shall be invoked
Array	$args	Arguments passed to the action method

check_ticket()

check_ticket ( )

protected

Generic ticket check

Exceptions

AccessDeniedException

if ticket is missing or invalid

get_default_template()

get_default_template

(

$action

)

Gets the default template for an action.

Parameters

String

$action

Which action was invoked

Returns

String File name of the template

postPrivateMessage()

postPrivateMessage (   $message )

protected

Add to the private messages

Parameters

String

$message

Message to store

Returns

Object Returns $this to allow chaining

render_nothing()

render_nothing

(

$text = ''

)

Render nothing but with a layout

Parameters

String

$text

Optional nothing text

Returns

String Rendered output

shallChange()

shallChange	(		$field,
			$attribute = null,
			$value = null
	)

Determines whether a user is permitted to change a certain value and if provided, whether the value has actually changed.

Parameters

String	$field	Which db field shall change
mixed	$attribute	Which attribute is related (optional, automatically guessedif missing)
mixed	$value	Optional new value of the field (used to determine whether the value has actually changed)

Returns

bool Indicates whether the value shall actually change

url_for()

url_for

(

$to = ''

)

Adjust url_for so it imitates the parameters behaviour of URLHelper. This way you can add parameters by adding an associative array as last argument.

Parameters

mixed

$to

Path segments of the url (String) or url parameters (Array)

Returns

String Generated url

Field Documentation

$private_messages

$private_messages = []

protected

---

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

• app/controllers/settings/settings.php