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

Element index for package core_file

[ a ] [ b ] [ c ] [ d ] [ e ] [ f ] [ g ] [ h ] [ i ] [ l ] [ m ] [ o ] [ p ] [ r ] [ s ] [ t ] [ w ] [ x ] [ _ ]

_

$_Bs_System
in file Bs_FileSystem.class.php, variable Bs_FileSystem::$_Bs_System
    pseudostatic instance of Bs_System.
$_determineFileNameHash
in file Bs_FileCache.class.php, variable Bs_FileCache::$_determineFileNameHash
$_dirObj
in file Bs_Dir.class.php, variable Bs_Dir::$_dirObj
    PHP's pseudo-Directory-Object used to scan the file system.
$_lastFetchedFileAttr
in file Bs_FileSystem.class.php, variable Bs_FileSystem::$_lastFetchedFileAttr
_addToFiFo
in file Bs_FileCache.class.php, method Bs_FileCache::_addToFiFo()
    Add $cacheBlock to fifo-array
_determinePathToCache
in file Bs_FileCache.class.php, method Bs_FileCache::_determinePathToCache()
    Determine the cache-dir from the origin-dir and makes the cache name.
_fifoFreeSpace
in file Bs_FileCache.class.php, method Bs_FileCache::_fifoFreeSpace()
    Free up the fifo-array until $sizeOfNewData fits in.
_fifoGarbageCollect
in file Bs_FileCache.class.php, method Bs_FileCache::_fifoGarbageCollect()
    Get rid of entries in the fifo-array that are marked invalid
_getFiFoIndex
in file Bs_FileCache.class.php, method Bs_FileCache::_getFiFoIndex()
    Find the index of the fifo-array matching $filePath
_isCacheFileUptodate
in file Bs_FileCache.class.php, method Bs_FileCache::_isCacheFileUptodate()
    'Up To Date' - checking: It is assumed that the passed 'data stream' has it's origin in data file that was crunched (or parsed or whatever) and that the cache is valid as long as the 'origin-file' exits and is not modified.
_readCacheFile
in file Bs_FileCache.class.php, method Bs_FileCache::_readCacheFile()
    Read cache
_writeCacheFile
in file Bs_FileCache.class.php, method Bs_FileCache::_writeCacheFile()
    Write cache
top

a

append
in file Bs_File.class.php, method Bs_File::append()
top

b

basename
in file Bs_FileSystem.class.php, method Bs_FileSystem::basename()
    returns the base name of a path (filename).
Bs_Dir
in file Bs_Dir.class.php, method Bs_Dir::Bs_Dir()
    * Constructor.
Bs_Dir
in file Bs_Dir.class.php, class Bs_Dir
    Directory Class.
BS_DIR_UNLIM_DEPTH
in file Bs_Dir.class.php, constant BS_DIR_UNLIM_DEPTH
BS_DIR_VERSION
in file Bs_Dir.class.php, constant BS_DIR_VERSION
Bs_File
in file Bs_File.class.php, class Bs_File
    * Represents a FILE (or a DIRECTORY?) as an Object
Bs_File
in file Bs_File.class.php, method Bs_File::Bs_File()
    Constructor.
Bs_FileCache
in file Bs_FileCache.class.php, class Bs_FileCache
    File Cache Class.
Bs_FileCache
in file Bs_FileCache.class.php, method Bs_FileCache::Bs_FileCache()
    Constructor.
Bs_FILECACHE_VERSION
in file Bs_FileCache.class.php, constant Bs_FILECACHE_VERSION
BS_FILECONVERTEREXCEL_VERSION
in file Bs_FileConverterExcel.class.php, constant BS_FILECONVERTEREXCEL_VERSION
BS_FILECONVERTERPDF_VERSION
in file Bs_FileConverterPdf.class.php, constant BS_FILECONVERTERPDF_VERSION
BS_FILECONVERTER_VERSION
in file Bs_FileConverter.class.php, constant BS_FILECONVERTER_VERSION
Bs_FileSystem
in file Bs_FileSystem.class.php, method Bs_FileSystem::Bs_FileSystem()
    * Constructor.
