Hub::Base::Config

- NAME
- SYNOPSIS
- DESCRIPTION
- METHODS
- INTERNAL
- AUTHOR
- COPYRIGHT
- UPDATED

# NAME

Hub::Base::Config -

Part of the Hub Library

Top

# SYNOPSIS

Top

# DESCRIPTION

Top

# METHODS

addSourcePath | getImagePath | getWorkingDirs | popWorkingDir | setConst
addTargetSourcePath | getProps | init | pushWorkingDir | swapWorkingDirs
get | getResource | loadConfigDir | refresh
getCommonImagePath | getResourcePath | loadConfigFile | rmSourcePath
getConst | getSourcePath | new | rmTargetSourcePath

addSourcePath

        Add a path to the list of source paths.  Call's to the getSourcePath()
        will get files from these added paths.

        Paths are added to the beginning of the list, thus having precedence to
        existing paths.

        $class->addSourcePath( path )

addTargetSourcePath

  addTargetPath( $path )

  Add a path to the list of target paths. Call's to the `getSourcePath()` will get files from these added paths.

  Paths are added to the beginning of the list, thus having precedence to existing paths.

get

        Retreive a runtime constant

        $class->get( "key:subkey:subsubkey" );
        $class->get( "key", "default" );

getCommonImagePath

getConst

        Retreive a runtime constant

        $class->getConst( key )
        $class->getConst( key, default )

getImagePath

  get a path to an existing image. first try the website path, then the common one.

getProps

       Usage: getProps

  return the properties hash reference

getResource

       Usage: getResource( $type, $name, $filename )

  Find the relative path to the specified resource.

        $type       Can be 'sound', 'image', 'video', or 'data'
        $name       Is the source name such as: 'img-logo-main'
        $filename   Is the filename of the resource.

  If $name is empty, we will look in the base directory of all locations.

  If $filename is empty, we will return the first matching directory.

getResourcePath

getSourcePath

getWorkingDirs

init

loadConfigDir

loadConfigFile

new

popWorkingDir

pushWorkingDir

refresh

       Usage: refresh()

  Throughout the life of a request, many things get shoved in here. Like screen values and user preferences. Hence, this method to re-init is called at the beginning of each request. Which is good, since it also re-reads the *.conf files from disk if they have been modified.

rmSourcePath

  Remove a source path

rmTargetSourcePath

  Remove a target source path

setConst

        Retreive a runtime constant

        $class->setConst( key, value )

swapWorkingDirs

Top

# INTERNAL

Top

# AUTHOR

Ryan Gies

Top

# COPYRIGHT

Copyright (c) 2006 Livesite Networks, LLC. All rights reserved.

Copyright (c) 2000-2005 Ryan Gies. All rights reserved.

Top

# UPDATED

This file created by on at

Top