Adds documentation

Author: moay

README.md

@@ -21,12 +21,12 @@ composer require moay/opensensemap-api-php-client
 Take a look at the implementation example in the directory `example`.
 
 ```php
-$client = \Moay\OpensensemapApiClient\OpensensemapApiClientFactory::create();
+$client = OpensensemapApiClientFactory::create();
 
 // Change senseBox id
 $senseBoxData = $client->getSenseBoxData('someSenseBoxId');
 
-foreach ($senseBoxData->getSensorValues() as $sensorValue) {
+foreach ($senseBoxData as $sensorValue) {
     // $sensorValue->getValueType()
     // $sensorValue->getValue()
     // $sensorValue->getUnit()
@@ -35,6 +35,20 @@ foreach ($senseBoxData->getSensorValues() as $sensorValue) {
 }
 ```
 
+You don't have to iterate over all values, just use this handy function:
+
+```php
+$temperature = $senseBoxData->getValueByType(SensorValue::TYPE_TEMPERATURE);
+```
+
+Outputting values can be done directly by casting the values to strings:
+
+```php
+echo 'Temperature: '.$temperature; // Output: Temperature: 12 °C
+echo $temperature; // Output: 12 °C
+$temperatureString = (string) $temperature // $temperature = '12 °C' 
+```
+
 ## Features
 
 The client gives you the latest data for a specific senseBox from the OpenSenseMap Api.

example/example.php

@@ -2,16 +2,25 @@
 
 require __DIR__.'/../vendor/autoload.php';
 
-$client = \Moay\OpensensemapApiClient\OpensensemapApiClientFactory::create();
+use \Moay\OpensensemapApiClient\OpensensemapApiClientFactory;
+use \Moay\OpensensemapApiClient\SensorValue\SensorValue;
+
+$client = OpensensemapApiClientFactory::create();
 $senseBoxData = $client->getSenseBoxData('5a0c2cc89fd3c200111118f0');
 
-foreach ($senseBoxData->getSensorValues() as $sensorValue) {
+foreach ($senseBoxData as $sensorValue) {
     echo sprintf(
-        '%s: %s %s (Sensor: %s, %s)<br/>',
+        '%s: %s %s (Sensor: %s, %s)'."\n",
         $sensorValue->getValueType(),
         $sensorValue->getValue(),
         $sensorValue->getUnit(),
         $sensorValue->getSensorType(),
         $sensorValue->getMeasurementTime()->format('Y-m-d H:i:s')
     );
 }
+
+$temperature = $senseBoxData->getValueByType(SensorValue::TYPE_TEMPERATURE);
+echo 'Temperature by type: '.$temperature->getValue().' '.$temperature->getUnit()."\n";
+
+// Shorthand string output
+echo 'Temperature by type shorthand: '.$temperature."\n";