Bs_FileSystem
in file Bs_FileSystem.class.php, class Bs_FileSystem
    FileSystem Basic filesystem class. gets extended by Bs_File and Bs_Dir.
BS_FILESYSTEM_VERSION
in file Bs_FileSystem.class.php, constant BS_FILESYSTEM_VERSION
Bs_FileUtil
in file Bs_FileUtil.class.php, method Bs_FileUtil::Bs_FileUtil()
    * Constructor.
Bs_FileUtil
in file Bs_FileUtil.class.php, class Bs_FileUtil
    file helper class. not sure if i should start another class or if i should throw this into bs_file.
BS_FILEUTIL_VERSION
in file Bs_FileUtil.class.php, constant BS_FILEUTIL_VERSION
BS_FILE_VERSION
in file Bs_File.class.php, constant BS_FILE_VERSION
Bs_Dir.class.php
procedural page Bs_Dir.class.php
Bs_FileCache.class.php
procedural page Bs_FileCache.class.php
Bs_FileSystem.class.php
procedural page Bs_FileSystem.class.php
Bs_FileUtil.class.php
procedural page Bs_FileUtil.class.php
Bs_File.class.php
procedural page Bs_File.class.php
Bs_FileConverterExcel.class.php
procedural page Bs_FileConverterExcel.class.php
Bs_FileConverterPdf.class.php
procedural page Bs_FileConverterPdf.class.php
Bs_FileConverter.class.php
procedural page Bs_FileConverter.class.php
Bs_FileConverter
in file Bs_FileConverter.class.php, class Bs_FileConverter (subpackage: converter)
    Pseudostatic utility class to convert files from one format to another.
Bs_FileConverter
in file Bs_FileConverter.class.php, method Bs_FileConverter::Bs_FileConverter() (subpackage: converter)
Bs_FileConverterExcel
in file Bs_FileConverterExcel.class.php, method Bs_FileConverterExcel::Bs_FileConverterExcel() (subpackage: converter)
    constructor.
Bs_FileConverterExcel
in file Bs_FileConverterExcel.class.php, class Bs_FileConverterExcel (subpackage: converter)
    Pseudostatic utility class to convert files from one format to another.
Bs_FileConverterPdf
in file Bs_FileConverterPdf.class.php, method Bs_FileConverterPdf::Bs_FileConverterPdf() (subpackage: converter)
    constructor.
Bs_FileConverterPdf
in file Bs_FileConverterPdf.class.php, class Bs_FileConverterPdf (subpackage: converter)
    Pseudostatic utility class to convert files from one format to another.
top

c

clearBuffer
in file Bs_FileCache.class.php, method Bs_FileCache::clearBuffer()
    Clear the memory buffer (All or just one entry)
clearCache
in file Bs_Dir.class.php, method Bs_Dir::clearCache()
countLinesDir
in file Bs_FileUtil.class.php, method Bs_FileUtil::countLinesDir()
    counts the lines in all files in a directory, even recursive if you want.
countLinesFile
in file Bs_FileUtil.class.php, method Bs_FileUtil::countLinesFile()
    counts the lines in the file specified.
cp
in file Bs_File.class.php, method Bs_File::cp()
    * Copy the current file.
cp
in file Bs_Dir.class.php, method Bs_Dir::cp()
    copies a file or directory. if it's a dir then $this->cpDir() will be called.
cpDir
in file Bs_Dir.class.php, method Bs_Dir::cpDir()
    copies a directory recursively.
create
in file Bs_Dir.class.php, method Bs_Dir::create()
create
in file Bs_File.class.php, method Bs_File::create()
capable
in file Bs_FileConverterPdf.class.php, method Bs_FileConverterPdf::capable() (subpackage: converter)
    Tells whether we can do a conversion or not.
