ILIAS  release_5-3 Revision v5.3.23-19-g915713cf615
ILIAS Namespace Reference

Class BaseForm. More...

Namespaces

 BackgroundTasks
 Created by PhpStorm.
 
 Data
 
 DI
 Class HTTPServicesTest.
 
 File
 
 FileDelivery
 
 Filesystem
 
 FileUpload
 
 HTTP
 
 Modules
 
 Transformation
 
 UI
 
 Validation
 
 WebAccessChecker
 

Detailed Description

Class BaseForm.

Class Renderer .

Trait Triggerer.

Class TriggeredSignal.

Interface SignalGeneratorInterface.

Class SignalGenerator.

Class Signal.

Class StandardPopover.

Class ReplaceContentSignal.

Class Popover.

Class ListingPopover.

Class Sub .

Class Standard .

Class Renderer .

Class Panel .

Class Listing .

Class Factory .

Class Renderer .

Class Listing .

Class Descriptive .

Class Renderer .

Class Legacy .

Class Renderer .

Class Image .

Class Factory .

Class Wrapper.

Class Standard.

Class Renderer.

Class Dropzone.

Class ScaleBar .

Class Factory .

Interface Triggerer.

Interface Triggerable.

Interface Signal.

A standard popover renders any other component as its content.

This signal replaces the content of a Popover with some content returned by an ajax request.

A listing popover renders multiple items as a list.

Interface Standard .

Interface Appointment .

Interface Factory .

Interface Onloadable.

Interface Lightbox.

Interface Interruptive.

Interface Unordered .

Interface Ordered .

Interface Descriptive .

Interface Legacy .

Interface Standard Item .

This describes how a glyph could be modified during construction of UI.

Interface Hoverable.

Interface Wrapper.

Interface Standard.

Interface File.

Interface Factory.

Interface Droppable.

Interface Clickable.

Interface Card .

Interface for Breadcrumbs .

Interface StatusCode.

Exception ResponseSendingException.

Class NullResponseSenderStrategy.

Class ResponseFactoryImpl.

Interface ResponseFactory.

Class RequestFactoryImpl.

Interface RequestFactory.

Class CookieWrapper.

Class CookieJarWrapper.

Class CookieJarFactoryImpl.

Interface CookieJarFactory.

Interface CookieJar.

Class CookieFactoryImpl.

Interface CookieFactory.

Interface Cookie.

Class FilenameSanitizerImpl.

Interface FilenameSanitizer.

Class ReadOnlyDecorator.

Class FilesystemWhitelistDecorator.

Class NoSuchServiceException .

Class InvalidClassException .

Class Exception .

Class ClientId .

Interface Worker.

Interface Value.

Class VoidType.

Class ListType.

Interface TaskManager.

Interface Task.

Interface UserInteraction.

Interface Option.

Interface Job.

Class ThunkValue.

Class ListValue.

Class AbstractValue.

Class DownloadInteger.

Class AbstractTask.

Class AbstractJob.

Class MockObserver.

Class BasicTaskManager.

Class BasicBucketMeta.

Class BucketNotFoundException.

Interface ExceptionHandler.

Class Factory.

Class NoSuchServiceException.

Class InvalidClassException.

Class Exception.

Class BaseDependencyMap.

Interface Observer.

Class StateTranslator.

Author
Oskar Truffer ot@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch

Contains several chained tasks and infos about them.

A meta bucket contains infos about a bucket like its percentage, name etc.

Author
Oskar Truffer ot@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch

Top Level Exception for DIC Exceptions.

Author
Oskar Truffer ot@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch

This method is thrown when the DI tries to instantiate a class that somehow cannot be instantiated.

Author
Oskar Truffer ot@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch

If the DIC does not contain a service that is required.

Author
Oskar Truffer ot@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch

Create instances of classes using type hinting and the dependency injection container.

Author
Oskar Truffer ot@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch
     Use custom ExceptionHandlers for your Buckets to handle exceptions in your tasks
     gracefully

The Basic Exception Class for BackgroundTasks. Please Specify by extending

