This is the API documentation for concrete5 version 5.6 and earlier. View Current API Documentation

Class Concrete5_Library_BlockView

An object corresponding to a particular view of a block. These are those of the "add" state, the block's "edit" state, or the block's "view" state.

View
Extended by Concrete5_Library_BlockView

Direct known subclasses

BlockView

Package: Blocks
Category: Concrete
Copyright: Copyright (c) 2003-2008 Concrete5. (http://www.concrete5.org)
License: MIT License
Author: Andrew Embler andrew@concrete5.org
Located at core/libraries/block_view.php

Methods summary

public
# renderElement( $element, $args = array() )

Includes a file from the core elements directory. Used by the CMS.

public string
# action( string $task, strign $extraParams = null )

Creates a URL that can be posted or navigated to that, when done so, will automatically run the corresponding method inside the block's controller.

<a href="<?=$this->action('get_results')?>">Get the results</a>
public
# inc( string $file, array $args = array() )

includes file from the current block directory. Similar to php's include()

public string
# getBlockPath( $filename = null )

Returns the path to the current block's directory

public string
# getBlockURL( $filename = null )

Returns a relative path to the current block's directory. If a filename is specified it will be appended and searched for as well.

public
public
public
# getTemplate( )

Returns the template used in the block view

public
public
# setBlockObject( $obj )
public
public
# render( Block $obj, string $view = 'view', array $args = array() )

Renders a particular view for a block or a block type

Properties summary

protected $block
#
protected $area
#
protected $blockObj
#