Initial implementation

Author: alfmel

db/zend_tutorial.db

@@ -0,0 +1,142 @@
+<?php
+
+namespace ZendTutorialInCougar;
+
+use Cougar\Security\iSecurity;
+
+# Initialize the Cougar framework and add the application path
+require_once("cougar.php");
+\Cougar\Autoload\FlexAutoload::addPath(__DIR__, 1);
+
+/**
+ * Provides the Album API, which allows for the querying, creating, reading,
+ * updating and deleting of Albums.
+ */
+class Album
+{
+    /**
+     * Stores the references to the security context and model factory.
+     *
+     * @param \Cougar\Security\iSecurity $security
+     *   Security context
+     * @param AlbumModelFactory $factory
+     *   Album model factory
+     */
+    public function __construct(iSecurity $security, AlbumModelFactory $factory)
+    {
+        // Store the references
+        $this->security = $security;
+        $this->factory = $factory;
+    }
+
+    /**
+     * Returns a list of albums. You may optionally pass a list of query
+     * parameters to limit your search.
+     *
+     * @Path /album
+     * @Methods GET
+     * @GetQuery query
+     * @XmlRootElement albums
+     * @XmlObjectName album
+     *
+     * @var array $query
+     *   Optional query parameters
+     * @return array Album list
+     */
+    public function getAlbumList(array $query = array())
+    {
+        $pdo_model = $this->factory->AlbumPdoModel();
+        return $pdo_model->query($query);
+    }
+
+    /**
+     * Creates a new album with the given Artist and Title.
+     *
+     * @Path /album
+     * @Methods POST
+     * @Accepts json
+     * @Body album object
+     * @XmlRootElement album
+     *
+     * @var mixed $album
+     *   Album model, object or assoc. array with album information
+     * @return AlbumModel New album as a model
+     */
+    public function createAlbum($album)
+    {
+        $new_album = $this->factory->AlbumPdoModel();
+        $new_album->__import($album);
+        $new_album->save();
+
+        # Detach from database
+        return $this->factory->AlbumModel($new_album);
+    }
+
+    /**
+     * Gets the album associated with the given Album ID
+     *
+     * @Path /album/:id
+     * @Methods GET
+     * @XmlRootElement album
+     *
+     * @var int $id
+     *   Album ID
+     * @return AlbumModel Album
+     * @throws \Cougar\Exceptions\RecordNotFoundException
+     */
+    public function getAlbum($id)
+    {
+        $album = $this->factory->AlbumPdoModel(array("id" => $id));
+
+        # Detach from the database
+        return $this->factory->AlbumModel($album);
+    }
+
+    /**
+     * Updates the given album with the new information (ID cannot be changed)
+     *
+     * @Path /album/:id
+     * @Methods PUT
+     * @Accepts json
+     * @Body album object
+     * @XmlRootElement album
+     *
+     * @var mixed $album
+     *   Album model, object or assoc. array with ID and updated information
+     * @return AlbumModel updated album
+     */
+    public function updateAlbum($album)
+    {
+        $album = $this->factory->AlbumPdoModel($album);
+        $album->save();
+
+        # Detach from database
+        return $this->factory->AlbumModel($album);
+    }
+
+    /**
+     * Deletes the album associated with the given Album ID
+     *
+     * @Path /album/:id
+     * @Methods DELETE
+     *
+     * @var int $id
+     *   Album ID
+     */
+    public function deleteAlbum($id)
+    {
+        $album = $this->factory->AlbumPdoModel(array("id" => $id));
+        $album->delete();
+    }
+
+    /**
+     * @var \Cougar\Security\iSecurity Security context
+     */
+    protected $security;
+
+    /**
+     * @var AlbumModelFactory
+     */
+    protected $factory;
+}
+?>

lib/Album.php

