Classes summary
AbstractAjaxBehaviour |
Super class for ajax behavours Adds in the ajax resources that are needed and
provideds methods for generating callback urls |
AbstractAssociatedMarkupSource |
Mark-up source for components which hav associated mark-up |
AbstractBehaviour |
Abstract behaviour provideds default implementation for each behaviour method
whilst also providing the functionality needed to obtain information about a
behaviour |
AbstractCallableOption |
An options which contains a callback url. When requested the url will invoke the
callback method |
AbstractChoice |
A form component which contains a pre-defined list of posible choices |
AbstractColumn |
A column for use in a data table |
AbstractContextLoader |
Context loader super class |
AbstractDatabaseDriver |
Abstract implementation for databases to share functionality |
AbstractInjectedDataProvider |
A data provider which supports injection |
AbstractJQueryBehaviour |
Adds on the jquery js resource through a listener |
AbstractJQueryUIBehaviour |
Adds on the jQuery ui resources through a render head listener |
AbstractLink |
Super class for links |
AbstractMarkupSource |
Super class for mark-up sourcing |
AbstractMultipleChoice |
A form component with pre-defined choices of which more than 1 |
AbstractOption |
A jquery option |
AbstractPageClassAuthorisationStrategy |
An authorisation strategy for web pages. A page requires an authorised use if it
is a sub class of a given page |
AbstractRepeater |
A component whose mark-up is rendered multiple times based on some form of
repitition |
AbstractSingleChoice |
A form component with pre-defined choices of which 1 can be chosen |
AbstractTextComponent |
A form component which can accept text based input |
AbstractToolbar |
Super class for upper or lower header and footer bars on a data table |
AbstractValidator |
Super class for all validators |
AjaxButton |
A form button which, when clicked will submit the form by ajax |
AjaxEventBehaviour |
Ajax implementation to add an ajax callback to a component when a javascript
event is fired e.g. onclick |
AjaxFormComponentUpdateBehavior |
Description of AjaxFormComponentUpdateBehavior |
AjaxFormSubmitBehavior |
Ajax implmentation that will submit a form on a javascript event By default,
this will be the parent form of the component that this is added to |
AjaxLink |
A link which will not direct to a page but submit an ajax request. The callback
method will be invoked when this happens to allow a response to be created |
AjaxRequestTarget |
Request target for ajax requests |
AllowAllAuthorisationStrategy |
The default authorisation strategy which permits access to everything |
AnnotationRule |
Class scanner rule to match classes with a given annotation |
ApplicationConfigLoadListener |
An application config loaded listener used by the picon application to extract
the loaded config |
ApplicationContext |
Holds any and all resources instantiated by the application initialiser |
ApplicationContextLoadListener |
An application context listener used by the picon application to extract the
context once it is loaded |
ApplicationInitializer |
ApplicationInitialiser works like a bootstrap. This is the first step in the
Picon application and performs the following: |
ApplicationInitializerConfigLoadListenerCollection |
Collection of application config listeners that can be invoked as a single
listener |
ApplicationInitializerContextLoadListenerCollection |
A collection of context listeners which are treated as one listener |
ApplicationProfile |
Domain class for storing application settings |
Args |
Generic helper class for validating method arguments |
ArrayModel |
A model of an array |
ArrayOption |
An option containing an array |
AttributeAppender |
Description of AttributeAppender |
AttributeModifier |
Description of AttributeModifier |
AutoContextLoader |
Automatic loader for context resources Loads resources bassed on pre defined
annotations (Service, Repository) |
AutoLoader |
Auto loads classes via the PHP autoload handle Works through the cache manager
to prevent directory scanning for the same thing time and time again |
BasicModel |
A default model which can contain an object of any type |
BooleanModel |
A model which must be a boolean |
BooleanOption |
Description of BooleanOption |
Border |
A border works in the same way as a panel but does ont replace the origonal
content of the HTML tag it is added to. |
BorderMarkupSourcingStratagy |
Source for border components |
BorderResolver |
Resolves a component for the picon:border element |
Button |
A form button, when submited the callback methods will be invoked based on the
valid state of the form |
CacheManager |
Helper class for saving and loading resources from the cache. |
CallbackAjaxCallDecorator |
An ajax decorator that invokeds a callback function for each of the decorator
options. |
CallbackColumn |
A column which will invoke a callback to populate each cell |
CallbackFunctionOption |
Allows a user specified function to be rendered but wraps with a callback in the
following way |
CallbackOption |
Produces a callback url as the value for the option, the url will resolve to the
supplied callback. |
CallbackRowMapper |
A row mapper that will run the provided callback for each record in a result set |
Check |
A checkbox for use inside a check group |
CheckBox |
A checkbox which may be used independantly, it must have a boolean model |
CheckBoxGroup |
A wrapping component for checks |
CheckChoice |
An automatically populated list of check boxes to choose from. The options are
defined as an array. |
ChoiceRenderer |
For use with abstract choice, allows for any object to be used in the choice
array but enables the output value to be customized |
ClassNameRule |
Class scanner rule for which matching classes will have a name which matches the
given expression |
ClassNamespaceRule |
Class scanner rule in which a class must be declared in the given namespace |
ClassScanner |
Scanner to find classes that match a given set of rules. This expectes any
classes that are to be scanned to have been declared |
Comment |
A comment element of an xml document |
ComonDomainBase |
Super class for any and all domains |
Component |
Component sersvices as the hightest and most abstract super class for all
components. |
ComponentAfterRenderListenerCollection |
A collection of a after render listeners which work as one |
ComponentAuthorisationListener |
A component instantiation listener that detects the users authorisation to use a
component. Passes the component onto the authorisation strategry which will
return a boolen to confirm authorised or not. |
ComponentBeforeRenderListenerCollection |
A collection of before render listeners which work as one |
ComponentInitializationListenerCollection |
A collection of component initialization listeners which work as one |
ComponentInjector |
An instantiation listener which will inject a resource dependencies into the
instatiated component |
ComponentInstantiationListenerCollection |
A collection of instantiation listeners which work as one |
ComponentRenderHeadListenerCollection |
A collection of render head listeners which work as one |
ComponentResolverHelper |
Stores all of the available component resolvers for use during rendering |
ComponentTag |
A markup element which has a picon:id and will expect a component associated
with it |
CompoundPropertyModel |
Compound model which runs from a property of an object |
Config |
Configuration domain object |
ConfigLoader |
A helper class for loading config xml |
ContextLoaderFactory |
|
DaoSupport |
Super class for any user defined DAO Provides easy access to the database
template and allows the DAO to specify which data source to use by implementing
init() |
DataBaseTemplate |
Default implementation of DataBaseOperations Provideds access to functionality
through the source |
DataGridView |
A GridView which is generated from a data provider. |
DataSource |
Holder for all objects required to access a databse, config inforamtion the
connection resource and the drive object |
DataSourceConfig |
Description of DataSourceConfig |
DataSourceFactory |
Factory for creating data sources from configurations |
DataSourceType |
Enum for Types of data source |
DataTable |
A data table, showing information from a data provider, specified by columns. |
DateField |
Text field with a JQuery UI date picker attached |
DatePickerBehaviour |
Behavior to add on jQuery UI date picker functionality |
DefaultDataTable |
A data table which by default adds on a header toolbar and a navigation toolbar |
DefaultJQueryUIBehaviour |
Default jQuery ui implementation applying a given plugin to the bound component
and specifing options |
DefaultMarkupSource |
Default source for mark-up |
DefaultNotAuthorisedListener |
The default unauthorised listener which throws an exception if not authorised |
DialogBehavior |
Description of DialogBehavior |
DirectToPageComponentNotAuthorisedListener |
A not authorised listener for components which will redirect to a given page if
the component is not authorised |
DraggableBehaviour |
Behavior to add on jQuery UI dragable functionality |
DropDown |
A drop down choice HTML select element |
EmailAddressValidator |
Validator to check that the string is a valid email address |
EmptyPanel |
A panel with default and empty mark-up. Useful as a placeholder. |
Enum |
Based on SplEnum, this class allows enumerated types to be created. |
ExceptionPageRequestTarget |
Request target for the error page |
ExtendResolver |
Resolver for picon:child and picon:extend |
FeedbackMessage |
A feedback message for use by the feedback message model and feedback panel |
FeedbackModel |
Session persisted singleton model for feedback messages |
FeedbackPanel |
Panel to display feedback messages |
FileModel |
A model which represents a file upload This provides methods to gain access to
information about a file upload after it has been uploaded. |
FileUploadField |
A form field for uploading files |
Form |
A form which will contain form component. This will process and validate the
post data when the callback is invoked. If a form is submitted with a button,
the appropriate button callback will also be invoked |
FormComponent |
Superclass for all form components |
FormComponentLabel |
A label which can be associated with a form component so that the for
attribute can be added to the output |
FormComponentPanel |
A form component which consists of a panel made up of any other form componets
or any other components for that matter but is treated as a whole as a single
component producing one value. |
FunctionOption |
Produces an option which is a function |
GridItem |
The component used for the cell of a grid view |
GridView |
Literally a repeating view of repeating views. Allows for work with both rows
and coloumns, such as a table |
HeaderContainer |
Represents the <head> element |
HeaderPartContainer |
Represents a <picon:head> element |
HeaderResolver |
Resolver for picon:hid and also the normal html head |
HeaderResponse |
A fragment of a web response for writting the header contributor to |
HeaderToolbar |
A toolbar that shows column headings |
IdenticalValueValidator |
Validator that works on two form components and requires that they both have the
same value |
Identifier |
Represents the identity of a class, the class name and the namespace |
Injector |
Dependency injector for resources. All resources are inject after instantiation.
Although any object can be manually injected at any time. |
JQueryRenderHeadListener |
Renders the jQuery js resource |
JQueryUIRenderHeadListener |
Render head listener for render jquery ui js and css |
Label |
A label is a very simple text based component that can work with almost an HTML
tag. It is used for placing the contents of a model into the body of the
associated tag. |
LabeledMarkupContainer |
A markup container which supports labeling |
Link |
Basic implementation of link |
ListenerCollection |
Represents a collection of listeners that are treated as one listener |
ListenerRequestResolver |
Resolves requests for listener callbacks |
ListenerRequestTarget |
Request target for invoking listeners |
ListItem |
The component that represents an item in a list view |
ListMultiple |
A select multiple box where multiple choices can be chosen |
ListView |
A repeating component which works from an array. A ListItem is added for each
one and a callback invoked to populate it. |
Localizer |
Localizer for a specific component It is through this method that
internationalization support will be added in the future |
ManualContextLoader |
TODO manual loading |
MarkupContainer |
A component which may contain child components, allowing for a composition
hierarchy to be built |
MarkupElement |
An xml tag that is a markup element |
MarkupLoader |
The mark-up loads finds, loads and parses the mark-up for a component class.
This also performs the mark-up merge for picon:child and picon:extend |
MarkupParser |
Parser for picon XML. This works like the XMLParser but will produce different
XMLTag objects for different picon elements |
MarkupUtils |
Helper class for finding specific tags in markup |
MaximumLengthValidator |
Validates a string is not longer than a max length |
MaximumValidator |
Validates a number is not greater than a max value |
MinimumLengthValidator |
Validates a string is not shorter than a minium value |
MinimumValidator |
Validates that a number is not less than a minimum value |
ModalWindow |
Panel which implements the jQuery UI dialog |
MySqlDriver |
Database driver for mysql |
MySqliDriver |
Database driver for mysqli |
NavigationLink |
A link which, when clicked, will set the page of an associated paginatable
component to the specified value |
NavigationToolbar |
A toolbar that shows pagination navigation tools |
Navigator |
A list of navigation links to allow the choice of all pages of a paginatable
component. |
NumbericOption |
Description of PropertyOption |
NumericValidator |
Generic validator for numeric values |
Objects |
Helper class for working with objects |
Options |
A set of jQuery options for use with a jQuery behaviour |
PageInstanceRequestResolver |
Resolver for a page instance that has already been created |
PageInstanceRequestTarget |
Request target for rendering page instances |
PageMap |
Holder for the map to all statfull and statless web pages |
PageMapInitializationListenerCollection |
Description of PageMapInitializationListenerCollection |
PageNotFoundPage |
Default page shown if the request page does not exist |
PageNotFoundRequestTarget |
Request target used if the requested page cannot be located |
PageRequestResolver |
Basic stateless page request resolver |
PageRequestTarget |
Request target for rendering a new stateless page |
PageRequestWithListenerTarget |
Stateless page request that will retrieve and invoke a listener on the page |
PaginatingGridView |
A grid view which is paginatable |
Panel |
A panel allows for a block of mark-up to be encapsulated into reusable
components. A panel consists of an HTML file and a class containing the code to
drive it. Panel can be rendered on any HTML tag. |
PanelMarkupSource |
A mark-up source for panels |
PanelResolver |
A resolver for picon:panel |
PasswordField |
Description of PasswordField |
PatternValidator |
Validats that a string matches a given regular expression |
PiconApplication |
This is the main class for the entire application. |
PiconErrorHandler |
Handles all PHP errors and uncaught exceptions, registers handles upon
instantiation. |
PiconSerializer |
A serialization helper that extends the standard PHP serialization functionality
by permiting serialisazation of closures and providing support for transient
properties. |
PiconTag |
A component tag which is not a component but instead a special picon tag for
example picon:child |
PopupSettings |
Options for the javascript new window function |
PropertyColumn |
A column which shows a simple property of an object |
PropertyModel |
A model which runs from a property of an object |
PropertyOption |
A simple property option for a string |
PropertyResolver |
Utility class for working with properties of objects |
Radio |
A radio button for use inside of a RadioGroup |
RadioChoice |
A list of radio buttons generated from an array of choices. |
RadioGroup |
A container for radio buttons |
RangeLengthValidator |
Validates the length of a string is between minimum and maximum values |
RangeValidator |
Validates that a number is between minimum and maximum values |
RedirectRequestTarget |
A request target which performs a 301 redirect to a page instance |
RepeatingView |
A component which repeates once for each of the child components added to it |
RequestCycle |
Front controller for incoming requests. The represents the process of handling a
request in the following steps:
- Resolves the request to a target
- Executes any listener events
- Produces the response
|
RequestResolverCollection |
Collection of resolvers that work as one |
RequiredTextField |
A text field which is manditory by default |
ResourceReference |
A pointer to a file which is located in the same directory as the class
identifier or one of its super classes |
ResourceRequestResolver |
Resolver for resource requests such as css and js |
ResourceRequestTarget |
Locates and renders a resource e.g. css or js |
SerializableClosure |
A wrapper for closures enabling them to be serialized. IMPORTANT NOTE: This is
highly experimental and needs further improvment and testing |
SortableBehavior |
Behavior to add on jQuery UI sortable functionality |
StaticTabPanel |
A tab panel whos links do not change page but simple swap the visibility of an
inner panel. |
StringValidator |
Generic validator for strings |
SubClassRule |
Rule for the class scanner in which the class must be a sub class of the
specified class name |
Tab |
A tab domain for use with Tab Panel |
TabCollection |
An array of tabs which are added to a tab panel |
TabPanel |
A panel topped by a list of links. The panel changes when each link is clicked |
TextArea |
A text area form component |
TextElement |
A text element or character data of an xml document |
TextField |
A text field component |
TransparentMarkupContainer |
A markup contain which has mark-up but does not have child added to it. Instead
if a child is request from it, the child is requested from the parent instead |
ValidatableFormComponentWrapper |
A wrapper for form components for usage by validators. This is a proxy/ adaptor
whice enables a form validator to work indirectly with a form component to
report validation errors |
ValidationResponse |
Domain object containing all information about a message reported by a
validator. With this, a localized string can be found to render the actual
message |
WebApplicationSecuritySettings |
Holder for security settinsg of the picon application |
WebComponent |
A component which may not contain any child i.e. one which marks the end of
hierarchy for a particular branch |
WebPage |
Super class for all web pages |
WebRequest |
Basic implementation of request |
WebResponse |
Basic implementation of a response |
WrappedCompoundModel |
A proxy model for the compound model |
XMLDocument |
Domain object for repesenting an xml document |
XMLParser |
An xml file parser |
XMLTag |
Class representing an XML tag |
XmlTagType |
Enum for the 3 type of tag state: open, close, openclose |
Interfaces summary
AjaxCallDecorator |
A call decorator. This allows additional javascript to be added for ajax
success, failure and also for before request |
ApplicationInitializerConfigLoadListener |
Listener to provide a callback for when the config has been loaded |
ApplicationInitializerContextLoadListener |
Listener to provide a callback when the application context has loaded |
AuthorisationStrategy |
A strategy for authorisation components |
Behaviour |
A component behavour to modify its default functionality at several steps of its
lifecycle |
BehaviourListener |
Taging interface to note a behaviour as a request listener |
CallDecoratorWrapper |
Marks an object as allowing a call decorator to be set upon it |
ChoiceGroup |
Tagging interface |
ClassScannerRule |
Interface for all class scanner rules |
Column |
Column interface for data table |
ComponentAfterRenderListener |
Listener fired after a component has rendered |
ComponentAwareModel |
Interface for models which rely on being able to access the component that is
using them. |
ComponentBeforeRenderListener |
A listener fired immediatly before a component is rendered |
ComponentInheritedModel |
Interface marking models that require a callback when a component inherits it |
ComponentInitializationListener |
A listener fired when a component is initialized |
ComponentInstantiationListener |
A listener fired when a component is instantiated |
ComponentNotAuthorisedListener |
A listener for unauthorised component instantiation events |
ComponentRenderHeadListener |
A listener fired when the head of a page is about to be rendered |
ComponentResolver |
All picon tags (e.g. picon:head or picon:child) are component tags, but need not
have a component created in the hierarchy for them by the user as a resolve will
create one automatically during the render process |
CompoundModel |
Interface for a model which can contain multiple values for use independantly |
DatabaseDriver |
A database driver implements internally the PHP functions and methods required
when working with a particular DBMS or PHP extension |
DataBaseOperations |
All database operations that are expected |
DataProvider |
Data provider which is used by a data table or data grid view |
Detachable |
This is similar to __destruct however, the destructor is not called before
serialising and sleep cannot be used in all cases as it cannot return parent
private properties. The picon serializer will call detach() before serializing. |
Equalable |
|
FormSubmitListener |
Tagging interface to note a component as a form submit listener |
FormSubmitter |
Denotates a component capable of submiting a form |
Identifiable |
Marks a class as identifiable. This is a way around PHP not having a class class |
InitializingBean |
A bean class that requires a method to be invoked after its injection is
completed. |
InjectOnWakeup |
Tagging interface for sub classes of PiconSerializer which need to be
re-injected during deserialization. |
LinkListener |
Tagging interface to note a component as a link listener |
Listener |
Generic listener for components and behaviours for use with callbacks. |
MarkupSource |
A mark-up source is required to load mark-up for a component and also enables
callbacks for rendering steps (tag, body and head) to customize if needed |
Model |
Model interface |
Pageable |
Interface for components which support pagination |
PageMapInitializationListener |
A listener which is called when the page map is being initialized. This is
during the process of adding pages to the page map and not after, consiquently
this is called only during the page scanning process and will happen only once
unless the page map cache is cleared or disabled |
Request |
Convience class for accessing information about a requests This also provideds
convience methods for analysing the request to determin what kind of request it
is |
RequestablePage |
A page that can be requested by a request target |
RequestResolver |
Resolver for a request |
RequestTarget |
A request target is returned by a request resolver and is responsable for
processing the request and producing output |
Response |
Represents the response for a request |
RowMapper |
Row mapper for mapping SQL rows in result sets to objects |
Validatable |
Interface which must be used for classes that support validation by a Validator |
Validator |
Interface for validators |
XmlElement |
Taging interface for an element that makes up an xml document |