Download the PHP package inspiredminds/contao-bayern-portal without Composer

On this page you can find all versions of the php package inspiredminds/contao-bayern-portal. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Informations about the package contao-bayern-portal

Contao Bayern Portal

This Contao extension allows you to integrate data from the BayernPortal via its REST API.

Usage

Configuration

After installing this extension there will be a new back end module called BayernPortal under which you can create a configuration. Each configuration takes a name and the credentials for the BayernPortal API.

Front End Modules

The extension provides 6 different front end modules - one for each "main" entity type of the API, plus some additional ones:

Each module will list all records retrieved from the API and provide detail links. Each module is also able to show the details of a record. Some of the modules also have the ability to define a redirect page for some entity types, so that the link to the detail view of that entity can be generated accordingly.

Templating

For most entities, there exists a list template and a detail template. The naming convention is bayernportal_<entity-name>_<list-type> - so the list element template for administrations (Behörden) will be named bayernportal_behoerde_list and its detail template will be named bayernportal_behoerde_detail. You can override the contents of these templates as usual. For the module itself there only exists one template that is used accross all modules: mod_bayern_portal.

In all the BayernPortal templates two special methods are available $this->renderList() and $this->renderDetail(). These methods take an API entity as its argument and they will automatically render either the list view or the detail view for that entity. See the default templates for their usage.

Caching

This extension takes advantage of the built in HTTP Cache of Contao and tags the responses according to the elements visible on a page. In order to increase speed and reduce requests to the API, the public cache should be enalbed for the pages which contain any of the aforementioned modules.

However, if you want to invalidate the cache, so that the newest information from the API is shown you do not have to invalidate the whole HTTP cache. Instead this extension provides an additional maintenance module in the back end where you can invalidate the cache for specific entities. So for example, if you changed the details of some contacts (Ansprechpartner), you can then invalidate only the according pages where information about contacts are shown.

Attributions

The development of this extension was funded by the City of Gunzenhausen.

All versions of contao-bayern-portal with dependencies

PHP Build Version
Package Version
Requires ext-intl Version *
php Version ^7.2 || ^8.0
contao/core-bundle Version ^4.9.10
symfony/http-client Version ^4.4 || ^5.1
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package inspiredminds/contao-bayern-portal contains the following files

Loading the files please wait ...