@@ -0,0 +1,86 @@
+<?php
+
+namespace ZendTutorialInCougar;
+
+use PDO;
+use Cougar\Security\iSecurity;
+use Cougar\Cache\iCache;
+
+# Initialize the Cougar framework and add the application path
+require_once("cougar.php");
+\Cougar\Autoload\FlexAutoload::addPath(__DIR__, 1);
+
+/**
+ * Stores the dependencies for the AlbumModel classes and returns new instances
+ * when needed.
+ */
+class AlbumModelFactory
+{
+    /**
+     * Stores the references to the security context, cache object and database
+     * connection (PDO).
+     *
+     * @param iSecurity $security
+     *   Security context
+     * @param iCache $cache
+     *   Cache object
+     * @param PDO $pdo
+     *   Database connection
+     */
+    public function __construct(iSecurity $security, iCache $cache, PDO $pdo)
+    {
+        // Store the object references
+        $this->security = $security;
+        $this->cache = $cache;
+        $this->pdo = $pdo;
+    }
+
+    /**
+     * Returns a new instance of the AlbumModel object
+     *
+     * @var mixed $object
+     *   Object or assoc. array to import from
+     * @var string $view
+     *   Set the initial view
+     * @var bool strict
+     *   Whether to perform strict property checks
+     * @return AlbumModel
+     */
+    public function AlbumModel($object = null, $view = null, $strict = true)
+    {
+        return new AlbumModel($object, $view, $strict);
+    }
+
+    /**
+     * Returns a new instance of the AlbumModel object
+     *
+     * @var mixed $object
+     *   Object or assoc. array to import from
+     * @var string $view
+     *   Set the initial view
+     * @var bool strict
+     *   Whether to perform strict property checks
+     * @return AlbumModel
+     */
+    public function AlbumPdoModel($object = null, $view = null, $strict = true)
+    {
+        return new AlbumPdoModel($this->security, $this->cache, $this->pdo,
+            $object, $view, $strict);
+    }
+
+    /**
+     * @var iSecurity Security context
+     */
+    protected $security;
+
+    /**
+     * @var iCache Cache object
+     */
+    protected $cache;
+
+    /**
+     * @var PDO Database connection
+     */
+    protected $pdo;
+}
+?>

lib/AlbumModelFactory.php

@@ -0,0 +1,28 @@
+<?php
+
+namespace ZendTutorialInCougar;
+
+/**
+ * Defines the properties in the Album database table
+ *
+ * @CaseInsensitive
+ */
+abstract class AlbumBaseModel
+{
+    /**
+     * @var int Album ID
+     */
+    public $id;
+
+    /**
+     * @NotNull
+     * @var string Album artist
+     */
+    public $artist;
+
+    /**
+     * @NotNull
+     * @var string Album title
+     */
+    public $title;
+}

lib/Models/AlbumBaseModel.php

@@ -0,0 +1,18 @@
+<?php
+
+namespace ZendTutorialInCougar;
+
+use Cougar\Model\iModel;
+use Cougar\Model\tModel;
+
+# Initialize the Cougar framework and add the application path
+require_once("cougar.php");
+\Cougar\Autoload\FlexAutoload::addPath(__DIR__, 2);
+
+/**
+ * Creates the Album model from the base model
+ */
+class AlbumModel extends AlbumBaseModel implements iModel
+{
+    use tModel;
+}

lib/Models/AlbumModel.php

@@ -0,0 +1,22 @@
+<?php
+
+namespace ZendTutorialInCougar;
+
+use Cougar\Model\iStoredModel;
+use Cougar\Model\tPdoModel;
+
+# Initialize the Cougar framework and add the application path
+require_once("cougar.php");
+\Cougar\Autoload\FlexAutoload::addPath(__DIR__, 2);
+
+/**
+ * Creates the Album PDO model from the base model
+ *
+ * @Table album
+ * @Allow CREATE READ UPDATE DELETE QUERY
+ * @PrimaryKey id
+ */
+class AlbumPdoModel extends AlbumBaseModel implements iStoredModel
+{
+    use tPdoModel;
+}