Application
Table of Contents
Interfaces
- ContainerInterface
- CodingInterface
- LinkDecoratorInterface
- AssetInterface
- ExecutableBuilderStrategyInterface
- InstructionStrategyInterface
- ParameterFilterStrategyInterface
- ParameterSupplierStrategyInterface
- PathResolverStrategyInterface
- ExecutableInterface
- InstructionBuilderStrategyInterface
- ResultBuilderStrategyInterface
- AssetBuilderStrategyInterface
- ManifestInterface
- TreeLoaderStrategyInterface
- ResultInterface
- StreamBuilderStrategyInterface
- RequestStrategyInterface
- ResponseStrategyInterface
Classes
- Cache
- Legacy helper for resolving cache directories and cache file names.
- AssetConfigurationField
- Configuration field that normalizes Farah asset references into asset instances.
- FarahUrlConfigurationField
- Configuration field that normalizes string references into Farah URL instances.
- AbstractDaemonServer
- Base class for socket-backed Farah daemon servers that process chunk writer requests.
- DaemonClient
- Client for invoking Farah daemon assets and reading their streamed responses.
- Dictionary
- Loads Farah dictionary assets and applies dictionary-based XML transformations.
- AssetPathNotFoundException
- Exception type for the Farah asset path not found error condition.
- EmptySitemapException
- Exception type for the Farah empty sitemap error condition.
- EmptyTransformationException
- Exception type for the Farah empty transformation error condition.
- ExceptionContext
- Serializes exception metadata into DOM for Farah error responses.
- FileNotFoundException
- Exception type for the Farah file not found error condition.
- HttpDownloadAssetException
- Exception type for HTTP download failures while resolving Farah assets.
- HttpDownloadException
- Exception type for HTTP download failures while resolving Farah results.
- HttpDownloadExecutableException
- Exception type for HTTP download failures while resolving Farah executables.
- HttpStatusException
- Exception type for converting Farah failures into HTTP status responses.
- IncompleteUrlException
- Exception type for Farah URLs that are missing required components.
- MalformedDocumentException
- Exception type for the Farah malformed document error condition.
- MalformedUrlException
- Exception type for Farah URL strings that cannot be parsed.
- ModuleNotFoundException
- Exception type for the Farah module not found error condition.
- NamespaceNotSupportedException
- Exception type for the Farah namespace not supported error condition.
- PageNotFoundException
- Exception type for the Farah page not found error condition.
- PageRedirectionException
- Exception type for the Farah page redirection error condition.
- ProtocolNotSupportedException
- Exception type for the Farah protocol not supported error condition.
- ResultTypeNotSupportedException
- Exception type for the Farah result type not supported error condition.
- StreamTimedOutException
- Exception type for the Farah stream timed out error condition.
- StreamTypeNotSupportedException
- Exception type for the Farah stream type not supported error condition.
- TagNotSupportedException
- Exception type for the Farah tag not supported error condition.
- UndefinedBehaviorException
- Exception type for the Farah undefined behavior error condition.
- FarahUrl
- Immutable PSR-7 URI value object for Farah asset URLs.
- FarahUrlArguments
- Immutable value object for Farah URL query arguments.
- FarahUrlAuthority
- Immutable value object for the vendor and module authority of a Farah URL.
- FarahUrlPath
- Immutable value object for normalized Farah asset paths.
- FarahUrlStreamIdentifier
- Immutable value object for Farah URL stream fragments.
- ConfigurableCoding
- HTTP coding implementation that wraps a configurable set of stream filters.
- ContentCoding
- Registry for supported HTTP content codings.
- IdentityFactory
- Stream writer factory for identity HTTP coding without transformation.
- MessageFactory
- Factory for PSR-7 requests, responses, streams, and Farah-specific request messages.
- StatusCode
- Lookup table for HTTP status code reason phrases used by Farah responses.
- TransferCoding
- Registry for supported HTTP transfer codings.
- HTTPClosure
- Legacy wrapper around a callable with HTTP command execution options.
- HTTPCommand
- Legacy command dispatcher for event-driven HTTP work units.
- HTTPEvent
- Legacy event object used by the root-level HTTP command and response classes.
- HTTPRequest
- Legacy HTTP request model that can expose request data as DOM.
- HTTPResponse
- Legacy HTTP response emitter for headers, body streams, ranges, and content negotiation.
- CLIDaemonServer
- Daemon server implementation for executing Farah CLI asset requests.
- FontFaceBuilder
- Executable builder for generating CSS @font-face output from Farah font assets.
- FontFaceParameterFilter
- Parameter filter for the bundled font-face generator asset.
- PhpinfoBuilder
- Executable builder for exposing PHP runtime information through a Farah asset.
- RequestBuilder
- Executable builder for exposing the current Farah request as XML.
- SitemapBuilder
- Executable builder and DOM writer for Farah sitemap output.
- SitemapJsonBuilder
- String writer that serializes the current Farah sitemap as JSON.
- Kernel
- Coordinates Farah request strategies, response strategies, current request state, and optional tracking.
- DecoratedDOMWriter
- DOM writer decorator that rewrites links in generated DOM output.
- DecoratorFactory
- Factory for selecting link decorators by DOM namespace.
- FarahDecorator
- Link decorator for Farah module XML output.
- HtmlDecorator
- Link decorator for HTML output generated from Farah assets.
- SvgDecorator
- Link decorator for SVG output generated from Farah assets.
- Asset
- Runtime representation of a manifest asset and its executable variants.
- AssetContainer
- Container for assets keyed by normalized Farah asset paths.
- AssetStrategies
- Strategy bundle used when resolving and executing a Farah asset.
- DaemonExecutableBuilder
- Executable builder strategy for daemon assets.
- FromFilesystemExecutableBuilder
- Executable builder strategy for assets backed by files on disk.
- FromManifestExecutableBuilder
- Executable builder strategy for assets whose executable results are defined in a manifest.
- FromReferenceExecutableBuilder
- Executable builder strategy for assets that proxy another Farah reference.
- NullExecutableBuilder
- Executable builder strategy for null assets.
- FromManifestInstruction
- Instruction strategy that reads instruction behavior from manifest element metadata.
- ImportChildrenInstruction
- Instruction strategy for import children manifest instructions.
- ImportSelfInstruction
- Instruction strategy for import self manifest instructions.
- LinkContentInstruction
- Instruction strategy for link content manifest instructions.
- LinkDictionaryInstruction
- Instruction strategy for link dictionary manifest instructions.
- LinkModuleInstruction
- Instruction strategy for link module manifest instructions.
- LinkScriptInstruction
- Instruction strategy for link script manifest instructions.
- LinkStylesheetInstruction
- Instruction strategy for link stylesheet manifest instructions.
- NullInstruction
- Instruction strategy for null manifest instructions.
- ParameterSupplierInstruction
- Instruction strategy for parameter supplier manifest instructions.
- UseDocumentInstruction
- Instruction strategy for use document manifest instructions.
- UseManifestInstruction
- Instruction strategy for use manifest instructions.
- UseTemplateInstruction
- Instruction strategy for use template manifest instructions.
- LinkInstructionCollection
- Collection of link instructions emitted while building executable results.
- ManifestElementBuilder
- Builder for normalized manifest element metadata used by asset resolution.
- AbstractMapParameterFilter
- Parameter filter strategy for abstract map asset parameters.
- AllowAllParameterFilter
- Parameter filter strategy for allow all asset parameters.
- DenyAllParameterFilter
- Parameter filter strategy for deny all asset parameters.
- FromFilesystemParameterFilter
- Parameter filter strategy that restricts parameters for file-backed assets.
- FromManifestParameterFilter
- Parameter filter strategy that reads allowed parameters from manifest metadata.
- FromAttributesParameterSupplier
- Parameter supplier strategy that reads parameters from asset attributes.
- FromManifestParameterSupplier
- Parameter supplier strategy that reads parameters from manifest metadata.
- FromReferenceParameterSupplier
- Parameter supplier strategy that forwards parameters from a referenced asset.
- NullParameterSupplier
- Parameter supplier strategy for null asset parameters.
- CatchAllPathResolver
- Path resolver strategy for catch all manifest asset paths.
- FromFilesystemPathResolver
- Path resolver strategy that maps manifest asset paths to files on disk.
- FromManifestPathResolver
- Path resolver strategy that reads child paths from manifest elements.
- FromSubManifestPathResolver
- Path resolver strategy that loads child paths from a referenced sub-manifest.
- NullPathResolver
- Path resolver strategy for null manifest asset paths.
- UseInstructionCollection
- Collection of use instructions emitted while building executable results.
- AssetDocumentDOMWriter
- DOM writer that embeds a Farah asset document into generated output.
- AssetFragmentDOMWriter
- DOM writer that serializes Farah asset fragment metadata.
- AssetManifestDOMWriter
- DOM writer that serializes Farah asset manifest metadata.
- DOMDocumentDOMWriter
- DOM writer adapter for an existing DOMDocument.
- DOMWriterFileCacheWithDependencies
- File-backed DOM writer cache that refreshes when dependent files change.
- EmbedIncludesDOMWriter
- DOM writer that embeds included Farah documents into a result document.
- FileInfoDOMWriter
- DOM writer adapter for loading XML from a file.
- TransformationDOMWriter
- DOM writer that applies an XSLT transformation to a source document.
- TransformationDOMWriterByUrls
- DOM writer that resolves source and stylesheet documents from Farah URLs before transforming them.
- TranslationDOMWriter
- DOM writer that translates a Farah document with a dictionary language.
- TranslationDOMWriter2
- DOM writer variant for dictionary translation of Farah documents.
- Executable
- Runtime executable for an asset and a normalized argument set.
- ExecutableContainer
- Container for executables keyed by Farah URL arguments.
- ExecutableStrategies
- Strategy bundle used when building executable results.
- ChunkWriterResultBuilder
- Result builder strategy for chunk writer executable results.
- DOMWriterResultBuilder
- Result builder strategy for d o m writer executable results.
- FileInfoResultBuilder
- Result builder strategy for file info executable results.
- AbstractFileResultBuilder
- Result builder for abstract file results.
- Base64FileResultBuilder
- Result builder for Base64-encoded file results.
- HtmlFileResultBuilder
- Result builder for HTML file results.
- TextFileResultBuilder
- Result builder for plain-text file results.
- XmlFileResultBuilder
- Result builder for XML file results.
- FileWriterResultBuilder
- Result builder strategy for file writer executable results.
- FromManifestInstructionBuilder
- Instruction builder that creates link and use collections from manifest metadata.
- MapResultBuilder
- Result builder strategy for map executable results.
- NullInstructionBuilder
- Result builder strategy for null instruction builder executable results.
- NullResultBuilder
- Result builder strategy for null executable results.
- ProxyInstructionBuilder
- Result builder strategy for proxy instruction builder executable results.
- ProxyResultBuilder
- Result builder strategy for proxy executable results.
- SwitchToCliResultBuilder
- Result builder strategy for switch to cli executable results.
- TransformationResultBuilder
- Result builder strategy for transformation executable results.
- DefaultAssetBuilder
- Asset builder strategy for default manifest assets.
- Manifest
- Runtime manifest that loads, normalizes, and resolves Farah assets.
- ManifestContainer
- Container for manifests keyed by Farah URL authority.
- ManifestStrategies
- Strategy bundle used when loading a Farah manifest and building assets.
- XmlTreeLoader
- Tree loader strategy for XML manifest trees.
- Module
- Registry and resolver for Farah modules, manifests, assets, executables, and results.
- Result
- Runtime result for an executable and a Farah stream identifier.
- ResultContainer
- Container for results keyed by Farah URL stream identifiers.
- ResultStrategies
- Strategy bundle used when exposing a result through writer interfaces.
- ChunkWriterStreamBuilder
- Stream builder strategy for chunk writer result streams.
- DOMWriterStreamBuilder
- Stream builder strategy for d o m writer result streams.
- FileInfoStreamBuilder
- Stream builder strategy for file info result streams.
- FileWriterStreamBuilder
- Stream builder strategy for file writer result streams.
- NullStreamBuilder
- Stream builder strategy for null result streams.
- ProxyStreamBuilder
- Stream builder strategy for proxy result streams.
- StreamWriterStreamBuilder
- Stream builder strategy for stream writer result streams.
- StringWriterStreamBuilder
- Stream builder strategy for string writer result streams.
- LookupAssetStrategy
- Request strategy that resolves an incoming request directly to a Farah asset URL.
- LookupPageStrategy
- Request strategy that resolves a sitemap page request to its target Farah asset URL.
- RequestStrategyBase
- Base class for request strategies that convert Farah URLs into PSR-7 responses.
- SendBodyStrategy
- Response strategy that emits only the response body.
- SendHeaderAndBodyStrategy
- Response strategy that emits headers followed by the response body.
- SendHeaderStrategy
- Response strategy that emits only response headers.
- SchemaLocator
- Locates bundled XML schema files for Farah namespaces.
- BannedManager
- Legacy helper for recording and checking banned request origins.
- Session
- Legacy session persistence helper backed by cookies and the slothsoft DBMS layer.
- Domain
- Represents a Farah sitemap domain and resolves page nodes to asset URLs.
- DocumentStreamWrapper
- Stream wrapper for exposing DOM documents as readable resources.
- FarahStreamWrapperFactory
- Stream wrapper factory for resolving farah:// URLs into readable streams.
- StringStreamWrapper
- Stream wrapper for exposing strings as readable resources.
- Archive
- Legacy request tracking archive built on the slothsoft DBMS layer.
- LogTable
- Legacy tracking log table view over archived request data.
- Manager
- Legacy facade for recording Farah request tracking data.
- Tick
- Legacy helper for collecting lightweight timing information.
- View
- Legacy helper for parsing and grouping tracking archive views.
Traits
- LoadChildrenFromManifestTrait
- ResolvePathFromManifestTrait