capable
in file Bs_FileConverterExcel.class.php, method Bs_FileConverterExcel::capable() (subpackage: converter)
    Tells whether we can do a conversion or not.
capable
in file Bs_FileConverter.class.php, method Bs_FileConverter::capable() (subpackage: converter)
    Tells whether we can do a conversion or not.
top

d

decodeFilename
in file Bs_FileUtil.class.php, method Bs_FileUtil::decodeFilename()
destruct
in file Bs_Dir.class.php, method Bs_Dir::destruct()
    destructor.
top

e

emptyDir
in file Bs_Dir.class.php, method Bs_Dir::emptyDir()
    removes files from the directory. keeps the directory.
encodeFilename
in file Bs_FileUtil.class.php, method Bs_FileUtil::encodeFilename()
exclusiveWrite
in file Bs_File.class.php, method Bs_File::exclusiveWrite()
    Exclusive file write.
top

f

fetch
in file Bs_FileCache.class.php, method Bs_FileCache::fetch()
    Fetch the data stream that was once pushed into the cache.
flushFileCache
in file Bs_FileCache.class.php, method Bs_FileCache::flushFileCache()
    kills all cached file content.
top

g

getCwd
in file Bs_FileSystem.class.php, method Bs_FileSystem::getCwd()
    Gets the current process working directory by using PHP's getcwd() and converting the result to our standard.
getFileAttr
in file Bs_FileSystem.class.php, method Bs_FileSystem::getFileAttr()
    Return most of the file attribute info. (Should work with Windows too).
getFileExtension
in file Bs_FileSystem.class.php, method Bs_FileSystem::getFileExtension()
    Get the file extension from a path.
getFileList
in file Bs_Dir.class.php, method Bs_Dir::getFileList()
    Get a list of files and dirs.
getFileName
in file Bs_FileSystem.class.php, method Bs_FileSystem::getFileName()
getFreeDiskSpace
in file Bs_Dir.class.php, method Bs_Dir::getFreeDiskSpace()
getFullPath
in file Bs_FileSystem.class.php, method Bs_FileSystem::getFullPath()
    returns the directory or file that this object (subclassed file or dir object) is looking at.
getLastModified
in file Bs_FileCache.class.php, method Bs_FileCache::getLastModified()
getMimeType
in file Bs_FileUtil.class.php, method Bs_FileUtil::getMimeType()
    returns the mime type for a file type.
getPathStem
in file Bs_FileSystem.class.php, method Bs_FileSystem::getPathStem()
    Get the stem part of a path.
getRealPath
in file Bs_FileSystem.class.php, method Bs_FileSystem::getRealPath()
    Returns canonicalized real pathname *with* ending '/' if it's a dir AND(!) checks for existence!
getRealPathSplit
in file Bs_FileSystem.class.php, method Bs_FileSystem::getRealPathSplit()
    Returns a splited canonicalized real pathname *with* ending '/' if it's a dir.
getWithoutFileExtension
in file Bs_FileSystem.class.php, method Bs_FileSystem::getWithoutFileExtension()
    returns the filename without the file extension.
top

h

htmlToPdf
in file Bs_FileConverter.class.php, method Bs_FileConverter::htmlToPdf() (subpackage: converter)
htmlToText
in file Bs_FileConverter.class.php, method Bs_FileConverter::htmlToText() (subpackage: converter)
    Convert Html => Text at first it stripps all tags, then converts html entities back to orig values.
htmlToWord
in file Bs_FileConverter.class.php, method Bs_FileConverter::htmlToWord() (subpackage: converter)
top

i

isEmpty
in file Bs_Dir.class.php, method Bs_Dir::isEmpty()
isLink
in file Bs_FileSystem.class.php, method Bs_FileSystem::isLink()
    tells wheter the current file/path (or $fullPath) is a link or not.
