blueshoes php application framework and cms            applications_cms
[ class tree: applications_cms ] [ index: applications_cms ] [ all elements ]

Procedural File: Bs_KickOff.inc.php

Source Location: /applications/cms/Bs_KickOff.inc.php



Classes:



Page Details:

********************************************************************************

Kick Off with Blueshoes ********************************************************************************** ---------------------------- Point of entry ---------------------------------




Tags:

pattern:  

singleton: (pseudostatic)

This is the entry point. Set up environment and handle request.

access:  public
version:  4.3.$Revision: 1.2 $ $Date: 2003/08/09 15:22:34 $
author:  andrej arn <at blueshoes dot org>, Sam Blum <sam at blueshoes dot org>


Includes:

require_once($APP['path']['core'].'lang/Bs_Logger.class.php') [line 69]
require_once("../../offline.conf.php") [line 65]
require_once('../../global.conf.php') [line 50]
require_once($APP['path']['core'].'cms/Bs_Renderer.class.php') [line 277]
require_once($APP['path']['core'].'cms/Bs_Node.class.php') [line 243]
-------------------------- NODE HANDLING --------------------------

If we reach this point the request was to a dir (a node) and not to a file. So let's dive into the BS-system. NOTE: The node may or may not exsist any more. It's part of the Node object to handle that.


require_once($APP['path']['core'].'Bs_RelativeEnvironment.lib.php') [line 53]
require_once("../../online.conf.php") [line 63]






addSessionID [line 609]

string addSessionID( string $url)

adds the session id to the given url and returns it.



Tags:

todo:  write code


Parameters

string   $url  
[ Top ]



didYouMean [line 570]

array didYouMean( string $url404)

returns the active urls that are similar to the given one.



Tags:

return:  (vector, may be empty if nothing found.)
see:  Bs_Url::similar()


Parameters

string   $url404   the url that caused a 404 not found.
[ Top ]



errorRenderAndExit [line 473]

void errorRenderAndExit( int $errorCode, [int $bsAddErrorCode = 0], [array $addInfo = array()])

returns an error document to the client and terminates the script execution.



Parameters

int   $errorCode   (like 404 etc)
int   $bsAddErrorCode   (0, 1, 2, ...) default is 0.
array   $addInfo   (vector or hash of additional information to render the page, if available/neened.)
[ Top ]



getBestLanguageFile [line 378]

string getBestLanguageFile( string $relativePath, int $errorCode, int $bsAddErrorCode, string $lang)

tells which file matches best. used for error documents.



Tags:

return:  the absolute path
throws:  bool FALSE


Parameters

string   $relativePath   (eg '/some/dir/')
int   $errorCode   something like 404, 500 etc
int   $bsAddErrorCode  
string   $lang   the iso-code
[ Top ]



getBestLanguagePart [line 635]

mixed getBestLanguagePart( mixed $source, [mixed $default = ''])

returns the best language match partof the given source for the current request.

eg you have string "en:hello world;de:hallo welt" or array('en'=>'hello world', 'de'=>'hallo welt') and you want the best language thing for the user that requested the page in german. then this will return string 'hallo welt'.

special cases: 1) no lang defined, eg string "hello world" will be returned equally as passed. this rule does not apply for arrays, only for alphanumeric things like string.

this function uses $GLOBALS['bsEnv'] 'uriLang' and 'uriLangBase'.




Tags:

return:  (usually a string, may be anything else, see param $default)


Parameters

mixed   $source   (hash or string, see above)
mixed   $default   the default value you want returned if nothing matched at all. default is ''. (may be null, array() or whatever)
[ Top ]



Documentation generated on Mon, 29 Dec 2003 21:11:38 +0100 by phpDocumentor 1.2.3