-
Configures template.
-
Executes any presentation logic and set template attributes.
-
(mixed) getAttribute (, , )
Browse code
Retrieves an attribute for the current view.
returns Attribute
-
(sfParameterHolder) getAttributeHolder ()
Browse code
Retrieves attributes for the current view.
returns The attribute parameter holder
-
(array) getComponentSlot ()
Browse code
Gets a component slot
returns The component slot
-
(sfContext) getContext ()
Browse code
Retrieves the current application context.
returns The current sfContext instance
-
(string) getDecoratorDirectory ()
Browse code
Retrieves this views decorator template directory.
returns An absolute filesystem path to this views decorator template directory
-
(string) getDecoratorTemplate ()
Browse code
Retrieves this views decorator template.
returns A template filename, if a template has been set, otherwise null
-
(string) getDirectory ()
Browse code
Retrieves this view template directory.
returns An absolute filesystem path to this views template directory
-
Retrieves the template engine associated with this view.
Note: This will return null for PHPView instances.
returns A template engine instance
-
(string) getEscaping ()
Browse code
Gets the default escaping strategy associated with this view.
The escaping strategy specifies how the variables get passed to the view.
returns the escaping strategy
-
(string) getEscapingMethod ()
Browse code
Returns the name of the function that is to be used as the escaping method.
If the escaping method is empty, then that is returned. The default value
specified by the sub-class will be used. If the method does not exist (in
the sense there is no define associated with the method) and exception is
thrown.
returns The escaping method as the name of the function to use
throws sfException If the method does not exist
-
(string) getExtension ()
Browse code
Retrieves the current view extension.
returns The extension for current view.
-
(mixed) getParameter (, , )
Browse code
Retrieves a parameter from the current view.
returns A parameter value
-
(sfParameterHolder) getParameterHolder ()
Browse code
Retrieves the parameters for the current view.
returns The parameter holder
-
(string) getTemplate ()
Browse code
Retrieves this views template.
returns A template filename, if a template has been set, otherwise null
-
(mixed) hasAttribute (, )
Browse code
Returns true if the view have attributes.
returns Attribute of the view
-
(boolean) hasComponentSlot ()
Browse code
Indicates whether or not a component slot exists.
returns true, if the component slot exists, otherwise false
-
(boolean) hasParameter (, )
Browse code
Indicates whether or not a parameter exist for the current view.
returns true, if the parameter exists otherwise false
-
importAttributes (, , , , )
Browse code
Imports parameter values and error messages from the request directly as view attributes.
-
(boolean) initialize (, , , )
Browse code
Initializes this view.
returns true, if initialization completes successfully, otherwise false
-
(boolean) isDecorator ()
Browse code
Indicates that this view is a decorating view.
returns true, if this view is a decorating view, otherwise false
-
Executes a basic pre-render check to verify all required variables exist
and that the template is readable.
throws sfRenderException If the pre-render check fails
-
Renders the presentation.
When the controller render mode is sfView::RENDER_CLIENT, this method will
render the presentation directly to the client and null will be returned.
returns A string representing the rendered presentation, if the controller render mode is sfView::RENDER_VAR, otherwise null
-
Sets an attribute of the view.
-
setComponentSlot (, , )
Browse code
Sets the module and action to be executed in place of a particular template attribute.
-
Sets the decorating mode for the current view.
-
setDecoratorDirectory ()
Browse code
Sets the decorator template directory for this view.
-
setDecoratorTemplate ()
Browse code
Sets the decorator template for this view.
If the template path is relative, it will be based on the currently
executing module's template sub-directory.
-
Sets the template directory for this view.
-
Sets the escape caracter mode.
-
Sets the escaping method for the current view.
-
Sets an extension for the current view.
-
Sets a parameter for the view.
-
Sets the template for this view.
If the template path is relative, it will be based on the currently
executing module's template sub-directory.
-
Overloads a given method
returns User function callback
throws sfException If the call fails