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

Procedural File: siteFunctions.inc.php

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



Classes:



Page Details:



Includes:

require_once($APP['path']['applications'].'cms/Bs_Cms_BlockHtml.class.php') [line 3]
require_once($APP['path']['core'].'file/Bs_FileUtil.class.php') [line 10]
require_once($APP['path']['applications'].'cms/Bs_Cms_BlockTextType.class.php') [line 7]
require_once($APP['path']['core'].'file/Bs_Dir.class.php') [line 11]
require_once($APP['path']['applications'].'cms/Bs_Cms_BlockImage.class.php') [line 6]
require_once($APP['path']['applications'].'cms/Bs_Cms_BlockNav.class.php') [line 5]
require_once($APP['path']['applications'].'cms/Bs_Cms_BlockTable.class.php') [line 4]
require_once($APP['path']['core'].'util/Bs_IniHandler.class.php') [line 12]






dirHasPageIni [line 709]

bool dirHasPageIni( string $dir, [bool $hasLangCode = FALSE])

tells if the dir specified has a page.ini file.

only such dirs are considered real pages, but even without such an ini file a dir can have content blocks.




Parameters

string   $dir  
bool   $hasLangCode   (if the dir has a language code prefix or not. like "/de/".)
[ Top ]



findBestBlock [line 727]

string findBestBlock( [string $dirVirtual = NULL], [string $name = NULL], [string $version = NULL], [string $language = NULL], [string $type = NULL])

finds the best match for the block specified.



Tags:

return:  (full path)
throws:  bool FALSE


Parameters

string   $dirVirtual  
string   $name  
string   $version  
string   $language  
string   $type  
[ Top ]



getIniContent [line 677]

mixed getIniContent( string $fullPath, [string $group = NULL], [string $key = NULL])

returns the content of an ini file as array.

also works on $ vars (variables as values) if you specify a group, but no key.




Tags:

return:  (array or string, depending on params)


Parameters

string   $fullPath   (of ini file)
string   $group   (default = all groups)
string   $key   (default = all keys)
[ Top ]



getMainLayoutName [line 20]

string getMainLayoutName( string $pageUrl)



Parameters

string   $pageUrl   (like '/foo/bar/')
[ Top ]



getNavigationData [line 76]

array getNavigationData( [mixed $language = FALSE])

returns the navigation data array as it is used to render the main nav.



Tags:

return:  (boxed hash)
throws:  bool FALSE;
see:  getPageList()


Parameters

mixed   $language   (string like 'en', or bool FALSE means none.)
[ Top ]



getPageList [line 142]

array getPageList( [bool $nested = FALSE])

creates a list of all pages and returns it.

directories that exist but are not cms-pages won't be listed. but they are followed in case there is a valid page in a sub-folder.




Tags:

return:  (vector filled with url strings)
see:  getNavigationData()


Parameters

bool   $nested  
[ Top ]



getSiteColorName [line 63]

void getSiteColorName( )



[ Top ]



getSiteColors [line 42]

void getSiteColors( )



[ Top ]



getSiteSettings [line 36]

void getSiteSettings( )



[ Top ]



getSiteTemplateName [line 58]

void getSiteTemplateName( )



[ Top ]



glueBlockName [line 646]

void glueBlockName( mixed $parsedBlockName)



[ Top ]



listContentLayouts [line 172]

array listContentLayouts( [string $templatePath = NULL])



Parameters

string   $templatePath   (by default we use the current one.)
[ Top ]



parseBlockName [line 636]

array parseBlockName( string $blockName)

takes a blockName and parses it into its junks.

the returned hash has these keys: 'name' 'version' 'language' 'type'

example: title1.1.de.textType.block.php | | | | name | language | version type




Tags:

return:  (hash, see above)


Parameters

string   $blockName  
[ Top ]



parseTemplateGetBlocks [line 208]

array parseTemplateGetBlocks( string $template, [string $type = 'path'])

parses the template and finds all blocks. returns the attributes of those in an array.



Tags:

return:  (vector with hashes)
throws:  bool FALSE


Parameters

string   $template   (can be a fullpath or the string. see param $type.)
string   $type   (default is 'path', can be 'string'.
[ Top ]



parseTemplateRenderPage [line 307]

string parseTemplateRenderPage( string $template, [string $type = 'path'])

parses and works on the template specified. returns the rendered page.



Parameters

string   $template   (can be a fullpath or the string. see param $type.)
string   $type   (default is 'path', can be 'string'.
[ Top ]



removeLanguageCodeFromNavData [line 100]

void removeLanguageCodeFromNavData( array &$data)

calls itself recursively.



Tags:



Parameters

array   &$data  
[ Top ]



removeUrlAddRadioOnNavData [line 119]

array removeUrlAddRadioOnNavData( array &$data)

this is used for the addpage page.

calls itself recursively.




Tags:



Parameters

array   &$data  
[ Top ]



texttypeCaptionToFilename [line 655]

sting texttypeCaptionToFilename( string $caption)

takes a string and makes a filename for the texttype functionality.



Tags:

return:  (cleaned to use as file name)


Parameters

string   $caption  
[ Top ]



_parseTemplateRenderPageHelper [line 399]

void _parseTemplateRenderPageHelper( mixed $prop)



[ Top ]



Documentation generated on Mon, 29 Dec 2003 21:16:02 +0100 by phpDocumentor 1.2.3