Index of All Elements
Package Indexes
[ a ]
[ b ]
[ c ]
[ d ]
[ e ]
[ f ]
[ g ]
[ i ]
[ l ]
[ m ]
[ n ]
[ o ]
[ p ]
[ q ]
[ r ]
[ s ]
[ t ]
[ u ]
[ v ]
[ w ]
[ _ ]
Letter 'a'
- $allowedMethods
- in file connection.php, variable phpillowConnection::$allowedMethods
Array containing the list of allowed HTTP methods to interact with couch server.
- addConnection
- in file gen_autoload_files.php, method arbitTopoLogicalSorting::addConnection()
Add directed connection to the graph
Add a connection from node $src to node $dst to the graph.
- addNode
- in file gen_autoload_files.php, method arbitTopoLogicalSorting::addNode()
Add node to the graph
- arbitCommitMessageParser
- in file validate_commit_message.php, class arbitCommitMessageParser
Arbit parser for arbit commit messages defined by the following grammar:
Message ::= Statement+ | Statement* Comment+ Statement ::= Reference | Fixed | Implemented | Documented | Tested Comment ::= '# ' TextLine | '#\n' Reference ::= '- Refs' BugNr ': ' TextLine Text? Fixed ::= '- ' FixedString BugNr ': ' TextLine Text? Implemented ::= '- Implemented' BugNr? ': ' TextLine Text? Documented ::= '- Documented' BugNr? ': ' TextLine Text? Tested ::= '- Tested: ' TextLine Text? FixedString ::= 'Fixed' | 'Closed' Text ::= ' ' TextLine Text? BugNr ::= ' #' [1-9]+[0-9]* TextLine ::= [\x20-\x7E]+ "\n"
With one additional condition not mentioned in the grammar, that no line should ever exceed 79 characters per line.
- arbitCommitParserException
- in file validate_commit_message.php, class arbitCommitParserException
Very simple exception class, posign for the original exception class
- arbitTopoLogicalSorting
- in file gen_autoload_files.php, class arbitTopoLogicalSorting
CycleDetection
- attachFile
- in file document.php, method phpillowDocument::attachFile()
Attach file to document
The file passed to the method will be attached to the document and stored in the database. will be ued as a name, but you may optionally specify a name as the second parameter of the method.
- attachMemoryFile
- in file document.php, method phpillowDocument::attachMemoryFile()
Attach file from memory to document
The data passed to the method will be attached to the document and stored in the database.
- autoload.php
- procedural page autoload.php
- array.php
- procedural page array.php
- array.php
- procedural page array.php
Letter 'b'
- $boundaries
- in file multipart_writer.php, variable phpillowToolMultipartWriter::$boundaries
Already used boundaries
- $boundary
- in file multipart_writer.php, variable phpillowToolMultipartWriter::$boundary
Currently used boundary
- buildMessage
- in file exception.php, method phpillowException::buildMessage()
Build exception message
Replace all placeholders in exception message. has been "borrowed" from ezcTranslations, as this will used for the translation, so that we are using the exact same replacement strategy.
- buildRequest
- in file custom.php, method phpillowCustomConnection::buildRequest()
Build a HTTP 1.
Build the HTTP 1.
- buildViewQuery
- in file view.php, method phpillowView::buildViewQuery()
Build view query string from options
- bootstrap.php
- procedural page bootstrap.php
- base.php
- procedural page base.php
- boolean.php
- procedural page boolean.php
Letter 'c'
- $connection
- in file document.php, variable phpillowDocument::$connection
The phpillowConnection to be used by this document
- $connection
- in file lazy_file.php, variable phpillowLazyFile::$connection
phpillowConnection to be used for retrieving the file data if requested.
- $connection
- in file custom.php, variable phpillowCustomConnection::$connection
Connection pointer for connections, once keep alive is working on the CouchDb side.
- $connectionInfo
- in file tool.php, variable phpillowTool::$connectionInfo
Parsed connection information
- checkConnection
- in file custom.php, method phpillowCustomConnection::checkConnection()
Check for server connection
Checks if the connection already has been established, or tries to establish the connection, if not done yet.
- checkRequirements
- in file document.php, method phpillowDocument::checkRequirements()
Check if all requirements are met
Checks if all required properties has been set. the properties, which are required but not set, or true if all requirements are fulfilled.
- checkStream
- in file multipart_parser.php, method phpillowToolMultipartParser::checkStream()
Check stream
Ensure given stream is a "multipart/mixed" mixed document, and read the important document properties, like the boundary string, for further processing.
- checkTypeOfResponse
- in file document.php, method phpillowDocument::checkTypeOfResponse()
Verifies that the fetched document is of the given type
- createDocument
- in file manager.php, method phpillowManager::createDocument()
Create new document
Create a new document of the given type and return it. phpillowNoSuchPropertyException if the document does not exist.
- createInstance
- in file stream.php, method phpillowStreamConnection::createInstance()
Create a new couch DB connection instance.
- createInstance
- in file custom.php, method phpillowCustomConnection::createInstance()
Create a new couch DB connection instance.
- createInstance
- in file connection.php, method phpillowConnection::createInstance()
Create a new couch DB connection instance.
- createNew
- in file document.php, method phpillowDocument::createNew()
Create a new instance of the document class
Create a new instance of the statically called document class.
- createNew
- in file user.php, method phpillowUserView::createNew()
Create a new instance of the document class
Create a new instance of the statically called document class.
- createNew
- in file group.php, method phpillowGroupView::createNew()
Create a new instance of the document class
Create a new instance of the statically called document class.
- createNew
- in file user.php, method phpillowUserFileView::createNew()
Create a new instance of the document class
Create a new instance of the statically called document class.
- custom.php
- procedural page custom.php
- connection.php
- procedural page connection.php
Letter 'd'
- $database
- in file connection.php, variable phpillowConnection::$database
Currently used database
- $database
- in file document.php, variable phpillowDocument::$database
The database to be used by this document
- $docType
- in file document.php, variable phpillowDocument::$docType
Set this before calling static functions.
- $documentClass
- in file document.php, variable phpillowDocumentValidator::$documentClass
Required class for the aggregated single document.
- $documents
- in file manager.php, variable phpillowManager::$documents
Initial mapping of document types to document classes.
- $dsn
- in file tool.php, variable phpillowTool::$dsn
Data source name for the CouchDB connection
- delete
- in file document.php, method phpillowDocument::delete()
Deletes the current document
Tries to delete the current document from the database. conflict exception in case the document has been modified since the last fetch.
- deleteDocument
- in file manager.php, method phpillowManager::deleteDocument()
Delete document by ID
Delete the document of the given type with the given ID. phpillowNoSuchPropertyException if the document does not exist.
- dump
- in file tool.php, method phpillowTool::dump()
Execute dump command
Returns a proper status code indicating successful execution of the command.
- document.php
- procedural page document.php
- data.php
- procedural page data.php
- date.php
- procedural page date.php
- document.php
- procedural page document.php
- document_array.php
- procedural page document_array.php
Letter 'e'
- $edges
- in file gen_autoload_files.php, variable arbitTopoLogicalSorting::$edges
Array with edges in the graph, which has the structure:
- exception.php
- procedural page exception.php
- email.php
- procedural page email.php
Letter 'f'
- fetchById
- in file document.php, method phpillowDocument::fetchById()
Get document by ID
Get document by ID and return a document object instance for the fetch document.
- fetchData
- in file lazy_file.php, method phpillowLazyFile::fetchData()
Fetch the attachment data from the couchdb and return it
- fetchDocument
- in file manager.php, method phpillowManager::fetchDocument()
Fetch document by ID
Fetch the document of the given type with the given ID. phpillowNoSuchPropertyException if the document does not exist.
- fromResponse
- in file document.php, method phpillowDocument::fromResponse()
Set values from a response object
Set values of the document from the response object, if they are available in there.
- file_view.php
- procedural page file_view.php
- float.php
- procedural page float.php
Letter 'g'
- generateId
- in file document.php, method phpillowDocument::generateId()
Get ID from document
The ID normally should be calculated on some meaningful / unique property for the current type of documents. not be too long and should not contain multibyte characters.
- generateId
- in file view.php, method phpillowView::generateId()
Get ID from document
The ID normally should be calculated on some meaningful / unique property for the current ttype of documents. not be too long and should not contain multibyte characters.
- getBoundary
- in file multipart_writer.php, method phpillowToolMultipartWriter::getBoundary()
Get unique boudary
Get a unique boundary string, which is not yet used by any wrapping document and most probably not occurs in any of the embedded documents.
- getClassDependenciesFromFile
- in file gen_autoload_files.php, function getClassDependenciesFromFile()
Get dependencies for class
- getConnection
- in file document.php, method phpillowDocument::getConnection()
Return used connection
- getDatabase
- in file connection.php, method phpillowConnection::getDatabase()
Return name of the currently used database
- getDatabase
- in file document.php, method phpillowDocument::getDatabase()
Return used database
- getDocument
- in file multipart_parser.php, method phpillowToolMultipartParser::getDocument()
Get document from stream
Get the (next) document from the stream. document properties and their values (like Content-Type), as well as an 'body' index, which contains the actual contents of the document.
- getDocumentBody
- in file tool.php, method phpillowTool::getDocumentBody()
Clean up document definition
Returns the cleaned up document body as a result.
- getDocumentId
- in file document.php, method phpillowDocument::getDocumentId()
Get document ID from object ID
Composes the document ID out of the document type and the generated ID for the current document.
- getDocumentId
- in file view.php, method phpillowView::getDocumentId()
Get document ID from object ID
Composes the document ID out of the document type and the generated ID for the current document.
- getFile
- in file document.php, method phpillowDocument::getFile()
Get file contents
Get the contents of an attached file as a phpillowDataResponse.
- getFullDocument
- in file base.php, method phpillowResponse::getFullDocument()
Get full document
- getInstance
- in file connection.php, method phpillowConnection::getInstance()
Get configured couch DB connection instance
- getResponse
- in file exception.php, method phpillowResponseErrorException::getResponse()
Return response
Return response to check the actual response which cause the error, or receive details about the server error.
- getSortedNodeList
- in file gen_autoload_files.php, method arbitTopoLogicalSorting::getSortedNodeList()
Remove cycles from the graph
This method uses an algorithm similar to the topological sort algorithm to remove all cycles from the graph. are not in cycles, but leave nodes, which are linked from cycles will stay in the graph.
- getText
- in file exception.php, method phpillowException::getText()
Get message
- getTextValues
- in file exception.php, method phpillowException::getTextValues()
Get properties
Get text properties containing the values, which should replace the placeholders in the message.
- getType
- in file view.php, method phpillowView::getType()
Return document type name
This method is required to be implemented to return the document type for PHP versions lower then 5. might just implement a method which does "return static:$type" in a base class.
- getType
- in file document.php, method phpillowDocument::getType()
Return document type name
This method is required to be implemented to return the document type for PHP versions lower than 5. might just implement a method which does "return static:$type" in a base class.
- getView
- in file manager.php, method phpillowManager::getView()
Return view
Get a view object for the given view type. phpillowNoSuchPropertyException if the view does not exist.
- getViewName
- in file user.php, method phpillowUserView::getViewName()
Get name of view
- getViewName
- in file user.php, method phpillowUserFileView::getViewName()
Get name of view
- getViewName
- in file view.php, method phpillowView::getViewName()
Get name of view
- getViewName
- in file group.php, method phpillowGroupView::getViewName()
Get name of view
- group.php
- procedural page group.php
- gen_autoload_files.php
- procedural page gen_autoload_files.php
Letter 'i'
- $instance
- in file connection.php, variable phpillowConnection::$instance
Instance of phpillowConnection for singleton implementation.
- image_file_location.php
- procedural page image_file_location.php
- indexable_date.php
- procedural page indexable_date.php
- integer.php
- procedural page integer.php
Letter 'l'
- $leaves
- in file gen_autoload_files.php, variable arbitTopoLogicalSorting::$leaves
Array with leaves in the graph
- $length
- in file string_stream.php, variable phpillowToolStringStream::$length
Cached length of the string
- load
- in file tool.php, method phpillowTool::load()
Execute load command
Returns a proper status code indicating successful execution of the command.
- lazy_file.php
- procedural page lazy_file.php
Letter 'm'
- $max
- in file float.php, variable phpillowFloatValidator::$max
Maximum value for passed float value
- $max
- in file integer.php, variable phpillowIntegerValidator::$max
Maximum value for passed integer value
- $min
- in file float.php, variable phpillowFloatValidator::$min
Minimum value for passed float value
- $min
- in file integer.php, variable phpillowIntegerValidator::$min
Minimum value for passed integer value
- $modified
- in file document.php, variable phpillowDocument::$modified
Flag, indicating if current document has already been modified
- manager.php
- procedural page manager.php
- multipart_parser.php
- procedural page multipart_parser.php
- multipart_writer.php
- procedural page multipart_writer.php
Letter 'n'
- $newAttachments
- in file document.php, variable phpillowDocument::$newAttachments
List of new attachments to the document.
- $newDocument
- in file document.php, variable phpillowDocument::$newDocument
Flag, indicating if current document is a new one.
- $nodes
- in file gen_autoload_files.php, variable arbitTopoLogicalSorting::$nodes
Array with all graph nodes
- normalizeWhitespaces
- in file validate_commit_message.php, method arbitCommitMessageParser::normalizeWhitespaces()
Normalizes whitespaces in commit message
Even not defined in the grammar we do not care about additional newlines or empty lines anywhere.
- no.php
- procedural page no.php
- null.php
- procedural page null.php
Letter 'o'
- $optionalFields
- in file object.php, variable phpillowObjectValidator::$optionalFields
Optional fields for the object
- $options
- in file multipart_parser.php, variable phpillowToolMultipartParser::$options
Document properties
- $options
- in file tool.php, variable phpillowTool::$options
CLI tool options
- $options
- in file connection.php, variable phpillowConnection::$options
CouchDB connection options
- out
- in file tool.php, method phpillowTool::out()
Echo a message
Echo a progress message to STDERR, if the verbose flag is set.
- object.php
- procedural page object.php
- object_array.php
- procedural page object_array.php
- or.php
- procedural page or.php
Letter 'p'
- $position
- in file string_stream.php, variable phpillowToolStringStream::$position
Current position inside the string
- $properties
- in file base.php, variable phpillowResponse::$properties
Array containing all response properties
- $properties
- in file document.php, variable phpillowDocument::$properties
Properties with they type and value validators
array( . email => new phpillowMailValidator( . .
- $properties
- in file lazy_file.php, variable phpillowLazyFile::$properties
Storage for read-only properties
- $properties
- in file exception.php, variable phpillowException::$properties
Array with placeholder replacers.
- parse
- in file response.php, method phpillowResponseFactory::parse()
Parse a server response
Parses a server response depending on the response body and the HTTP status code.
- parse
- in file validate_commit_message.php, method arbitCommitMessageParser::parse()
Parse a commit message
Parses a commit messages defined by the grammar documented in the class header. the error message.
- parseConnectionInformation
- in file tool.php, method phpillowTool::parseConnectionInformation()
Parse the provided connection information
Returns false,if the connection information could not be parser properly.
- parseDocument
- in file multipart_parser.php, method phpillowToolMultipartParser::parseDocument()
Parse a single document
Parse a single document, and return an array with all headers and the document body. an array with all parts is returned as the type.
- parseStatements
- in file validate_commit_message.php, method arbitCommitMessageParser::parseStatements()
Parse all statements
Parse the statements like defined in the grammar in the class level docblock.
- phpillowArrayResponse
- in file array.php, class phpillowArrayResponse
Array response
Response class used, when CouchDB only returned an array, like for database lists.
- phpillowArrayValidator
- in file array.php, class phpillowArrayValidator
Validate array inputs
- phpillowBooleanValidator
- in file boolean.php, class phpillowBooleanValidator
validate boolean inputs
- phpillowConnection
- in file connection.php, class phpillowConnection
Basic couch DB connection handling class
Default connection handler using PHPs stream wrappers.
- phpillowConnectionException
- in file exception.php, class phpillowConnectionException
Exception thrown, when connection could not be established or configured.
- phpillowCustomConnection
- in file custom.php, class phpillowCustomConnection
Basic couch DB connection handling class.
- phpillowDataResponse
- in file data.php, class phpillowDataResponse
Data response
- phpillowDateValidator
- in file date.php, class phpillowDateValidator
Validate date inputs
- phpillowDocument
- in file document.php, class phpillowDocument
Basic abstract document
- phpillowDocumentArrayValidator
- in file document_array.php, class phpillowDocumentArrayValidator
Validate text inputs
- phpillowDocumentValidator
- in file document.php, class phpillowDocumentValidator
Validate text inputs
- phpillowEmailValidator
- in file email.php, class phpillowEmailValidator
Validate email addresses
- phpillowException
- in file exception.php, class phpillowException
Basic phpillow exception
- phpillowFileView
- in file file_view.php, class phpillowFileView
Wrapper base for views in the database, where view functions are locally stored as files.
- phpillowFloatValidator
- in file float.php, class phpillowFloatValidator
Validate float inputs
- phpillowGroupView
- in file group.php, class phpillowGroupView
Wrapper for group views
- phpillowImageFileLocationValidator
- in file image_file_location.php, class phpillowImageFileLocationValidator
Validate given file as a valid image file
- phpillowIndexableDateValidator
- in file indexable_date.php, class phpillowIndexableDateValidator
Validate date inputs
- phpillowIntegerValidator
- in file integer.php, class phpillowIntegerValidator
Validate integer inputs
- phpillowInvalidRequestException
- in file exception.php, class phpillowInvalidRequestException
Exception thrown, when a request could not be build out of the given
- phpillowLazyFile
- in file lazy_file.php, class phpillowLazyFile
Class representing a file attached to a couchdb document.
- phpillowManager
- in file manager.php, class phpillowManager
Basic couch DB view and document manager / registry.
- phpillowMultipartParserException
- in file exception.php, class phpillowMultipartParserException
Exception thrown if the parsing of a multipart/mixed document failed.
- phpillowNoDatabaseException
- in file exception.php, class phpillowNoDatabaseException
Exception thrown, when no database has been configured.
- phpillowNoSuchPropertyException
- in file exception.php, class phpillowNoSuchPropertyException
Exception thrown, when a property requested from an response object is not available.
- phpillowNoValidator
- in file no.php, class phpillowNoValidator
Pseudo no-validator
- phpillowNullValidator
- in file null.php, class phpillowNullValidator
Validate null inputs
- phpillowObjectArrayValidator
- in file object_array.php, class phpillowObjectArrayValidator
Validate arrays of object inputs
- phpillowObjectValidator
- in file object.php, class phpillowObjectValidator
Validate object inputs
- phpillowOptionException
- in file exception.php, class phpillowOptionException
Exception thrown, when trying to set an unknown option
- phpillowOrValidationException
- in file exception.php, class phpillowOrValidationException
Exception thrown, when a document property could not be validated by the or-validator.
- phpillowOrValidator
- in file or.php, class phpillowOrValidator
Validate object inputs
- phpillowRegexpValidator
- in file regexp.php, class phpillowRegexpValidator
Validate string inputs against a regular expression
- phpillowResponse
- in file base.php, class phpillowResponse
Response factory to create response objects from JSON results
Exposes all properties of the response as class properties, which can be accessed like public properties:
- phpillowResponseConflictErrorException
- in file exception.php, class phpillowResponseConflictErrorException
Exception thrown if the server detected a conflict while processing a request.
- phpillowResponseErrorException
- in file exception.php, class phpillowResponseErrorException
Exception thrown if the server could not properly response a request.
- phpillowResponseFactory
- in file response.php, class phpillowResponseFactory
Response factory to create response objects from JSON results
- phpillowResponseNotFoundErrorException
- in file exception.php, class phpillowResponseNotFoundErrorException
Exception thrown if the server could not find a requested document.
- phpillowResultSetResponse
- in file result.php, class phpillowResultSetResponse
Result set response
Exposes all properties of the response as class properties, which can be accessed like public properties:
- phpillowRuntimeException
- in file exception.php, class phpillowRuntimeException
Runtime exception for really unexpected failures.
- phpillowStatusResponse
- in file status.php, class phpillowStatusResponse
Status response
Exposes all properties of the response as class properties, which can be accessed like public properties:
- phpillowStreamConnection
- in file stream.php, class phpillowStreamConnection
Basic couch DB connection handling class
Connection handler using PHPs stream wrappers.
- phpillowStringValidator
- in file string.php, class phpillowStringValidator
validate string inputs
- phpillowTextValidator
- in file text.php, class phpillowTextValidator
Validate text inputs
- phpillowTool
- in file tool.php, class phpillowTool
Basic tool handling in- end exports of CouchDB dumps.
- phpillowToolMultipartParser
- in file multipart_parser.php, class phpillowToolMultipartParser
Parses MIME messages, especially multipart-messages
- phpillowToolMultipartWriter
- in file multipart_writer.php, class phpillowToolMultipartWriter
Writes a CouchDB dump into a multipart/mixed MIME file
- phpillowToolStringStream
- in file string_stream.php, class phpillowToolStringStream
Stream wrapper for plain strings
- phpillowUserFileView
- in file user.php, class phpillowUserFileView
Wrapper for user views
- phpillowUserView
- in file user.php, class phpillowUserView
Wrapper for user views
- phpillowUuidValidator
- in file uuid.php, class phpillowUuidValidator
Validate uuid version 4 inputs
- phpillowValidationException
- in file exception.php, class phpillowValidationException
Exception thrown, when a document property could not be validated by the validator.
- phpillowValidator
- in file validator.php, class phpillowValidator
Abstract base class for document property validations
- phpillowView
- in file view.php, class phpillowView
Wrapper base for views in the database
- phpillow_autoload
- in file bootstrap.php, function phpillow_autoload()
This is the bootstrap file, which sets up an autoload mechanism using spl-Autoload-register, which makes all PHPillow classes available in your scripts.
- primeCaches
- in file tool.php, method phpillowTool::primeCaches()
Prime caches of all views
Returns a proper status code indicating successful execution of the command.
- printVersion
- in file tool.php, method phpillowTool::printVersion()
Print version
Print version of the tool, if the version flag has been set.
Letter 'q'
- query
- in file view.php, method phpillowView::query()
Query a view
Letter 'r'
- $rawMessage
- in file exception.php, variable phpillowException::$rawMessage
Exception message with optional placeholders
- $regexp
- in file regexp.php, variable phpillowRegexpValidator::$regexp
Regular expression to validate against
- $requiredFields
- in file object.php, variable phpillowObjectValidator::$requiredFields
Required fields of the object.
- $requiredProperties
- in file view.php, variable phpillowView::$requiredProperties
List of required properties. set, a validation exception will be thrown on save.
- $requiredProperties
- in file document.php, variable phpillowDocument::$requiredProperties
List of required properties. set, a validation exception will be thrown on save.
- $response
- in file exception.php, variable phpillowResponseErrorException::$response
Actual parsed server response
- removeComments
- in file validate_commit_message.php, method arbitCommitMessageParser::removeComments()
Removes comments from a commit message
Removes all valid comments from a commit messages, as they are not of interest for the content extraction.
- renderGraph
- in file gen_autoload_files.php, method arbitTopoLogicalSorting::renderGraph()
Render a graph
Renders the graph using dot (http://graphviz. file.
- request
- in file stream.php, method phpillowStreamConnection::request()
Perform a request to the server and return the result
Perform a request to the server and return the result converted into a phpillowResponse object. could be converted in such a response object, set the forth parameter to true, and you get a response object returned, containing the raw body.
- request
- in file custom.php, method phpillowCustomConnection::request()
Perform a request to the server and return the result
Perform a request to the server and return the result converted into a phpillowResponse object. could be converted in such a response object, set the forth parameter to true, and you get a response object returned, containing the raw body.
- request
- in file connection.php, method phpillowConnection::request()
Perform a request to the server and return the result
Perform a request to the server and return the result converted into a phpillowResponse object. could be converted in such a response object, set the fourth parameter to true, and you get a response object returned, containing the raw body.
- result.php
- procedural page result.php
- response.php
- procedural page response.php
- regexp.php
- procedural page regexp.php
Letter 's'
- $specialProperties
- in file document.php, variable phpillowDocument::$specialProperties
List of special properties, which are available beside the document specific properties.
- $stderr
- in file tool.php, variable phpillowTool::$stderr
Standard error stream
- $stdout
- in file tool.php, variable phpillowTool::$stdout
Standard output stream
- $storage
- in file document.php, variable phpillowDocument::$storage
Object storing all the document properties as public attributes. way it is easy to serialize using json_encode.
- $stream
- in file multipart_parser.php, variable phpillowToolMultipartParser::$stream
Stream to read from
- $stream
- in file multipart_writer.php, variable phpillowToolMultipartWriter::$stream
Stream to read from
- $string
- in file string_stream.php, variable phpillowToolStringStream::$string
String, wrapped by the stream
- $supportedImageFormats
- in file image_file_location.php, variable phpillowImageFileLocationValidator::$supportedImageFormats
Array containing a list of supported image formats.
- save
- in file document.php, method phpillowDocument::save()
Save the document
If thew document has not been modified the method will immediately exit and return false. document will be stored in the database, keeping all the old revision intact and return true on success.
- setConnection
- in file document.php, method phpillowDocument::setConnection()
Reconfigure the connection to be used by this document
- setDatabase
- in file document.php, method phpillowDocument::setDatabase()
Reconfigure the database to be used by this document
- setDatabase
- in file connection.php, method phpillowConnection::setDatabase()
Set database to use
Set the name of database to use. path, but only its name.
- setDocumentClass
- in file manager.php, method phpillowManager::setDocumentClass()
Set document class
Set a document class for a document type.
- setOption
- in file connection.php, method phpillowConnection::setOption()
Set option value
Set the value for an connection option. phpillowOptionException for unknown options.
- setOutputStreams
- in file tool.php, method phpillowTool::setOutputStreams()
Set output streams
Set the output streams to be used by the tool.
- setViewClass
- in file manager.php, method phpillowManager::setViewClass()
Set view class
Set a view class for a view type.
- stream.php
- procedural page stream.php
- status.php
- procedural page status.php
- string_stream.php
- procedural page string_stream.php
- string.php
- procedural page string.php
- stream_eof
- in file string_stream.php, method phpillowToolStringStream::stream_eof()
Has the stream reached its end?
- stream_open
- in file string_stream.php, method phpillowToolStringStream::stream_open()
Open stream
- stream_read
- in file string_stream.php, method phpillowToolStringStream::stream_read()
Read from stream
- stream_seek
- in file string_stream.php, method phpillowToolStringStream::stream_seek()
Seek to a defined position in the string
- stream_stat
- in file string_stream.php, method phpillowToolStringStream::stream_stat()
Returns information about the stream
- stream_tell
- in file string_stream.php, method phpillowToolStringStream::stream_tell()
Tell current stream position
- stream_write
- in file string_stream.php, method phpillowToolStringStream::stream_write()
Write to stream
- stringToId
- in file document.php, method phpillowDocument::stringToId()
Get ID string from arbitrary string
To calculate an ID string from an phpillowrary string, first iconvs transliteration abilities are used, and after that all, but common ID characters, are replaced by the given replace string, which defaults to _.
Letter 't'
- $type
- in file document.php, variable phpillowDocument::$type
Document type, may be a string matching the regular expression:
- tool.php
- procedural page tool.php
- text.php
- procedural page text.php
Letter 'u'
- $url
- in file lazy_file.php, variable phpillowLazyFile::$url
Url which provides access to the couchdb attachment associated with this lazy file loader.
- user.php
- procedural page user.php
- uuid.php
- procedural page uuid.php
- user.php
- procedural page user.php
Letter 'v'
- $validatorExceptions
- in file exception.php, variable phpillowOrValidationException::$validatorExceptions
Contains the exceptions of the validators that were used
- $validators
- in file or.php, variable phpillowOrValidator::$validators
Array of validators to be checked
- $versioned
- in file document.php, variable phpillowDocument::$versioned
Indicates whether to keep old revisions of this document or not.
- $viewDefinitions
- in file user.php, variable phpillowUserView::$viewDefinitions
View functions to be registered on the server
- $viewDefinitions
- in file group.php, variable phpillowGroupView::$viewDefinitions
View functions to be registered on the server
- $viewDefinitions
- in file view.php, variable phpillowView::$viewDefinitions
View functions to be registered on the server
- $viewFunctions
- in file file_view.php, variable phpillowFileView::$viewFunctions
View functions to be registered on the server.
- $viewReduces
- in file group.php, variable phpillowGroupView::$viewReduces
Reduce function for a view function.
- $viewReduces
- in file view.php, variable phpillowView::$viewReduces
Reduce function for a view function.
- $views
- in file manager.php, variable phpillowManager::$views
Initial mapping of view types to view classes.
- validator.php
- procedural page validator.php
- view.php
- procedural page view.php
- validate_commit_message.php
- procedural page validate_commit_message.php
- validate
- in file or.php, method phpillowOrValidator::validate()
Validate input as object
- validate
- in file validator.php, method phpillowValidator::validate()
Validate input depending on the current validator and the configured
- validate
- in file regexp.php, method phpillowRegexpValidator::validate()
Validate input string against a regexp
Validates the input string against the configured regular expression.
- validate
- in file object_array.php, method phpillowObjectArrayValidator::validate()
Validate input to be an array of objects
- validate
- in file text.php, method phpillowTextValidator::validate()
Validate input as string
- validate
- in file string.php, method phpillowStringValidator::validate()
Validate input as string
- validate
- in file uuid.php, method phpillowUuidValidator::validate()
Validate input as uuid version 4
- validate
- in file no.php, method phpillowNoValidator::validate()
Do not validate input, but just pass.
- validate
- in file document_array.php, method phpillowDocumentArrayValidator::validate()
Validate input as string
- validate
- in file email.php, method phpillowEmailValidator::validate()
Validate input as an email address
- validate
- in file document.php, method phpillowDocumentValidator::validate()
Validate input as string
- validate
- in file date.php, method phpillowDateValidator::validate()
Validate input as string
- validate
- in file boolean.php, method phpillowBooleanValidator::validate()
Validate input as a boolean
- validate
- in file object.php, method phpillowObjectValidator::validate()
Validate input as object
- validate
- in file float.php, method phpillowFloatValidator::validate()
Validate input as float
- validate
- in file null.php, method phpillowNullValidator::validate()
Validate input as integer
- validate
- in file array.php, method phpillowArrayValidator::validate()
Validate input as string
- validate
- in file integer.php, method phpillowIntegerValidator::validate()
Validate input as integer
- validate
- in file image_file_location.php, method phpillowImageFileLocationValidator::validate()
Validate input as string
- validate
- in file indexable_date.php, method phpillowIndexableDateValidator::validate()
Validate input as string
- verifyView
- in file view.php, method phpillowView::verifyView()
Verify stored views
Check if the views stored in the database equal the view definitions specified by the vew classes. view specifications in the class.
- verifyView
- in file file_view.php, method phpillowFileView::verifyView()
Verify stored views
Check if the views stored in the database equal the view definitions specified by the vew classes. view specifications in the class.
Letter 'w'
- writeDocument
- in file multipart_writer.php, method phpillowToolMultipartWriter::writeDocument()
Write document to stream
Write a single document to the stream. the document contains attachments.
- writeMultipartDocument
- in file multipart_writer.php, method phpillowToolMultipartWriter::writeMultipartDocument()
Write a single document to the MIME file
- writeSimpleDocument
- in file multipart_writer.php, method phpillowToolMultipartWriter::writeSimpleDocument()
Write a single document to the MIME file
Letter '_'
- __call
- in file connection.php, method phpillowConnection::__call()
HTTP method request wrapper
Wraps the HTTP method requests to interact with the couch server. supported methods are: Each request takes the full request path as the first parameter and optionally data as the second parameter. database name, if the request should operate on a specific database.
- __callStatic
- in file view.php, method phpillowView::__callStatic()
Wrapper for more convenient view queries
Wrap all static calls to a extended view class, instantiate it and then call query method on the view object, reusing the called method name to query the view.
- __construct
- in file gen_autoload_files.php, method arbitTopoLogicalSorting::__construct()
Construct CycleDetection graph
- __construct
- in file lazy_file.php, method phpillowLazyFile::__construct()
Construct a new lazy File loader object using a given access url, contentType and length in bytes.
- __construct
- in file integer.php, method phpillowIntegerValidator::__construct()
Validator constructor
Validator constructor to optionally specify the minimum and maximum value for the allowed integer values. false to the respective parameter.
- __construct
- in file file_view.php, method phpillowFileView::__construct()
Construct new document
- __construct
- in file exception.php, method phpillowResponseNotFoundErrorException::__construct()
Construct parent from response
- __construct
- in file exception.php, method phpillowRuntimeException::__construct()
Construct runtime exception from exception message.
- __construct
- in file multipart_parser.php, method phpillowToolMultipartParser::__construct()
Construct parser from input stream
- __construct
- in file float.php, method phpillowFloatValidator::__construct()
Validator constructor
Validator constructor to optionally specify the minimum and maximum value for the allowed float values. false to the respective parameter.
- __construct
- in file object.php, method phpillowObjectValidator::__construct()
Validator constructor
Validator constructor to specify the required as well as optional fields of the object, which provide validators on their own.
- __construct
- in file user.php, method phpillowUserFileView::__construct()
Construct view
- __construct
- in file validate_commit_message.php, method arbitCommitMessageParser::__construct()
Construct parser
- __construct
- in file view.php, method phpillowView::__construct()
Construct new document
- __construct
- in file tool.php, method phpillowTool::__construct()
Construct tool
Construct tool from database DSN (Data-Source-Name, the URL defining the databases location) and an optional set of options.
- __construct
- in file regexp.php, method phpillowRegexpValidator::__construct()
Validator constructor
Validator constructor to specify the required PCRE regular expression for the input string validation.
- __construct
- in file array.php, method phpillowArrayResponse::__construct()
Construct response object from response array
- __construct
- in file or.php, method phpillowOrValidator::__construct()
Validator constructor
Validator constructor to specify the validators that should be checked.
- __construct
- in file multipart_writer.php, method phpillowToolMultipartWriter::__construct()
Construct parser from input stream
- __construct
- in file exception.php, method phpillowResponseErrorException::__construct()
Construct exception out of given response
- __construct
- in file connection.php, method phpillowConnection::__construct()
Construct a couch DB connection
Construct a couch DB connection from basic connection parameters for one given database.
- __construct
- in file exception.php, method phpillowResponseConflictErrorException::__construct()
Construct parent from response
- __construct
- in file document.php, method phpillowDocument::__construct()
Construct new document
- __construct
- in file document.php, method phpillowDocumentValidator::__construct()
Validator constructor
Validator constructor to specify the required class for the aggregated document.
- __construct
- in file data.php, method phpillowDataResponse::__construct()
Construct response object from raw data
- __construct
- in file base.php, method phpillowResponse::__construct()
Construct response object from JSON result
- __construct
- in file exception.php, method phpillowNoSuchPropertyException::__construct()
Create exception from property name
- __construct
- in file exception.php, method phpillowOptionException::__construct()
Create exception from option name
- __construct
- in file exception.php, method phpillowException::__construct()
Construct exception message
Construct exception message of a string with placeholders and the properties array, where the properties are the values, which will replace the placeholders when the exception is echo'd.
- __construct
- in file exception.php, method phpillowNoDatabaseException::__construct()
Create exception
- __construct
- in file exception.php, method phpillowMultipartParserException::__construct()
Construct parent from message
- __destruct
- in file multipart_writer.php, method phpillowToolMultipartWriter::__destruct()
Write stream end
- __get
- in file base.php, method phpillowResponse::__get()
Get available property
Receive response object property, if available. available, the method will throw an exception.
- __get
- in file document.php, method phpillowDocument::__get()
Get document property
- __get
- in file lazy_file.php, method phpillowLazyFile::__get()
Automagic getter for read-only properties
- __isset
- in file document.php, method phpillowDocument::__isset()
Check if document property is set
- __isset
- in file base.php, method phpillowResponse::__isset()
Check if property exists.
- __set
- in file document.php, method phpillowDocument::__set()
Set a property value
Set a property value, which will be validated using the assigned validator. that you know when to store the object.
- __set
- in file base.php, method phpillowResponse::__set()
Silently ignore each write access on response object properties.
|