A bucket that contains a user interaction needs at least one user that observes it.

If something goes wrong in writing a task/bucket to the database.

Author
Oskar Truffer ot@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch

If you don't want to load the whole task structure of a bucket you will get an empty bucket. You get meta-info about the bucket but cannot access its tasks etc. because they are not loaded yet.

Author
Oskar Truffer ot@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch

Basic Task manager. Will execute tasks immediately.

Some important infos:

  • The bucket and its tasks are not saved into the db upon execution
  • The percentage and current task are not updated during execution.
  • The bucket and its tasks inkl. percentage and current task are only saved into the DB when a user interaction occurs.
Author
Oskar Truffer ot@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch
Author
Oskar Truffer ot@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch
Author
Oskar Truffer ot@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch

Example User Interaction. You will be able to download a number in a file.

Author
Oskar Truffer ot@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch

The type of the list will be the lowest common type in the list e.g. [ScalarValue] if its a list containing IntegerValues and FloatValues.

Author
Oskar Truffer ot@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch

Represents a value that has not yet been calculated.

Author
Oskar Truffer ot@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch
     A Task, which can be run without any interaction with the user, such as zipping files
     or just collecting some data
     Whenever a user is asked about the further course of his tasks (userinteraction),
     options will show up
     A Task in the Bucket, which will need some User-Interaction before running the task.
     A Task is the basic interface of an "thing" which can be put into a Bucket and will be
     run or triggered by the BackgroundTask-Worker. Currently there are two types of Tasks:
     - Job: A Task, which can be run without any interaction with the user such as zipping
     files or just collecting some data
     - UserInteraction: A Task in the Bucket, which will need some User-Interaction before
     running the task. A User-Interaction is provided as Button in the UserInterface such as
     [ Cancel ] or [ Download ]

We add, remove or observe buckets with the background task manager.

The Basic Exception Class for Types. Please Specify by extending.

Thrown if some procedure did not get the arguments it expected.

Author
Oskar Truffer ot@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch

Describes a list of a certain Type.

Attention: isExtensionOf behaves Covariant! new ListType(Dog::class).isExtensionOf(new ListType(Animal::class)) == true!

See: https://en.wikipedia.org/wiki/Covariance_and_contravariance_(computer_science)

Author
Oskar Truffer ot@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch

Void Type and Singleton for the void type.

The Value as a defined format of data passed between two tasks. IO MUST be serialisable since it will bes stored in the database or somewhere else

           A Worker will go through background tasks and do some work on them. How much it
           does depends on the implementation.
Author
Michael Jansen mjans.nosp@m.en@d.nosp@m.ataba.nosp@m.y.de

Top Level Exception for DIC Exceptions.

Author
Oskar Truffer ot@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch

This method is thrown when the DI tries to instantiate a class that somehow cannot be instantiated.

Author
Oskar Truffer ot@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch

If the DIC does not contain a service that is required.

Author
Oskar Truffer ot@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch

The filesystem white list decorator rewrites forbidden file endings and delegates the rest of the operation to the concrete filesystem implementation which is wrapped by the decorator.

Author
Nicolas Schäfli ns@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch
Version
1.0.0
Since
5.3.4

The filesystem ready only decorator provides read only access and will throw an Exception whenever code tries to write files.

Author
Fabian Schmid fs@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch
Version
1.0.0
Since
5.3.6

The filename sanitizer verifies and fixes file name endings. It will not check the file for invalid character or other potential problems.

Author
Nicolas Schäfli ns@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch
Version
1.0
Since
5.3.4

Standard implementation of the filename sanitizing interface.

Author
Nicolas Schäfli ns@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch
Version
1.0.0
Since
5.3.4

ILIAS cookie representation. All implementations must be immutable.

Author
Nicolas Schäfli ns@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch
Since
5.3
Version
1.0.0

The cookie factory provides different methods to create cookies.

Author
Nicolas Schaefli ns@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch
Since
5.3
Version
1.0.0

The cookie factory provides different methods to create cookies.

