Interface ClassScopeApi

Represents core internal classes that run the guts of the framework. These should not be extended. This is the general, generic class scope assignment.

Represents an abstract core class.

Represents a common asset core class. These provide generic universal functionality within their scope to accomplish various common internal tasks. These should not be extended.

Represents an outward api for interacting with the system. These classes present the final api that other 3rd party programs utilize to leverage the functionality of this system through the provided facade. These classes should not be overridden.

Represents a module package designed specifically to extend the core. These are typically released by the same vendor for the explicit purpose of adding additional functionality, but are not appropriate for the main package. These classes should not be overridden.

Represents an extension package designed specifically to provide additional options to the core. These are typically released by the same vendor for the explicit purpose of adding additional, more refined, or more specialized base libraries to the core. These classes should not be overridden.

This classification designates only that the class is a codex, and makes no further assumption about it. You will need to provide your own documentation if you use this scope.

This classification designates only that the class is a bootstrap object, and makes no further assumption about it. You will need to provide your own documentation if you use this scope.

This classification designates only that the class is a auth object, and makes no further assumption about it. You will need to provide your own documentation if you use this scope.

This classification designates only that the class is an enumerator object, and makes no further assumption about it. You will need to provide your own documentation if you use this scope.

This classification designates only that the class is a flag object, and makes no further assumption about it. You will need to provide your own documentation if you use this scope.

This classification designates only that the class is a promise object, and makes no further assumption about it. You will need to provide your own documentation if you use this scope.

This classification designates only that the class is an error object, and makes no further assumption about it. You will need to provide your own documentation if you use this scope.

This classification designates only that the class is an event object, and makes no further assumption about it. You will need to provide your own documentation if you use this scope.

This classification designates only that the class is a routine object, and makes no further assumption about it. You will need to provide your own documentation if you use this scope.

This classification designates only that the class is a design pattern, and makes no further assumption about it. You will need to provide your own documentation if you use this scope.

A pattern that enforces only a single instance of an object.

There is a lot of discussion over whether or not this is an anti-pattern. I tend to agree that is is, but will not exclude it's compatibility from 3rd party integration.

We do not use this pattern internally, but provide the classification for people using this package who want to.

This classification designates only that the class is an entity object, and makes no further assumption about it. You will need to provide your own documentation if you use this scope.

This classification designates only that the class is a job object, and makes no further assumption about it. You will need to provide your own documentation if you use this scope.

This classification designates only that the class is a security object, and makes no further assumption about it. You will need to provide your own documentation if you use this scope.

This classification designates only that the class is a template object, and makes no further assumption about it. You will need to provide your own documentation if you use this scope.

This classification designates only that the class is a utility object, and makes no further assumption about it. You will need to provide your own documentation if you use this scope.

This classification designates only that the class is a router object, and makes no further assumption about it. You will need to provide your own documentation if you use this scope.

This classification designates only that the class is a request object, and makes no further assumption about it. You will need to provide your own documentation if you use this scope.

This is the default for command line interaction. It assumes script execution by default, and will be expected not to modify output content to STDOUT or STDERR in any way.

This is a general purpose scope for command line interaction. It should generally be used by default, unless you know that the request always comes from a human user. This scope will not maintain interractive state with the command line, and will proceed as if each command should have a clean exit after execution.

This also designates command line useage. Unlike the default CGI request, this designates that the request came from an active user, and will allow efforts to apply additional colors, spacing, or interactive input directives.

Classes that expect ongoing state with the command line session must use this scope.

This classification designates only that the class is a response object, and makes no further assumption about it. You will need to provide your own documentation if you use this scope.

This classification designates only that the class is a service object, and makes no further assumption about it. You will need to provide your own documentation if you use this scope.

This classification designates only that the class is a data object, and makes no further assumption about it. You will need to provide your own documentation if you use this scope.

This classification designates only that the class is a parser object, and makes no further assumption about it. You will need to provide your own documentation if you use this scope.

This classification designates only that the class is a record object, and makes no further assumption about it. You will need to provide your own documentation if you use this scope.

This classification designates only that the class is a stream object, and makes no further assumption about it. You will need to provide your own documentation if you use this scope.

This classification designates only that the class is a hook object, and makes no further assumption about it. You will need to provide your own documentation if you use this scope.

This classification designates only that the class is a adapter object, and makes no further assumption about it. You will need to provide your own documentation if you use this scope.

This classification designates only that the class is an extension object, and makes no further assumption about it. You will need to provide your own documentation if you use this scope.

This classification designates only that the class is a module object, and makes no further assumption about it. You will need to provide your own documentation if you use this scope.

This classification designates only that the class is a component object, and makes no further assumption about it. You will need to provide your own documentation if you use this scope.

This classification designates only that the class is a controller object, and makes no further assumption about it. You will need to provide your own documentation if you use this scope.

This classification designates only that the class is a library object, and makes no further assumption about it. You will need to provide your own documentation if you use this scope.

A library intended to be extended

A library that satisfies an expected condition and performs no operation.

A library that provides adapters

A library that provides authorization

A library that provides bootstrap objects

A library that provides collections

A library that provides debug functionality

A library that provides entities

A library that provides events

A library that provides parsing functionality

A library that provides utilities. Individual utilities should not use this, but their aggregators and managers can if it treats them as workers.

A library that provides filehandling functionality

A library that provides or extends logging

Note

A library that provides or extends autoloading

Note

A library that provides or interacts with caching

Note

A library that provides stream or message support

Note

A library that provides container objects

Note

A library that provides container objects

Note

A library provided as a worker. Use this if the worker does not have a more appropriate scope definition.

Note

A library that provides a manager for other related objects

Note

A private module library.

Note

This classification designates only that the class is a model object, and makes no further assumption about it. You will need to provide your own documentation if you use this scope.

This classification designates only that the class is a view object, and makes no further assumption about it. You will need to provide your own documentation if you use this scope.

This classification designates only that the class is a cache object, and makes no further assumption about it. You will need to provide your own documentation if you use this scope.