Documentation

Horde_Themes_Sound extends Horde_Themes_Element
in package

The Horde_Themes_Sound:: class provides an object-oriented interface to a themed sound.

Copyright 2010-2017 Horde LLC (http://www.horde.org/)

See the enclosed file LICENSE for license information (LGPL). If you did not receive this file, see http://www.horde.org/licenses/lgpl21.

Tags
author

Michael Slusarz slusarz@horde.org

category

Horde

Table of Contents

Properties

$app  : string
Current application name.
$fs  : string
$fulluri  : string
$uri  : string
$_data  : array<string|int, mixed>
URI/filesystem path values.
$_dirname  : string
The default directory name for this element type.
$_name  : string
Element name.
$_opts  : array<string|int, mixed>
Options.

Methods

__construct()  : mixed
Constructor.
__get()  : mixed
__toString()  : string
String representation of this object.
fromUri()  : Horde_Themes_Element
Convert a URI into a Horde_Themes_Element object.

Properties

$app

Current application name.

public string $app

$fs read-only

public string $fs

Filesystem location.

$fulluri read-only

public string $fulluri

Full URI.

$uri read-only

public string $uri

Relative URI.

$_data

URI/filesystem path values.

protected array<string|int, mixed> $_data = array()

$_dirname

The default directory name for this element type.

protected string $_dirname = 'sounds'

$_name

Element name.

protected string $_name

$_opts

Options.

protected array<string|int, mixed> $_opts

Methods

__construct()

Constructor.

public __construct([string $name = '' ][, array<string|int, mixed> $options = array() ]) : mixed
Parameters
$name : string = ''

The element name. If null, will return the element directory.

$options : array<string|int, mixed> = array()

Additional options:

  • app: (string) Use this application instead of the current app.
  • data: (array) Contains 2 elements: 'fs' - filesystem path, 'uri' - the element URI. If set, use as the data values instead of auto determining.
  • nohorde: (boolean) If true, do not fallback to horde for element.
  • noview: (boolean) If true, do not load images from view-specific directories. (Since 2.4.0)
  • theme: (string) Use this theme instead of the Horde default.
  • uri: (string) Use this as the URI value.

__get()

public __get(mixed $name) : mixed
Parameters
$name : mixed

__toString()

String representation of this object.

public __toString() : string
Return values
string

The relative URI.


        
On this page

Search results