VuFind API Documentation

Channels
in package
implements ContentBlockInterface

Channels content block.

Tags
category

VuFind

author

Demian Katz demian.katz@villanova.edu

license

http://opensource.org/licenses/gpl-2.0.php GNU General Public License

link

Wiki

Interfaces, Classes, Traits and Enums

ContentBlockInterface
Content block interface

Table of Contents

$loader  : ChannelLoader
Channel loader
$request  : Request
Request object
$source  : string
Data source (null to use default found in channels.ini)
__construct()  : mixed
Constructor
getContext()  : array<string|int, mixed>
Return context variables used for rendering the block's template.
setConfig()  : void
Store the configuration of the content block.

Properties

$request

Request object

protected Request $request

$source

Data source (null to use default found in channels.ini)

protected string $source = null

Methods

__construct()

Constructor

public __construct(Request $request, ChannelLoader $loader) : mixed
Parameters
$request : Request

Request object

$loader : ChannelLoader

Channel loader

Return values
mixed —

getContext()

Return context variables used for rendering the block's template.

public getContext() : array<string|int, mixed>
Return values
array<string|int, mixed> —

setConfig()

Store the configuration of the content block.

public setConfig(string $settings) : void
Parameters
$settings : string

Settings from searches.ini.

Return values
void —

Search results