kravalg/mfiles-client

Client for the M-Files API

1.0 2018-08-09 18:29 UTC

Requires

• guzzlehttp/guzzle: ^5
• monolog/monolog: ^1.22

Requires (Dev)

• behat/behat: ^3.3
• bossa/phpspec2-expect: ^2.1
• friendsofphp/php-cs-fixer: ^1.3
• pedrotroller/php-cs-custom-fixer: ^1.6
• phpspec/phpspec: ^3.0
• phpunit/phpunit: ^5.6

proprietary

• Yaroslav Kravtsov

README

This library provides access to M-Files, the intelligent Information Management which introduces the Intelligent Metadata Layer (IML) that unifies information across systems like shared network folders SharePoint, OpenText, Documentum, Box, Dropbox and more.

Here is a link to M-Files's API documentation.
The API samples is available here.

Usage

Documentation

1. Integrate M-Files to your app

Check out how to integrate this M-Files client in your app.

Development

Installation

The development environment runs on Docker and uses docker-compose.

$ cp docker-compose.yml.dist docker-compose.yml

# Edit docker-compose.yml to customize data (UID and GID of your working user) 
$ vim docker-compose.yml

# Run composer
$ ./bin/docker-run composer install

Coding Standards

This project uses php-cs-fixer to maintain coding standards and homogeneity.

To use it:

$ ./bin/docker-run vendor/bin/php-cs-fixer fix

Please add PHPDoc wherever you can.

Testing

This project is tested with PHPSpec and Behat.

Before launching Behat tests, copy .env.dist to .env and customize the parameters for your M-Files test account (all TESTS_*** fields).

### PHPSpec
$ ./bin/docker-phpspec run
# which is a shortcut for:
$ docker-compose run --rm symfony vendor/bin/phpspec run -f pretty

### Behat
$ ./bin/docker-behat
# which is a shortcut for:
$ docker-compose run --rm symfony vendor/bin/behat