https://github.com/s1syphos/php-dejure

Linking texts with dejure.org, the Class(y) way.
https://github.com/s1syphos/php-dejure

Last synced: 1 day ago
JSON representation

Linking texts with dejure.org, the Class(y) way.

• Host: GitHub
• URL: https://github.com/s1syphos/php-dejure
• Owner: S1SYPHOS
• License: mit
• Created: 2021-06-22T10:44:23.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2021-10-26T04:37:45.000Z (about 3 years ago)
• Last Synced: 2024-10-12T15:38:48.857Z (26 days ago)
• Language: PHP
• Size: 82 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# php-dejure

[![Release](https://img.shields.io/github/release/S1SYPHOS/php-dejure.svg)](https://github.com/S1SYPHOS/php-dejure/releases) [![License](https://img.shields.io/github/license/S1SYPHOS/php-dejure.svg)](https://github.com/S1SYPHOS/php-dejure/blob/master/LICENSE) [![Issues](https://img.shields.io/github/issues/S1SYPHOS/php-dejure.svg)](https://github.com/S1SYPHOS/php-dejure/issues) [![Status](https://travis-ci.org/S1SYPHOS/php-dejure.svg?branch=master)](https://travis-ci.org/S1SYPHOS/php-dejure)

A PHP library for linking legal norms in texts with [dejure.org](https://dejure.org).

## History

This library started as an OOP port of `vernetzungsfunction.inc.php`, which can be [downloaded here](https://dejure.org/vernetzung.html). Since then, `php-dejure` heavily modified the underlying caching mechanism, now providing a broad range of fully configurable cache drivers while featuring more text processing options.

## Getting started

Install this package with [Composer](https://getcomposer.org):

```text

composer require S1SYPHOS/php-dejure

```

An example implementation could look something like this:

```php

setEmail('[email protected]');

$object->setTarget('_blank');

$text  = '
';

$text .= 'This is a simple HTML text.';

$text .= 'It contains legal norms, like Art. 12 GG.';

$text .= '.. or § 433 BGB!';

$text .= '
';


echo $object->dejurify($text);

```

## Roadmap

- [x] ~~Add tests~~

- [x] ~~Add checks to `__construct`~~

- [x] ~~Attempt cache directory creation~~

- [x] ~~Improve code~~

- [x] ~~Improve code more~~

- [x] ~~Translate code (almost done)~~

- [x] ~~`join` paths, so trailing slash is no longer required~~

- [x] ~~Add cache reset function~~

**Happy coding!**