class FrxMenu in Forena Reports 8

Class FrxMenu

Plugin annotation

@FrxRenderer(id = "FrxMenu")

Hierarchy

• class \Drupal\forena\FrxPlugin\Renderer\RendererBase implements RendererInterface uses FrxAPI
  • class \Drupal\forena\FrxPlugin\Renderer\FrxMenu

1 file declares its use of FrxMenu

TestingAppService.php in tests/src/Unit/Mock/TestingAppService.php

File

src/FrxPlugin/Renderer/FrxMenu.php, line 11

Namespace

Drupal\forena\FrxPlugin\Renderer

class FrxMenu extends RendererBase {
  public function render() {
    $output = '';
    $attributes = $this
      ->mergedAttributes();
    if (!empty($attributes['menu-id'])) {
      $menu_id = $attributes['menu-id'];
      $output = $this
        ->app()
        ->renderMenu($menu_id);
    }
    return $output;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
FrxAPI::app	public	function	Returns containing application service
FrxAPI::currentDataContext	public	function	Get the current data context.
FrxAPI::currentDataContextArray	public	function
FrxAPI::dataManager	public	function	Returns the data manager service
FrxAPI::dataService	public	function	Return Data Service
FrxAPI::documentManager	public	function	Returns the fornea document manager
FrxAPI::error	public	function	Report an error
FrxAPI::getDataContext	public	function	Get the context of a specific id.
FrxAPI::getDocument	public	function	Get the current document
FrxAPI::getReportFileContents	public	function	Load the contents of a file in the report file system.
FrxAPI::innerXML		function	Enter description here...	1
FrxAPI::popData	public	function	Pop data off of the stack.
FrxAPI::pushData	public	function	Push data onto the Stack
FrxAPI::report	public	function	Run a report with a particular format.	1
FrxAPI::reportFileSystem	public	function	Get the current report file system.
FrxAPI::setDataContext	public	function	Set Data context by id.
FrxAPI::setDocument	public	function	Change to a specific document type.
FrxAPI::skins	public	function	Get list of skins.
FrxMenu::render	public	function	Default Render action, which simply does normal forena rendering. You can use renderDomNode at any time to generate the default forena rendering methods. Overrides RendererBase::render
RendererBase::$columns	public	property
RendererBase::$document	protected	property
RendererBase::$doc_types	public	property
RendererBase::$frxAttributes	public	property
RendererBase::$htmlAttributes	public	property
RendererBase::$id	public	property
RendererBase::$input_format	public	property
RendererBase::$name	public	property
RendererBase::$numeric_columns	public	property
RendererBase::$report	public	property
RendererBase::$reportDomNode	public	property
RendererBase::$reportNode	public	property
RendererBase::$xmlns	public	property
RendererBase::$xpathQuery	public	property
RendererBase::addAttributes	public static	function	Helper function for convergint methods to a standard associated array.
RendererBase::addFragment		function	Append a textual XHTML fragment to the dom. We do not use the DOMDocumentFragment optioin because they don't properly import namespaces. .
RendererBase::addNode		function	Add a node to the existing dom element with attributes
RendererBase::addText		function	Add a text node to the current dom node.
RendererBase::arrayAttributes	public	function	Puts attributes back in array format prior to rendering.
RendererBase::blockDiv	public	function	Generate generic div tag.
RendererBase::columns	public	function	Extract a list of columns from the data context.
RendererBase::configAjax	public	function	Generate ajax configuration attributes for use in template configurtion forms.
RendererBase::configValidate	public	function	Default configuration validator. Simply validates header and footer attributes.
RendererBase::drupalRender	public	function	Render a drupal form in a forena template
RendererBase::extract	public	function	Extract a configuration var removing it from the array
RendererBase::extractChildSource	public	function	Get the textual representations of html for the configuration engine.
RendererBase::extractSource	public	function	Get the textual representations of html for the configuration engine.
RendererBase::extractTemplateHTML	public	function	Get the textual representations of html for the configuration engine.
RendererBase::extractXPath	public	function	Extracts the inner html of all nodes that match a particular xpath expression.
RendererBase::extractXPathInnerHTML	public	function	Extracts the inner html of all nodes that match a particular xpath expression.
RendererBase::generate	public	function	Generate the template from the configuration.
RendererBase::idFromBlock	public	function	Simple function to get id from node.
RendererBase::initReportNode	public	function	This function is called to give the renderer the current conetxt in report rendering. It makes sure the renderer has the current DOM nodes dom documnent, and other attributes. Overrides RendererInterface::initReportNode
RendererBase::mergedAttributes	public	function	Standard php array containing merged attributes Enter description here ...
RendererBase::removeChildren	public	function	Rmove all the children of a dom node in the current report.
RendererBase::removeChildrenExcept	public	function	Removes all chidren from the dome node expect those with a tagname specified by the the $tags argurment
RendererBase::renderChildren	public	function
RendererBase::renderDomNode	public	function	Recursive report renderer Walks the nodes rendering the report.
RendererBase::replacedAttributes	public	function	Gives the token replaced attributes of a node.
RendererBase::replaceTokens	public	function	A helper function to allow replacement of tokens from inside a renderer wihout needing to understand the object
RendererBase::resetTemplate	public	function	Starting at the current report node, this function removes all child nodes. It aso removes any FRX attributes on the current as well.
RendererBase::scrapeConfig	public	function	Default method for extracting configuration information from the template. This just scrapes teh current child html as the template.
RendererBase::setAttributes	public	function	Set FRX attributes.
RendererBase::setFirstNode	public	function	Sets the first child element to a node and returns it. IF the node
RendererBase::validateTextFormats	public	function	Helper function for validating text_format type controls.
RendererBase::weight_sort	public	function	Sort a column list by weight.
RendererBase::weight_sort_comp	public static	function
RendererBase::write	public	function
RendererBase::xmlToValues	public	function	Convert XML to key value pairs. This is used in support of graping to get specific key/value pairs in an array format suitable for passing off to php libraries.
RendererBase::__construct	public	function	Overrides RendererInterface::__construct	1