Current File : //home1/lightco1/public_html/lightingrepublic.com.au/libraries/koowa/service/interface.php
<?php
/**
* @version $Id$
* @package Koowa_Service
* @copyright Copyright (C) 2007 - 2012 Johan Janssens. All rights reserved.
* @license GNU GPLv3 <http://www.gnu.org/licenses/gpl.html>
* @link http://www.nooku.org
*/
/**
* Factory Interface
*
* @author Johan Janssens <johan@nooku.org>
* @package Koowa_Service
*/
interface KServiceInterface
{
/**
* Get an instance of a class based on a class identifier only creating it
* if it doesn't exist yet.
*
* @param string|object The class identifier or identifier object
* @param array An optional associative array of configuration settings.
* @throws KServiceServiceException
* @return object Return object on success, throws exception on failure
*/
public static function get($identifier, array $config = array());
/**
* Insert the object instance using the identifier
*
* @param mixed The class identifier
* @param object The object instance to store
*/
public static function set($identifier, $object);
/**
* Check if the object instance exists based on the identifier
*
* @param mixed The class identifier
* @return boolean Returns TRUE on success or FALSE on failure.
*/
public static function has($identifier);
/**
* Set a mixin or an array of mixins for an identifier
*
* The mixins are mixed when the indentified object is first instantiated see {@link get}
* Mixins are also added to objects that already exist in the object registry.
*
* @param string|object An identifier string or KIdentfier object
* @param string|array A mixin identifier or a array of mixin identifiers
* @see KObject::mixin
*/
public static function addMixin($identifier, $mixins);
/**
* Get the mixins for an identifier
*
* @param string|object An identifier string or KIdentfier object
* @return array An array of mixins
*/
public static function getMixins($identifier);
/**
* Returns an identifier object.
*
* Accepts various types of parameters and returns a valid identifier. Parameters can either be an
* object that implements KObjectServiceable, or a KServiceIdentifier object, or valid identifier
* string. Function will also check for identifier mappings and return the mapped identifier.
*
* @param mixed An object that implements KObjectServiceable, KServiceIdentifier object
* or valid identifier string
* @return KServiceIdentifier
*/
public static function getIdentifier($identifier);
/**
* Set the configuration options for an identifier
*
* @param mixed An object that implements KObjectServiceable, KServiceIdentifier object
* or valid identifier string
* @param array An associative array of configuration options
*/
public static function setConfig($identifier, array $config);
/**
* Get the configuration options for an identifier
*
* @param mixed An object that implements KObjectServiceable, KServiceIdentifier object
* or valid identifier string
* @param array An associative array of configuration options
*/
public static function getConfig($identifier);
/**
* Get the configuration options for all the identifiers
*
* @return array An associative array of configuration options
*/
public static function getConfigs();
/**
* Set an alias for an identifier
*
* @param string The alias
* @param mixed The class indentifier or identifier object
*/
public static function setAlias($alias, $identifier);
/**
* Get an alias for an identifier
*
* @param string The alias
* @return mixed The class indentifier or identifier object, or NULL if no alias was found.
*/
public static function getAlias($alias);
/**
* Get a list of aliasses
*
* @return array
*/
public static function getAliases();
}
Mini Shell