Documentation

Horde_Script_File
in package

This class represents a javascript script file to output to the browser.

Tags
author

Michael Slusarz slusarz@horde.org

category

Horde

copyright

2012-2017 Horde LLC

license

http://www.horde.org/licenses/lgpl21 LGPL 2.1

Table of Contents

Constants

PRIORITY_HIGH  = 1
Priority constants.
PRIORITY_LOW  = 3
PRIORITY_NORMAL  = 2

Properties

$app  : string
$cache  : string
The cache group this file should be output in.
$file  : string
$full_path  : string
$hash  : string
$jsvars  : array<string|int, mixed>
Javascript variables that should be output to the page.
$modified  : int
$path  : string
$priority  : int
$tag  : string
$tag_full  : string
$uncompressed  : Horde_Script_File
$url  : Horde_Url
$url_full  : Horde_Url
$_app  : string
Application.
$_file  : string
Filename.
$_priority  : int
Priority.

Methods

__construct()  : mixed
Adds a single javascript script to the output (if output has already started), or to the list of script files to include in the output.
__get()  : mixed
__set()  : mixed
__toString()  : mixed
_url()  : Horde_Url
Create a static javascript URL.

Constants

PRIORITY_HIGH

Priority constants.

public mixed PRIORITY_HIGH = 1

PRIORITY_LOW

public mixed PRIORITY_LOW = 3

PRIORITY_NORMAL

public mixed PRIORITY_NORMAL = 2

Properties

$app read-only

public string $app

Application.

$cache

The cache group this file should be output in.

public string $cache = 'default'

$file read-only

public string $file

Filename.

$full_path read-only

public string $full_path

Full path to file on filesystem.

$hash read-only

public string $hash

Hash value of this file.

$jsvars

Javascript variables that should be output to the page.

public array<string|int, mixed> $jsvars = array()

$modified read-only

public int $modified

Last modification time of the file.

$path read-only

public string $path

Full filesystem path to script.

$priority

public int $priority

Script priority

$tag read-only

public string $tag

HTML script tag to relative URL.

$tag_full read-only

public string $tag_full

HTML script tag to full URL.

$uncompressed read-only

public Horde_Script_File $uncompressed

Return the object representing the uncompressed script.

$url read-only

public Horde_Url $url

URL to script.

$url_full read-only

public Horde_Url $url_full

Full URL to script.

$_app

Application.

protected string $_app

$_file

Filename.

protected string $_file

$_priority

Priority.

protected int $_priority = self::PRIORITY_NORMAL

Methods

__construct()

Adds a single javascript script to the output (if output has already started), or to the list of script files to include in the output.

public __construct(string $file[, string $app = null ]) : mixed
Parameters
$file : string

The full javascript file name.

$app : string = null

The application name. Defaults to the current application.

__get()

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

__set()

public __set(mixed $name, mixed $value) : mixed
Parameters
$name : mixed
$value : mixed

__toString()

public __toString() : mixed

_url()

Create a static javascript URL.

protected _url(string $file, bool $full) : Horde_Url
Parameters
$file : string

File name.

$full : bool

Return full URL?

Return values
Horde_Url

URL.


        
On this page

Search results