Class: KServiceIdentifier

Source Location: /libraries/koowa/service/identifier/identifier.php

Class Overview

Service Identifier

Author(s):

Johan Janssens <johan@nooku.org>

Implements interfaces:

KServiceIdentifierInterface

Variables

Methods

Class Details

[line 20]
Service Identifier

Wraps identifiers of the form [application::]type.package.[.path].name in an object, providing public accessors and methods for derived formats.

Tags:

author:	Johan Janssens <johan@nooku.org>
usedby:	KService

[ Top ]

Class Variables

static $_applications = array()

[line 27]

An associative array of application paths

Tags:

access:

protected

Type:

array

[ Top ]

static $_locators = array()

[line 34]

Associative array of identifier adapters

Tags:

access:

protected

Type:

array

[ Top ]

$_application = ''

[line 48]

The application name

Tags:

access:

protected

Type:

string

[ Top ]

$_basepath = ''

[line 97]

The base path

Tags:

access:

protected

Type:

string

[ Top ]

$_classname = ''

[line 90]

The classname

Tags:

access:

protected

Type:

string

[ Top ]

$_filepath = ''

[line 83]

The file path

Tags:

access:

protected

Type:

string

[ Top ]

$_identifier = ''

[line 41]

The identifier

Tags:

access:

protected

Type:

string

[ Top ]

$_name = ''

[line 76]

The identifier object name

Tags:

access:

protected

Type:

string

[ Top ]

$_package = ''

[line 62]

The identifier package

Tags:

access:

protected

Type:

string

[ Top ]

$_path = array()

[line 69]

The identifier path

Tags:

access:

protected

Type:

array

[ Top ]

$_type = ''

[line 55]

The identifier type [com|plg|mod]

Tags:

access:

protected

Type:

string

[ Top ]

Class Methods

static method addLocator [line 216]

static void addLocator(
KServiceLocatorInterface
$locator)

Add a identifier adapter

Tags:

access:

public

Parameters:

object A

$locator

KServiceLocator

[ Top ]

static method getApplication [line 195]

static string getApplication(
string
$application)

Get an application path

Tags:

return:	The path of the application
access:	public

Parameters:

string

$application

The name of the application

[ Top ]

static method getApplications [line 205]

static array getApplications(
)

Get a list of applications

Tags:

access:

public

[ Top ]

static method getLocators [line 226]

static array getLocators(
)

Get the registered adapters

Tags:

access:

public

[ Top ]

static method setApplication [line 184]

static void setApplication(
string
$application, string
$path)

Set an application path

Tags:

access:

public

Parameters:

string	$application	The name of the application
string	$path	The path of the application

[ Top ]

constructor __construct [line 105]

KServiceIdentifier __construct(
string
$identifier)

Constructor

Tags:

throws:	KServiceIdentifierException if the identfier is not valid
access:	public

Parameters:

string

$identifier

Identifier string or object in [application::]type.package.[.path].name format

[ Top ]

method serialize [line 146]

string serialize(
)

Serialize the identifier

Tags:

return:	The serialised identifier
access:	public

[ Top ]

method unserialize [line 168]

string unserialize(

$data)

Unserialize the identifier

Tags:

return:	The serialised identifier
access:	public

Parameters:

$data

[ Top ]

method __get [line 287]

array &__get(
string
$property)

Implements access to virtual properties by reference so that it appears to be a public property.

Tags:

return:	The value of the virtual property.
access:	public

Parameters:

string

$property

The virtual property to return.

[ Top ]

method __isset [line 309]

boolean __isset(
string
$property)

This function checks if a virtual property is set.

Tags:

return:	True if it exists otherwise false.
access:	public

Parameters:

string

$property

The virtual property to return.

[ Top ]

method __set [line 239]

void __set(
string
$property, string
$value)

Implements the virtual class properties

This functions creates a string representation of the identifier.

Tags:

access:

public

Parameters:

string	$property	The virtual property to set.
string	$value	Set the virtual property to this value.

[ Top ]

method __toString [line 319]

string __toString(
)

Formats the indentifier as a [application::]type.package.[.path].name string