[ Index ]

PHP Cross Reference of Unnamed Project

title

Body

[close]

/lib/spout/src/Spout/Reader/ -> AbstractReader.php (summary)

Class AbstractReader

File Size: 202 lines (6 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 9 functions

  setGlobalFunctionsHelper()
  open()
  getFileRealPath()
  getStreamWrapperScheme()
  isStreamWrapper()
  isSupportedStreamWrapper()
  isPhpStream()
  getSheetIterator()
  close()

Functions
Functions that are not part of a class:

setGlobalFunctionsHelper($globalFunctionsHelper)   X-Ref

param: $globalFunctionsHelper
return: AbstractReader

open($filePath)   X-Ref
Prepares the reader to read the given file. It also makes sure
that the file exists and is readable.

param: string $filePath Path of the file to be read
return: void

getFileRealPath($filePath)   X-Ref
Returns the real path of the given path.
If the given path is a valid stream wrapper, returns the path unchanged.

param: string $filePath
return: string

getStreamWrapperScheme($filePath)   X-Ref
Returns the scheme of the custom stream wrapper, if the path indicates a stream wrapper is used.
For example, php://temp => php, s3://path/to/file => s3...

param: string $filePath Path of the file to be read
return: string|null The stream wrapper scheme or NULL if not a stream wrapper

isStreamWrapper($filePath)   X-Ref
Checks if the given path is an unsupported stream wrapper
(like local path, php://temp, mystream://foo/bar...).

param: string $filePath Path of the file to be read
return: bool Whether the given path is an unsupported stream wrapper

isSupportedStreamWrapper($filePath)   X-Ref
Checks if the given path is an supported stream wrapper
(like php://temp, mystream://foo/bar...).
If the given path is a local path, returns true.

param: string $filePath Path of the file to be read
return: bool Whether the given path is an supported stream wrapper

isPhpStream($filePath)   X-Ref
Checks if a path is a PHP stream (like php://output, php://memory, ...)

param: string $filePath Path of the file to be read
return: bool Whether the given path maps to a PHP stream

getSheetIterator()   X-Ref
Returns an iterator to iterate over sheets.

return: \Iterator To iterate over sheets

close()   X-Ref
Closes the reader, preventing any additional reading

return: void



Generated: Thu Aug 11 10:00:09 2016 Cross-referenced by PHPXref 0.7.1