From deb3f5675bdee14536cbdcbb584ca50f0156890b Mon Sep 17 00:00:00 2001 From: Jakob Murko Date: Thu, 27 Nov 2014 02:34:42 +0100 Subject: [PATCH] Bump version, regenerate documentation, cosmetic fixes --- LICENSE.md | 2 +- README.md | 42 +- doc/.htaccess | 5 + ...Databox.Client.DataboxClientInterface.html | 73 +- doc/classes/Databox.DataboxBuilder.html | 271 ++++--- doc/classes/Databox.DataboxClient.html | 293 ++++--- doc/classes/Databox.DataboxException.html | 149 ++-- doc/classes/Databox.Event.AuthListener.html | 137 ++-- .../Databox.Event.ExceptionListener.html | 92 +-- doc/classes/Databox.KPI.html | 278 ++++--- doc/classes/Databox.Widget.Base.html | 108 +-- doc/classes/Databox.Widget.Funnel.html | 151 ++-- doc/classes/Databox.Widget.Messages.html | 277 ++++--- doc/classes/Databox.Widget.Pie.html | 258 +++--- doc/classes/Databox.Widget.Pipeline.html | 151 ++-- doc/classes/Databox.Widget.Progress.html | 306 +++----- .../Databox.Widget.Table.ColumnData.html | 225 +++--- doc/classes/Databox.Widget.Table.html | 377 ++++----- doc/css/bootstrap-combined.no-icons.min.css | 732 ++++++++++++++++++ doc/css/font-awesome.min.css | 403 ++++++++++ doc/css/template.css | 13 +- .../Client%2FDataboxClientInterface.php.txt | 23 + doc/files/Client.DataboxClientInterface.html | 361 +++++++++ doc/files/DataboxBuilder.html | 361 +++++++++ doc/files/DataboxBuilder.php.txt | 36 +- doc/files/DataboxClient.html | 361 +++++++++ doc/files/DataboxClient.php.txt | 66 +- doc/files/DataboxException.html | 361 +++++++++ doc/files/Event%2FAuthListener.php.txt | 64 ++ doc/files/Event%2FExceptionListener.php.txt | 36 + doc/files/Event.AuthListener.html | 361 +++++++++ doc/files/Event.ExceptionListener.html | 361 +++++++++ doc/files/KPI.html | 361 +++++++++ doc/files/KPI.php.txt | 45 +- doc/files/Widget%2FBase.php.txt | 37 + doc/files/Widget%2FFunnel.php.txt | 6 + doc/files/Widget%2FMessages.php.txt | 51 ++ doc/files/Widget%2FPie.php.txt | 52 ++ doc/files/Widget%2FPipeline.php.txt | 6 + doc/files/Widget%2FProgress.php.txt | 66 ++ doc/files/Widget%2FTable%2FColumnData.php.txt | 93 +++ doc/files/Widget%2FTable.php.txt | 168 ++++ doc/files/Widget.Base.html | 361 +++++++++ doc/files/Widget.Funnel.html | 361 +++++++++ doc/files/Widget.Messages.html | 361 +++++++++ doc/files/Widget.Pie.html | 361 +++++++++ doc/files/Widget.Pipeline.html | 361 +++++++++ doc/files/Widget.Progress.html | 361 +++++++++ doc/files/Widget.Table.ColumnData.html | 361 +++++++++ doc/files/Widget.Table.html | 361 +++++++++ doc/files/config.html | 355 +++++++++ doc/files/config.php.txt | 10 +- doc/font/FontAwesome.otf | Bin 0 -> 75188 bytes doc/font/fontawesome-webfont.eot | Bin 0 -> 72449 bytes doc/font/fontawesome-webfont.svg | 504 ++++++++++++ doc/font/fontawesome-webfont.ttf | Bin 0 -> 141564 bytes doc/font/fontawesome-webfont.woff | Bin 0 -> 83760 bytes doc/graphs/class.html | 29 +- doc/graphs/classes.svg | 183 +++++ doc/index.html | 51 +- doc/js/bootstrap.min.js | 7 + doc/js/html5.js | 8 + doc/js/jquery-1.11.0.min.js | 4 + doc/js/jquery.mousewheel.js | 201 +++++ doc/js/ui/1.10.4/jquery-ui.min.js | 7 + doc/namespaces/Databox.Client.html | 51 +- doc/namespaces/Databox.Event.html | 51 +- doc/namespaces/Databox.Widget.Table.html | 51 +- doc/namespaces/Databox.Widget.html | 51 +- doc/namespaces/Databox.html | 51 +- doc/namespaces/default.html | 51 +- doc/reports/deprecated.html | 33 +- doc/reports/errors.html | 416 ++++++---- doc/reports/markers.html | 108 ++- src/Databox/DataboxBuilder.php | 2 +- src/Databox/DataboxClient.php | 2 +- src/Databox/Widget/Table.php | 6 +- 77 files changed, 10662 insertions(+), 2077 deletions(-) create mode 100644 doc/.htaccess create mode 100644 doc/css/bootstrap-combined.no-icons.min.css create mode 100644 doc/css/font-awesome.min.css create mode 100644 doc/files/Client%2FDataboxClientInterface.php.txt create mode 100644 doc/files/Client.DataboxClientInterface.html create mode 100644 doc/files/DataboxBuilder.html create mode 100644 doc/files/DataboxClient.html create mode 100644 doc/files/DataboxException.html create mode 100644 doc/files/Event%2FAuthListener.php.txt create mode 100644 doc/files/Event%2FExceptionListener.php.txt create mode 100644 doc/files/Event.AuthListener.html create mode 100644 doc/files/Event.ExceptionListener.html create mode 100644 doc/files/KPI.html create mode 100644 doc/files/Widget%2FBase.php.txt create mode 100644 doc/files/Widget%2FFunnel.php.txt create mode 100644 doc/files/Widget%2FMessages.php.txt create mode 100644 doc/files/Widget%2FPie.php.txt create mode 100644 doc/files/Widget%2FPipeline.php.txt create mode 100644 doc/files/Widget%2FProgress.php.txt create mode 100644 doc/files/Widget%2FTable%2FColumnData.php.txt create mode 100644 doc/files/Widget%2FTable.php.txt create mode 100644 doc/files/Widget.Base.html create mode 100644 doc/files/Widget.Funnel.html create mode 100644 doc/files/Widget.Messages.html create mode 100644 doc/files/Widget.Pie.html create mode 100644 doc/files/Widget.Pipeline.html create mode 100644 doc/files/Widget.Progress.html create mode 100644 doc/files/Widget.Table.ColumnData.html create mode 100644 doc/files/Widget.Table.html create mode 100644 doc/files/config.html create mode 100644 doc/font/FontAwesome.otf create mode 100644 doc/font/fontawesome-webfont.eot create mode 100644 doc/font/fontawesome-webfont.svg create mode 100644 doc/font/fontawesome-webfont.ttf create mode 100644 doc/font/fontawesome-webfont.woff create mode 100644 doc/graphs/classes.svg create mode 100644 doc/js/bootstrap.min.js create mode 100644 doc/js/html5.js create mode 100644 doc/js/jquery-1.11.0.min.js create mode 100644 doc/js/jquery.mousewheel.js create mode 100644 doc/js/ui/1.10.4/jquery-ui.min.js diff --git a/LICENSE.md b/LICENSE.md index b415320..a705343 100755 --- a/LICENSE.md +++ b/LICENSE.md @@ -1,7 +1,7 @@ The MIT License =============== -Copyright (c) 2013 OnlineCity ApS +Copyright (c) 2014 Jakob Murko Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal diff --git a/README.md b/README.md index 3449879..74fb366 100755 --- a/README.md +++ b/README.md @@ -19,30 +19,20 @@ The PHP SDK for interacting with the Databox Push API. ## Autoloading `databox-php-sdk` uses [Composer](http://getcomposer.org). -The first step to use `databox-php-sdk` is to download composer: +The first step to use `databox-php-sdk` is to download composer, if we don't have it already: ```bash $ curl -s http://getcomposer.org/installer | php ``` -Then we have to install our dependencies using: +Then we can add `databox-php-sdk` as a dependency: ```bash -$ php composer.phar install -``` -Now we can use autoloader from Composer by: - -```yaml -{ - "require": { - "databox/databox-php-sdk": "*" - }, - "minimum-stability": "dev" -} +$ composer.phar require databox/databox-php-sdk:1.* ``` -> `databox-php-sdk` follows the PSR-0 convention names for its classes, which means you can easily integrate `databox-php-sdk` classes loading in your own autoloader. +> `databox-php-sdk` follows the PSR-0 convention for file structuring and class naming, which means you can easily integrate `databox-php-sdk` classloading in your own autoloader. -## Basic usage of the `databox-php-sdk client +## Basic usage ```php addSlice("Salami", 50, -10); $pie->addSlice("Tuna", 70, -30); $builder->addWidget($pie); -$pie = new Widget\Funnel("testfunnel"); -$pie->addSlice("Cheese", 5); -$pie->addSlice("Meat", 90, -10); -$pie->addSlice("Apples", 10, -30); -$builder->addWidget($pie); - -$pie = new Widget\Pipeline("testpipeline"); -$pie->addSlice("Mac", 20, 24); -$pie->addSlice("PC", 30, -10); -$pie->addSlice("Amiga", 10, -10); -$builder->addWidget($pie); +$funnel = new Widget\Funnel("testfunnel"); +$funnel->addSlice("Cheese", 5); +$funnel->addSlice("Meat", 90, -10); +$funnel->addSlice("Apples", 10, -30); +$builder->addWidget($funnel); + +$pipeline = new Widget\Pipeline("testpipeline"); +$pipeline->addSlice("Mac", 20, 24); +$pipeline->addSlice("PC", 30, -10); +$pipeline->addSlice("Amiga", 10, -10); +$builder->addWidget($pipeline); //You must provide uniqueURL and payload parameters. Payload can be any JSON string, but we reccommend you use our builder class. try { diff --git a/doc/.htaccess b/doc/.htaccess new file mode 100644 index 0000000..7b01f9b --- /dev/null +++ b/doc/.htaccess @@ -0,0 +1,5 @@ +# Fixes a vulnerability in CentOS: http://stackoverflow.com/questions/20533279/prevent-php-from-parsing-non-php-files-such-as-somefile-php-txt + + RemoveHandler .php + ForceType text/plain + \ No newline at end of file diff --git a/doc/classes/Databox.Client.DataboxClientInterface.html b/doc/classes/Databox.Client.DataboxClientInterface.html index 144353b..5af736c 100644 --- a/doc/classes/Databox.Client.DataboxClientInterface.html +++ b/doc/classes/Databox.Client.DataboxClientInterface.html @@ -7,17 +7,17 @@ - - + + - - - + + + @@ -87,7 +87,7 @@