isModifiedSince
in file Bs_FileCache.class.php, method Bs_FileCache::isModifiedSince()
isValidFilename
in file Bs_FileSystem.class.php, method Bs_FileSystem::isValidFilename()
    windows filename and dirname (tested on winnt 4.0 german)
isValidFullPath
in file Bs_FileSystem.class.php, method Bs_FileSystem::isValidFullPath()
isValidPath
in file Bs_FileSystem.class.php, method Bs_FileSystem::isValidPath()
top

l

loadBsHtmlUtil
in file Bs_FileConverter.class.php, method Bs_FileConverter::loadBsHtmlUtil() (subpackage: converter)
top

m

makeValidFileName
in file Bs_FileSystem.class.php, method Bs_FileSystem::makeValidFileName()
    removes/replaces invalid characters in the filename specified.
mkpath
in file Bs_Dir.class.php, method Bs_Dir::mkpath()
    creates the given path, not just the last directory.
move
in file Bs_File.class.php, method Bs_File::move()
    this is basically rename() from PHP but in addition can deal with overwriting files.
mv
in file Bs_Dir.class.php, method Bs_Dir::mv()
top

o

onewayAppend
in file Bs_File.class.php, method Bs_File::onewayAppend()
    appends $string at the end of the file.
onewayWrite
in file Bs_File.class.php, method Bs_File::onewayWrite()
    writes $string to the file. if the file already exists all content will be overwritten.
top

p

$pathToPdfToHtmlExe
in file Bs_FileConverterPdf.class.php, variable Bs_FileConverterPdf::$pathToPdfToHtmlExe (subpackage: converter)
    path to the pdftohtml.exe file.
pdfToHtmlString
in file Bs_FileConverterPdf.class.php, method Bs_FileConverterPdf::pdfToHtmlString() (subpackage: converter)
    deprecated, use streamToHtmlString(), new method name.
top

r

readAll
in file Bs_File.class.php, method Bs_File::readAll()
realPath
in file Bs_FileSystem.class.php, method Bs_FileSystem::realPath()
    Returns canonicalized real pathname *with* ending '/' if it's a dir.
realPathSplit
in file Bs_FileSystem.class.php, method Bs_FileSystem::realPathSplit()
    Returns a splited canonicalized real pathname *with* ending '/' if it's a dir.
removeEmptyLines
in file Bs_FileUtil.class.php, method Bs_FileUtil::removeEmptyLines()
    removes all empty lines of the given file.
rm
in file Bs_File.class.php, method Bs_File::rm()
    removes this file (rm).
rm
in file Bs_Dir.class.php, method Bs_Dir::rm()
    removes the directory.
top

s

search
in file Bs_Dir.class.php, method Bs_Dir::search()
searchAndReplace
in file Bs_Dir.class.php, method Bs_Dir::searchAndReplace()
setBufferLifetime
in file Bs_FileCache.class.php, method Bs_FileCache::setBufferLifetime()
    The max time a memory buffered data is considered 'up to date' befor an 'up to date'-check on the 'origin'-file is fired. Only active if there is an 'origin'-file in use.
setBufferSize
in file Bs_FileCache.class.php, method Bs_FileCache::setBufferSize()
    Set the size of the cache buffer
setCacheLifeTime
in file Bs_FileCache.class.php, method Bs_FileCache::setCacheLifeTime()
    The max time until the cached data is considered 'out to date' even if the 'origin'-file hasn't changed. After this time a fetch() will return the 'out of date'-value NULL.
setDir
in file Bs_FileCache.class.php, method Bs_FileCache::setDir()
    Define where you want the cache-files to be stored.
setFullPath
in file Bs_Dir.class.php, method Bs_Dir::setFullPath()
    Set our view to the directory passed by '$workingDir'.
setFullPath
in file Bs_FileSystem.class.php, method Bs_FileSystem::setFullPath()
    Set our view to the directory or file passed by '$workingDir'.