Author
Nicolas Schaefli ns@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch
Since
5.3
Version
1.0.0

The cookie jar represents a collection of cookies.

The cookie jar never manipulates the response automatically. Therefore please call the renderIntoResponseHeader method, when you are done manipulating the cookies.

Please note that all concrete implementations of the jar must be immutable. There is no need to implement custom deep copy mechanism because the cookie itself must be immutable to.

Author
Nicolas Schäfli ns@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch
Since
5.3
Version
1.0.0

The cookie jar factory provides methods to create cookie jars.

Author
Nicolas Schaefli ns@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch
Since
5.3
Version
1.0.0

Wrapper class for the FigCookies SetCookies class.

Author
Nicolas Schäfli ns@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch
Since
5.3
Version
1.0.0

Facade class for the FigCookies SetCookie class.

Author
Nicolas Schäfli ns@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch
Since
5.3
Version
1.0.0

The RequestFactory produces PSR-7 compliant ServerRequest instances.

Author
Nicolas Schaefli ns@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch

This class creates new psr-7 compliant ServerRequests and decouples the used library from ILIAS components.

The currently used psr-7 implementation is created and published by guzzle under the MIT license. source: https://github.com/guzzle/psr7

Author
Nicolas Schaefli ns@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch

The ResponseFactory produces PSR-7 compliant Response instances.

Author
Nicolas Schaefli ns@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch

This class creates new psr-7 compliant Response and decouples the used library from ILIAS components.

The currently used psr-7 implementation is created and published by guzzle under the MIT license. source: https://github.com/guzzle/psr7

Author
Nicolas Schaefli ns@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch

Noop implementation for testing purposes.

Author
Nicolas Schaefli ns@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch

Represents response sending problems.

Describes most common HTTP-Status-Codes

Author
Nicolas Schäfli ns@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch

Describes a component that can trigger signals of other components on click.

Describes a UI component that can handle drop events from the browser.

Author
nmaerchy nm@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch
Date
05.05.17
Version
0.0.1

Describes a factory implementation for ILIAS UI File Dropzones.

Author
nmaerchy nm@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch

Describes a factory for file dropzones.

Author
nmaerchy nm@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch
Stefan Wanzenried sw@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch

A dropzone where one can drop files on it to be uploaded on the server.

Author
nmaerchy nm@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch

A standard file dropzone offers the possibility to upload dropped files to the server. The dropzone also displays a button to select the files manually from the hard disk.

Author
nmaerchy nm@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch

A wrapper file drozpone wraps around any other component from the UI framework, e.g. a calendar entry. Any wrapper dropzone is highlighted as soon as some files are dragged over the browser window. Dropping the files opens a modal where the user can start the upload process.

Author
nmaerchy nm@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch

Describes a component that can trigger signals of other components on hover.

Interface Image

Describes a component that can trigger signals of other components on load.

Author
Stefan Wanzenried sw@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch

A signal describes an event of a component which can be triggered by another component acting as triggerer. For example, a modal offers signals for showing and closing itself. A button (which is a triggerer component) can trigger the show signal of a modal on click, which will open the modal on button click.

Describes a component offering signals that can be triggered by other components on events. Example: A modal offers signals to show and close the modal.

A signal is represented by a unique string identifier and may offer some options which can be passed by a triggerer component when triggering the signal.

Describes a component that can trigger signals of other components on given events, such as click or hover. All supported events are abstracted with interfaces (see Clickable, Hoverable). Example: A button can trigger the show signal of a modal on click (which will open the modal on button click).

Author
nmaerchy nm@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch

Basic implementation for dropzones. Provides functionality which are needed for all dropzones.

Author
nmaerchy nm@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch

Renderer implementation for file dropzones.

Author
nmaerchy nm@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch
Stefan Wanzenried sw@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch
Author
Stefan Wanzenried sw@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch
Stefan Wanzenried sw@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch

Provides helper methods and default implementation for components acting as triggerer

Author
Stefan Wanzenried sw@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch