| package | midcom.compat |
|---|---|
| property | |
| property | |
| property | |
| property | |
| property | |
| property | |
| property | |
| property | |
| property | |
| property | |
| property | |
| property | |
| property | |
| property | |
| property |
| see | \get_context_data() |
|---|
mixedThe value to be storedintSee get_context_data()intSee get_context_data()booleanIndicating if the switch was successful.stringThe code to be included in the state.stringThe state where to include the code to. Defaults to document.readystringThe code to be included directly in the page.stringThe URL to the file to-be referenced.booleanWhether to add the JS include to beginning of includesstringThe name of the method to be called on page startup, including parameters but excluding the ';'.arrayArray of attribute=> value pairs to be placed in the tag.stringThe input between the tags.arrayArray of attribute=> value pairs to be placed in the tag.stringThe input between the tags.arrayArray of attribute=> value pairs to be placed in the tag.stringThe stylesheet URLstringThe media type(s) for the stylesheet, if anyThis will automatically connect such things like metadata and toolbars to the correct object.
\midcom_core_dbaobjectThe DBA class instance to bind to.stringString describing page type, will be used for substylingThis function is a small helper, that will display a simple HTML Page reporting the error described by $httpcode and $message. The $httpcode is also used to send an appropriate HTTP Response.
For a list of the allowed HTTP codes see the MIDCOM_ERR... constants
Note: This function will call _midcom_stop_request() after it is finished.
| see | \midcom_exception_handler::show() |
|---|
intThe error code to send.stringThe message to print.arrayThe data of all contexts\midcom_helper__componentloaderThe reference of the component loader in use.intparam1 Either the ID of the context (two parameters) or the key requested (one parameter).intparam2 Either the key requested (two parameters) or null (one parameter, the default).mixedThe content of the key being requested.This is false if there is no context running.
intThe context ID.intSee get_context_data()intSee get_context_data()mixedThe requested value, which is returned by Reference!Returns the MidCOM Object Service indicated by $name. If the service cannot be found, an HTTP 500 is triggered.
See the documentation of the various services for further details.
stringThe name of the service being requested.mixedA reference(!) to the service requested.This will load the pure-code library denoted by the MidCOM Path $path. It will return true if the component truly was a pure-code library, false otherwise. If the component loader cannot load the component, midcom_error will be thrown by it.
Common example:
midcom::get('componentloader')->load_library('midcom.helper.datamanager');
stringThe name of the code library to load.booleanIndicates whether the library was successfully loaded.Helper function to facilitate HTTP relocation (Location: ...) headers. The helper actually can distinguish between site-local, absolute redirects and external redirects. If you add an absolute URL starting with a "/", it will automatically add an http[s]://$servername:$server_port in front of that URL; note that the server_port is optional and only added if non-standard ports are used. If the url does not start with http[s], it is taken as a URL relative to the current anchor prefix, which gets prepended automatically (no other characters as the anchor prefix get inserted).
Fully qualified urls (starting with http[s]) are used as-is.
Note, that this function automatically makes the page uncacheable, calls midcom_finish and exit, so it will never return. If the headers have already been sent, this will leave you with a partially completed page, so beware.
stringThe URL to redirect to, will be preprocessed as outlined above.stringHTTP response code to send with the relocation, from 3xx seriesThis function can serve the code field of an arbitrary snippet. There is no checking on permissions done here, the callee has to ensure this.
Two parameters can be used to influence the behavior of this method: "midcom/content-type" will set the content-type header sent with the code field's content. If this is not set, application/octet-stream is used as a default. "midcom/expire" is a count of seconds used for content expiration, both for the HTTP headers and for the caching engine. If this is no valid integer or less then or equal to zero or not set, the value is set to "1".
The last modified header is created by using the revised timestamp of the snippet.
Remember to also set the parameter "midcom/allow_serve" to "true" to clear the snippet for serving.
\MidgardSnippet&$snippet The snippet that should be delivered to the client.mixedThe key associated to the value or the context idmixed&$value The value to store. (This is stored by-reference!)mixedThe key if a context was specified as first parameterThis can be retrieved by accessing the component context key MIDCOM_CONTEXT_PAGETITLE.
stringThe title to set.Appends a substyle after the currently selected component style, effectively enabling a depth of more then one style during substyle selection. This is only effective if done during the handle phase of the component and allows the component. The currently selected substyle therefore is now searched one level deeper below "subStyle".
The system must have completed the CAN_HANDLE Phase before this function will be available.
stringThe substyle to append.Prepends a substyle before the currently selected component style, effectively enabling a depth of more then one style during substyle selection. This is only effective if done during the handle phase of the component and allows the component. The currently selected substyle therefore is now searched one level deeper below "subStyle".
The system must have completed the CAN_HANDLE Phase before this function will be available.
stringThe substyle to prepend.