\FOFLayoutFile

Base class for rendering a display layout loaded from from a layout file

This class searches for Joomla! version override Layouts. For example,
if you have run this under Joomla! 3.0 and you try to load
mylayout.default it will automatically search for the
layout files default.j30.php, default.j3.php and default.php, in this
order.

Synopsis

class FOFLayoutFile extends JLayoutFile {

• // Inherited members from JLayoutFile
• protected  $layoutId;
• protected  $basePath;
• protected  $fullPath;
• protected  $includePaths;
• // Inherited members from JLayoutBase
• protected JRegistry  $options;
• protected  $debugMessages;
• // methods
• protected string getPath()
• // Inherited methods from JLayoutFile
• public void __construct()
• public string render()
• protected string getPath()
• public void addIncludePath()
• public void addIncludePaths()
• public void removeIncludePath()
• public void removeIncludePaths()
• protected boolean validComponent()
• public mixed setComponent()
• public void setClient()
• public void setLayout()
• protected void refreshIncludePaths()
• public void setDebug()
• public string sublayout()
• // Inherited methods from JLayoutBase
• public JLayoutBase setOptions()
• public JRegistry getOptions()
• public JLayoutBase resetOptions()
• public string escape()
• public array getDebugMessages()
• public string render()
• public string renderDebugMessages()
• public void addDebugMessage()
}


Hierarchy

Extends

• JLayoutFile

Members

protected

• $basePath — string
• $debugMessages — array
  Debug information messages
• $fullPath — string
• $includePaths — array
  Paths to search for layouts
• $layoutId — string
• $options — JRegistry
  Options object

Methods

protected

• getPath() — Method to finds the full real file path, checking possible overrides

Inherited from JLayoutFile

protected

• getPath() — Method to finds the full real file path, checking possible overrides
• refreshIncludePaths() — Refresh the list of include paths
• validComponent() — Validate that the active component is valid

public

• addIncludePath() — Add one path to include in layout search. Proxy of addIncludePaths()
• addIncludePaths() — Add one or more paths to include in layout search
• removeIncludePath() — Remove one path from the layout search
• removeIncludePaths() — Remove one or more paths to exclude in layout search
• render() — Method to render the layout.
• setClient() — Function to initialise the application client
• setComponent() — Method to change the component where search for layouts
• setDebug() — Change the debug mode
• setLayout() — Change the layout
• sublayout() — Render a layout with the same include paths & options

Inherited from JLayoutBase

public

• addDebugMessage() — Add a debug message to the debug messages array
• escape() — Method to escape output.
• getDebugMessages() — Get the debug messages array
• getOptions() — Get the options
• render() — Method to render the layout.
• renderDebugMessages() — Render the list of debug messages
• resetOptions() — Function to empty all the options
• setOptions() — Set the options