Initial code

Author: tijsverkoyen

Api.php

@@ -0,0 +1,85 @@
+<?php
+
+namespace ForkCms\Api;
+
+/**
+ * @author			Tijs Verkoyen <[email protected]>
+ * @version			1.0.0
+ * @copyright		Copyright (c) 2008, Tijs Verkoyen. All rights reserved.
+ * @license			BSD License
+ */
+class Api
+{
+    // internal constant to enable/disable debugging
+    const DEBUG = false;
+
+    // current version
+    const VERSION = '1.0.0';
+
+    /**
+     * The timeout
+     *
+     * @var	int
+     */
+    private $timeOut = 10;
+
+    /**
+     * The user agent
+     *
+     * @var	string
+     */
+    private $userAgent;
+
+    /**
+     * Default constructor
+     */
+    public function __construct()
+    {
+    }
+
+    /**
+     * Get the timeout that will be used
+     *
+     * @return int
+     */
+    public function getTimeOut()
+    {
+        return (int) $this->timeOut;
+    }
+
+    /**
+     * Get the useragent that will be used. Our version will be prepended to
+     * yours.
+     * It will look like: "PHP ForkAPI/<version> <your-user-agent>"
+     *
+     * @return string
+     */
+    public function getUserAgent()
+    {
+        return (string) 'PHP ForkAPI/'. self::VERSION .' '. $this->userAgent;
+    }
+
+    /**
+     * Set the timeout
+     * After this time the request will stop. You should handle any errors triggered by this.
+     *
+     * @return void
+     * @param  int  $seconds The timeout in seconds.
+     */
+    public function setTimeOut($seconds)
+    {
+        $this->timeOut = (int) $seconds;
+    }
+
+    /**
+     * Set the user-agent for you application
+     * It will be appended to ours, the result will look like: "PHP ForkAPI/<version> <your-user-agent>"
+     *
+     * @return void
+     * @param  string $userAgent Your user-agent, it should look like <app-name>/<app-version>.
+     */
+    public function setUserAgent($userAgent)
+    {
+        $this->userAgent = (string) $userAgent;
+    }
+}

Exception.php

@@ -0,0 +1,11 @@
+<?php
+namespace ForkCms\Api;
+
+/**
+ * ForkCms Exception class
+ *
+ * @author Tijs Verkoyen <tijs@sumocoders>
+ */
+class Exception extends \Exception
+{
+}

LICENSE.md

@@ -0,0 +1,18 @@
+Copyright (c) Fork CMS
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

README.md

@@ -0,0 +1,10 @@
+# ForkCMS Api class
+
+## About
+
+A (wrapper)class to communicate with the your Fork CMS install.
+
+## Documentation
+
+The class is well documented inline. If you use a decent IDE you'll see that
+each method is documented with PHPDoc.