Added final versions of Entities, Credentials and Exceptions

Author: mattomlet

README.md

@@ -1,22 +1,31 @@
 PrintNode-PHP
 =============
 
-PrintNode is a cloud printing services which allows you to connect any printer to your application using our PrintNode Client and easy to use JSON API.  
+PrintNode is a cloud printing services which allows you to connect any printer 
+to your application using our PrintNode Client and easy to use JSON API.
 
 See www.printnode.com for more information.
 
-This quick start guide covers using the PHP API library. It shows how to find which Computers and Printers you have available for printing and how you can submit PrintJobs using the provided PHP API libraries.
+This quick start guide covers using the PHP API library. It shows how to find 
+which Computers and Printers you have available for printing and how you can 
+submit PrintJobs using the provided PHP API libraries.
 
 ## Step 1: Sign Up
-Before you can use the API, you will need to sign up to PrintNode account, and make a new API key.  You can sign up here https://app.printnode.com/account/register
+Before you can use the API, you will need to sign up to PrintNode account, and 
+make a new API key.  You can sign up here https://app.printnode.com/account/register
 
 ## Step 2: Add a computer and printer
-To have somewhere to print to you need to download and install the PrintNode desktop client on a computer with some printers. You can download the PrintNode Client installer here - www.printnode.com/download . It should be intuitive to setup but for more detailed instructions please see here: https://www.printnode.com/docs/installation/windows/ .
+To have somewhere to print to you need to download and install the PrintNode 
+desktop client on a computer with some printers. You can download the PrintNode 
+Client installer here - www.printnode.com/download . It should be intuitive 
+to setup but for more detailed instructions please see 
+here: https://www.printnode.com/docs/installation/windows/ .
 
 ## Step 3: Install library
 
 ### Download the PHP Library
-You can download the client from our Github account. If you have a git client installed locally, you can clone our repository 
+You can download the client from our Github account. If you have a git client 
+installed locally, you can clone our repository 
 
 https://github.com/PrintNode/PrintNode-PHP/archive/master.zip
 
@@ -28,4 +37,4 @@ composer require PrintNode/printnode-php:dev-master
 
 ## Step 4: See examples how to use this library
 
-See `examples` directory to learn how to use this library.
+See `examples` directory to learn how to use this library.

src/PrintNode/Bootstrap.php

@@ -5,11 +5,8 @@
  * 
  * Include this file in your script to add the PrintNode Autoloader.
  * 
- * The bootstrap file assumes that all the PrintNode files are located in a 
- * subdirectory called 'PrintNode'.
- * 
  */
 
-require_once('PrintNode/Autoloader.php');
+require_once('Autoloader.php');
 
 \spl_autoload_register('\PrintNode\Autoloader::autoload');

src/PrintNode/Client.php

@@ -44,18 +44,6 @@ class Client
      */
     public $apiHost;
 
-    /**
-     * Request logging callback
-     * @var function
-     */
-    public $requestLogMethod;
-    
-    /**
-     * Response logging callback
-     * @var function
-     */
-    public $responseLogMethod;
-    
     /**
      * Stores the last request object processed
      * @var \PrintNode\Response

src/PrintNode/Credentials/ApiKey.php

@@ -12,6 +12,15 @@ class ApiKey extends \PrintNode\Credentials
     public function __construct ($apiKey)
     {
 
+        if (!\is_string($apiKey)
+            || (mb_strlen(trim($apiKey)) == 0)) {
+            
+            $emsg = 'Argument 1 passed to PrintNode\Credentials\ApiKey::__construct() must be a valid ApiKey string';
+            
+            throw new \PrintNode\Exception\InvalidArgumentException($emsg);
+            
+        }
+        
         $this->apiKey = $apiKey;
 
     }

src/PrintNode/Credentials/Username.php

@@ -13,6 +13,24 @@ class Username extends \PrintNode\Credentials
     public function __construct ($username, $password)
     {
 
+        if (!\is_string($username)
+            || (mb_strlen(trim($username)) == 0)) {
+            
+            $emsg = 'Argument 1 passed to PrintNode\Credentials\ApiKey::__construct() must be a valid username string';
+            
+            throw new \PrintNode\Exception\InvalidArgumentException($emsg);
+            
+        }
+        
+        if (!\is_string($password)
+            || (mb_strlen(trim($password)) == 0)) {
+            
+            $emsg = 'Argument 2 passed to PrintNode\Credentials\ApiKey::__construct() must be a valid password string';
+            
+            throw new \PrintNode\Exception\InvalidArgumentException($emsg);
+            
+        }
+        
         $this->username = $username;
         $this->password = $password;
 

src/PrintNode/Entity.php

@@ -121,4 +121,15 @@ public function jsonSerialize()
 
     }
 
+    /**
+     * Implements the toString magic method.
+     * 
+     * @return string
+     */
+    public function __toString() {
+        
+        return print_r(\json_decode(\json_encode($this->jsonSerialize()), true), true);
+        
+    }
+    
 }

