Download the PHP package opus4-repo/framework without Composer

On this page you can find all versions of the php package opus4-repo/framework. 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 framework

OPUS 4 Framework Implementation

The project is using Composer for handling dependencies. The OPUS 4 Framework itself is a Composer package that is used by the OPUS 4 Application.

The OPUS 4 Framework is written in PHP. It also uses Ant for scripting common development actions. The Ant script (build.xml) is used for automation by a continous integration system.

Requirements

The system must meet the following basic requirements in order to run the unit tests:

Dependencies

The dependencies are declared in composer.json and can be downloaded automatically using 

composer install

or 

php composer.phar install

Now the necessary packages are automatically downloaded and installed in the vendor directory.

For more information about Composer: https://getcomposer.org

The script bin/install-composer.sh can be used to automatically download composer.phar, so the most recent version can be used. Composer is also available in most Linux distributions.

Running the Unit Tests

In order to run the unit tests you need to create database and a configuration for the framework.

Creating the database

The database can be setup by executing the setup.sh script. It will create the configuration file and the database with the chosen database name.

cd framework
./bin/setup.sh

The database schema can be created using the createdb.php script.

ant create-database

The database access parameters are stored in tests/config.ini and needs to be configured with the correct user and database name.

Configuring the Framework

This step is optional and needs to be executed only if the previous steps didn't work.

The configuration file (tests/config.ini) can be created using the following command. 

cd tests
./configure.sh

The script will ask you for values for the placeholders in the configuration template file, tests/config.ini.template.

Placeholder Description
db.admin.name Name of MySQL user with full access to OPUS database.
db.params.password Password for MySQL user.
db.params.dbname Name of MySQL database for OPUS.

Creating the workspace folders

The workspace directory for testing can be created using 

ant prepare

Testing

Tests can be run using the Composer

composer test

or executing phpunit directly

vendor/bin/phpunit -c tests

Coding Style

The basic formatting of the code can be checked automatically using

composer cs-check

Most basic styling errors can be fixed automatically using 

composer cs-fix

All versions of framework with dependencies

PHP Build Version
Package Version
Requires ext-dom Version *
ext-pdo Version *
ext-fileinfo Version *
ext-json Version *
ext-libxml Version *
opus4/zf1-future Version 1.21.*
opus4-repo/opus4-common Version ^4.8
opus4-repo/opus4-doi Version ^4.8
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 opus4-repo/framework contains the following files

Loading the files please wait ....