setVerboseCacheNames
in file Bs_FileCache.class.php, method Bs_FileCache::setVerboseCacheNames()
    Define if the 'cache-files' should contain a verbose name or not.
standardizePath
in file Bs_FileSystem.class.php, method Bs_FileSystem::standardizePath()
    The path format for input may be windows-like with '\' backslashes.
store
in file Bs_FileCache.class.php, method Bs_FileCache::store()
    Store the data stream to cache.
streamToHtmlString
in file Bs_FileConverterPdf.class.php, method Bs_FileConverterPdf::streamToHtmlString() (subpackage: converter)
    reads a pdf document and returns it as html string.
top

t

toHtml
in file Bs_File.class.php, method Bs_File::toHtml()
    *
toString
in file Bs_File.class.php, method Bs_File::toString()
    *
toHtmlFile
in file Bs_FileConverterPdf.class.php, method Bs_FileConverterPdf::toHtmlFile() (subpackage: converter)
top

w

write
in file Bs_File.class.php, method Bs_File::write()
wordStreamToHtmlStream
in file Bs_FileConverter.class.php, method Bs_FileConverter::wordStreamToHtmlStream() (subpackage: converter)
    converts a word document to html and saves it to $destination.
wordStreamToHtmlString
in file Bs_FileConverter.class.php, method Bs_FileConverter::wordStreamToHtmlString() (subpackage: converter)
    converts a word document to html and returns it as string.
wordSummary
in file Bs_FileConverter.class.php, method Bs_FileConverter::wordSummary() (subpackage: converter)
    returns information about the given word document.
wordToAbi
in file Bs_FileConverter.class.php, method Bs_FileConverter::wordToAbi() (subpackage: converter)
    converts a word document to abiword.
wordToHtml
in file Bs_FileConverter.class.php, method Bs_FileConverter::wordToHtml() (subpackage: converter)
    deprecated, use wordStreamToHtmlStream() or wordStreamToHtmlString() instead.
wordToLatex
in file Bs_FileConverter.class.php, method Bs_FileConverter::wordToLatex() (subpackage: converter)
    converts a word document to latex.
wordToText
in file Bs_FileConverter.class.php, method Bs_FileConverter::wordToText() (subpackage: converter)
    converts a word document to plain text.
wordToWml
in file Bs_FileConverter.class.php, method Bs_FileConverter::wordToWml() (subpackage: converter)
    converts a word document to wml.
wordVersion
in file Bs_FileConverter.class.php, method Bs_FileConverter::wordVersion() (subpackage: converter)
    returns information about the word version.
top

x

xlsStreamToArray
in file Bs_FileConverterExcel.class.php, method Bs_FileConverterExcel::xlsStreamToArray() (subpackage: converter)
    reads a microsoft excel document and returns it as php array.
xlsStreamToHtmlString
in file Bs_FileConverterExcel.class.php, method Bs_FileConverterExcel::xlsStreamToHtmlString() (subpackage: converter)
    reads a microsoft excel document and returns it as html.
xlsToArray
in file Bs_FileConverterExcel.class.php, method Bs_FileConverterExcel::xlsToArray() (subpackage: converter)
    deprecated, renamed function to xlsStreamToArray().
xlsToCsv
in file Bs_FileConverterExcel.class.php, method Bs_FileConverterExcel::xlsToCsv() (subpackage: converter)
    reads a microsoft excel document and returns it as csv.
xlsToHtml
in file Bs_FileConverterExcel.class.php, method Bs_FileConverterExcel::xlsToHtml() (subpackage: converter)
    deprecated, renamed function to xlsStreamToHtmlString().
xlsToXml
in file Bs_FileConverterExcel.class.php, method Bs_FileConverterExcel::xlsToXml() (subpackage: converter)
    reads a microsoft excel document and returns it as xml.
top

Documentation generated on Mon, 29 Dec 2003 21:07:26 +0100 by phpDocumentor 1.2.3