Class Horde_Themes
The Horde_Themes:: class provides an interface to handling Horde themes.
Copyright 2010-2012 Horde LLC (http://www.horde.org/)
See the enclosed file COPYING for license information (LGPL). If you
did not receive this file, see http://www.horde.org/licenses/lgpl21.
Methods summary
public static
Horde_Themes_Image
|
#
img( string $name = null, mixed $options = array() )
Return the path to an image, using the default image if the image does
not exist in the current theme.
Return the path to an image, using the default image if the image does
not exist in the current theme.
Parameters
- $name
- <p>The image name. If null, will return the image
directory.</p>
- $options
- <p>Additional options. If a string, is taken to be
the 'app' parameter. If an array, the following
options are available:</p>
<pre><span class="php-quote">'app'</span> - (string) <span class="php-keyword1">Use</span> this application instead of the <span class="php-keyword2">current</span> app.
<span class="php-quote">'nohorde'</span> - (boolean) <span class="php-keyword1">If</span> <span class="php-keyword1">true</span>, <span class="php-keyword1">do</span> not fallback to horde <span class="php-keyword1">for</span> image.
<span class="php-quote">'theme'</span> - (string) <span class="php-keyword1">Use</span> this theme instead of the Horde <span class="php-keyword1">default</span>.</pre>
Returns
|
public static
Horde_Themes_Sound
|
#
sound( string $name = null, mixed $options = array() )
Return the path to a sound, using the default sound if the sound does
not exist in the current theme.
Return the path to a sound, using the default sound if the sound does
not exist in the current theme.
Parameters
- $name
- <p>The sound name. If null, will return the sound
directory.</p>
- $options
- <p>Additional options. If a string, is taken to be
the 'app' parameter. If an array, the following
options are available:</p>
<pre><span class="php-quote">'app'</span> - (string) <span class="php-keyword1">Use</span> this application instead of the <span class="php-keyword2">current</span> app.
<span class="php-quote">'nohorde'</span> - (boolean) <span class="php-keyword1">If</span> <span class="php-keyword1">true</span>, <span class="php-keyword1">do</span> not fallback to horde <span class="php-keyword1">for</span> sound.
<span class="php-quote">'theme'</span> - (string) <span class="php-keyword1">Use</span> this theme instead of the Horde <span class="php-keyword1">default</span>.</pre>
Returns
|
public static
array
|
#
themeList( )
Returns a list of available themes.
Returns a list of available themes.
Returns
array
Keys are theme names, values are theme descriptions.
Throws
UnexpectedValueException
|
public static
array
|
#
soundList( string $app = null, string $theme = null )
Returns a list of available sounds.
Returns a list of available sounds.
Parameters
- $app
- The app to search in.
- $theme
- The app to search in.
Returns
arrayAn array of Horde_Themes_Sound objects. Keys are the
base filenames.
|
public static
string
|
#
getFeedXsl( )
Return the location of the feed XSL file.
Return the location of the feed XSL file.
As of now, this file MUST live in horde/themes/default/feed-rss.xsl.
Returns
string
Path to the feed file.
|