From 8de289ca124c019759c60ed943bb6f8850bdc295 Mon Sep 17 00:00:00 2001 From: poef Date: Tue, 4 Aug 2015 14:56:27 +0200 Subject: [PATCH 1/3] Added an intro and links to the included packages. --- README.md | 42 ++++++++++++++++++++++++++++++++++++------ 1 file changed, 36 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index f9e1d08..67ef7bf 100644 --- a/README.md +++ b/README.md @@ -4,15 +4,45 @@ ARC: Ariadne Component Library A flexible component library for PHP 5.4+ ----------------------------------------- -The Ariadne Component Library is a spinoff from the Ariadne Web -Application Framework and Content Management System -[ http://www.ariadne-cms.org/ ] +ARC is a set of components, build to be as simple as possible. Each component does just one thing and has a small and +simple API to learn. ARC uses static factory methods to simplify the API while using Dependency Injection. ARC is not a +framework but can be used in combination with any or no framework. + +The Ariadne Component Library is a spinoff from the Ariadne Web Application Platform and Content Management System +[http://www.ariadne-cms.org/](http://www.ariadne-cms.org/). Many of the concepts used in ARC have their origin in Ariadne +and have been in use since 2000. + +The single common unique feature in all components is that they are designed to work in and with a tree structure. URL's +are based on the concept of paths in a filesystem. This same path concept and the underlying filesystem-like tree is +used in all ARC components. + +`arc/grants` stores access rights per path in a tree and allows or disallows access to entire subtrees. This matches +directly with your website URL's. You can grant edit access to a 'mike' for the URL http://www.example.com/users/mike/. +Or disable read access for not-logged in users for http://www.example.com/members-only/. + +`arc/events` uses the path in your URL to fire and listen for events. An event fired on /example/foo/baz/ can be listened +to on /example/. Events trickle 'up' and 'down' the path just like events in a webbrowser move up and down the DOM tree. Installation ------------ -Install via Composer: +Via [Composer](https://getcomposer.org/doc/00-intro.md): + + $ composer require arc/arc + +This will download and install all arc components. But you don't need to do this, you can just download the components +you really need instead. Below is a list of components and what they do: -php composer.phar create-project arc/arc {$path} +- [`arc/base`](https://github.com/Ariadne-CMS/arc-base/): Common datatypes and functionality shared by all ARC components. +Is installed automatically if needed. +- [`arc/cache`](https://github.com/Ariadne-CMS/arc-cache/): Cache functionality and a caching proxy class. +- [`arc/events`](https://github.com/Ariadne-CMS/arc-events/): Fire events and listen for them in a tree structure, +modelled after the browsers DOM events. +- [`arc/config`](https://github.com/Ariadne-CMS/arc-config/): Configuration management, storing and retrieving +configuration settings in a tree structure. +- [`arc/web`](https://github.com/Ariadne-CMS/arc-web/): URL component to ease manipulation of URL's (even non-PHP URL's) +and a HTTP client. Includes an XSS preventer as a bonus. +- [`arc/xml`](https://github.com/Ariadne-CMS/arc-xml/): Parsing and writing XML made simple. +- [`arc/grants`](https://github.com/Ariadne-CMS/arc-grants/): Access control management in a tree structure, like a +filesystem. -This will download and install all arc components. \ No newline at end of file From 2bc55263cf06fd638d41931fd730de56142b7da5 Mon Sep 17 00:00:00 2001 From: Auke van Slooten Date: Wed, 27 Jan 2016 23:41:01 +0100 Subject: [PATCH 2/3] updated dependencies --- composer.json | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/composer.json b/composer.json index 8bce068..a72ebfb 100644 --- a/composer.json +++ b/composer.json @@ -13,12 +13,14 @@ ], "require": { "php": ">=5.4", - "arc/base": "~1.0", - "arc/web": "~1.0", - "arc/xml": "~1.0", + "arc/base": "~2.0", + "arc/web": "~2.0", + "arc/xml": "~2.0", + "arc/html": "~1.0", "arc/cache": "~1.0", "arc/config": "~1.0", "arc/grants": "~1.0", - "arc/events": "~1.0" + "arc/events": "~1.0", + "arc/prototype": "~0.9" } } From cf1311caf11345220840a3ec276cc5191674992e Mon Sep 17 00:00:00 2001 From: Auke van Slooten Date: Wed, 27 Jan 2016 23:45:28 +0100 Subject: [PATCH 3/3] update readme to include arc/html and arc/prototype --- README.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 67ef7bf..d8aaf70 100644 --- a/README.md +++ b/README.md @@ -40,9 +40,10 @@ Is installed automatically if needed. modelled after the browsers DOM events. - [`arc/config`](https://github.com/Ariadne-CMS/arc-config/): Configuration management, storing and retrieving configuration settings in a tree structure. -- [`arc/web`](https://github.com/Ariadne-CMS/arc-web/): URL component to ease manipulation of URL's (even non-PHP URL's) -and a HTTP client. Includes an XSS preventer as a bonus. +- [`arc/web`](https://github.com/Ariadne-CMS/arc-web/): Simple and correct manipulation of URL's, HTTP Headers +and a HTTP client. Also includes a simple intrustion detection component to prevent cross site scripting attacks. - [`arc/xml`](https://github.com/Ariadne-CMS/arc-xml/): Parsing and writing XML made simple. +- [`arc/html`](https://github.com/Ariadne-CMS/arc-html/): Parsing and writing HTML also made simple. - [`arc/grants`](https://github.com/Ariadne-CMS/arc-grants/): Access control management in a tree structure, like a filesystem. - +- [`arc/prototype`](https://github.com/Ariadne-CMS/arc-prototype/): Experimental prototypical inheritance, like javascript.