src/PrintNode/Entity/Account.php

@@ -15,6 +15,7 @@
  */
 class Account extends Entity
 {
+    
     /**
      * Account Id
      * @var int 

src/PrintNode/Entity/AccountDetail.php

@@ -14,10 +14,22 @@
 class ChildAccount extends Entity
 {
 
-    protected $Account;
+    /**
+     * A printnode Account object
+     * @var \PrintNode\Entity\Account
+     */
+    public $Account;
 
+    /**
+     * An array of API keys
+     * @var array
+     */
     public $ApiKeys;
 
+    /**
+     * An array of tags
+     * @var array
+     */
     public $Tags;
 
     /**
@@ -30,11 +42,4 @@ class ChildAccount extends Entity
         'Tags' => null,
     );
 
-    public function addAccount(\PrintNode\Entity\Account $Account)
-    {
-        
-        $this->Account = $Account;
-        
-    }
-    
 }

src/PrintNode/Entity/ChildAccount.php

@@ -23,15 +23,64 @@
 class ClientDownload extends Entity
 {
 
+    /**
+     * The client download id
+     * @var int
+     */
     protected $id;
+    
+    /**
+     * The flag that indicates if this download is currently available
+     * @var bool
+     */
     protected $enabled;
+    
+    /**
+     * The edition of the client download
+     * @var string
+     */
     protected $edition;
+    
+    /**
+     * The client version
+     * @var string
+     */
     protected $version;
+    
+    /**
+     * The operating system for which this client download is intended
+     * @var string
+     */
     protected $os;
+    
+    /**
+     * The filename for this client installer
+     * @var string
+     */
     protected $filename;
+    
+    /**
+     * The file size of the client installer
+     * @var string
+     */
     protected $filesize;
+    
+    /**
+     * SHA1 fingerprint for the client installer
+     * @var string
+     */
     protected $sha1;
+    
+    /**
+     * The timestamp for the client installer release
+     * @var int
+     */
     protected $releaseTimestamp;
+    
+    /**
+     * The URL at which the client installer can be downloaded
+     * @var int
+     */
     protected $url;
 
     /**

src/PrintNode/Entity/ClientDownload.php

@@ -23,16 +23,70 @@
 class Computer extends Entity
 {
 
+    /**
+     * Computer Id
+     * @var int 
+     */
     protected $id;
+    
+    /**
+     * Computer Name
+     * @var string
+     */
     protected $name;
+    
+    /**
+     * Reserved
+     * @var mixed
+     */
     protected $inet;
+        
+    /**
+     * Reserved
+     * @var mixed
+     */
     protected $inet6;
+    
+    /**
+     * Reserved
+     * @var mixed
+     */    
     protected $hostname;
+    
+    /**
+     * Reserved
+     * @var mixed
+     */
     protected $version;
+    
+    /**
+     * Reserved
+     * @var mixed
+     */
     protected $jre;
+    
+    /**
+     * Reserved
+     * @var mixed
+     */
     protected $systemInfo;
+    
+    /**
+     * Reserved
+     * @var mixed
+     */
     protected $acceptOfflinePrintJobs;
+    
+    /**
+     * The time and date the computer was first registered with PrintNode
+     * @var mixed
+     */
     protected $createTimestamp;
+    
+    /**
+     * Current state of the computer
+     * @var mixed
+     */
     protected $state;
 
     /**
@@ -53,24 +107,30 @@ class Computer extends Entity
         'state' => null,
     );
 
-    public function viewPrinters($printerSet = null)
-    {
-        
-        
-        
-    }
-    
-    public function viewPrintJobs()
+    /**
+     * Returns an array of the printers present on this computer
+     * 
+     * @param int $offset 
+     * @param int $limit
+     * @param mixed $printerSet
+     * @return array
+     */
+    public function viewPrinters($offset = 0, $limit = 500, $printerSet = null)
     {
 
-        
+        return $this->client->viewPrinters($offset, $limit, $printerSet, $this->id);
 
     }
 
-    public function viewScales()
+    /**
+     * 
+     * @param type $deviceName
+     * @param type $deviceNumber
+     */
+    public function viewScales($deviceName = null, $deviceNumber = null)
     {
 
-        
+        return $this->client->viewScales($this->id, $deviceName, $deviceNumber);
 
     }