Zend Framework: Zend_Service_Fotolia Component Proposal

Proposed Component Name	Zend_Service_Fotolia
Developer Notes	http://framework.zend.com/wiki/display/ZFDEV/Zend_Service_Fotolia
Proposers	Olivier Sirven
Revision	1.1 - 9 november 2007: First release of the proposal. (wiki revision: 11)

// create the object
$api = new Zend_Service_Fotolia('my api key');

// perform a search request and print results
print_r($api->getSearchResults(array('words' => 'english bulldog',
                                     'language_id' => 2,
                                     'limit' => 10)));

// identify a user
$api->loginUser('login',
                'password'));

// prints user's data
print_r($api->getUserData());

9. Class Skeletons

class Zend_Service_Fotolia_Exception extends Zend_Service_Exception
{
}

class Zend_Service_Fotolia
{
    /**
     * Fotolia xml-rpc uri
     */
    const FOTOLIA_URI = 'http://www.fotolia.com/Xmlrpc/rpc';

    /**
     * API key
     *
     * @var $_key string
     */
    private $_key;

    /**
     * XML-RPC client
     *
     * @var $_client Zend_XmlRpc_Client
     */
    private $_client;

    /**
     * Proxy instances array
     *
     * @var $_proxies array
     */
    private $_proxies;

    /**
     * Current session id
     *
     * @var $_session_id string
     */
    private $_session_id;

    /**
     * Constructor
     *
     * @param  string $apiKey
     */
    public function __construct($apiKey)
    {
    }

    /**
     * Returns current api key
     *
     * return string
     */
    public function getApiKey()
    {
    }

    /**
     * This method makes possible to search media in fotolia image bank.
     * Full search capabilities are available through the API
     *
     * @param  array  $searchParams
     * @return array
     */
    public function getSearchResults($searchParams)
    {
    }

    /**
     * This method returns childs of a parent category in fotolia representative category system.
     * This method could be used to display a part of the category system or the all tree.
     * Fotolia categories system counts three levels.
     *
     * @param  int    $language_id
     * @param  int    $id
     * @param  int    $category_type_id
     * @return array
     */
    public function getCategories1($language_id = 2, $id = 0, $category_type_id = 1)
    {
    }

    /**
     * This method returns childs of a parent category in fotolia conceptual category system.
     * This method could be used to display a part of the category system or the all tree.
     * Fotolia categories system counts three levels.
     *
     * @param  int    $language_id
     * @param  int    $id
     * @return array
     */
    public function getCategories2($language_id = 2, $id = 0)
    {
    }

    /**
     * This method returns most searched tag and most used tag on fotolia website.
     * This method may help you to create a tags cloud.
     *
     * @param  int    $language_id
     * @param  string $type
     * @return array
     */
    public function getTags($language_id = 2, $type = 'Used')
    {
    }

    /**
     * This method returns public galleries for a defined language
     *
     * @param  int    $language_id
     * @return array
     */
    public function getGalleries($language_id = 2)
    {
    }

    /**
     * This method returns childs of a parent colors in the Fotolia color scheme.
     * If no parent is provided first level colors are returned.
     * This method can be used to display color and subcolors for color search queries.
     *
     * @param  int    $id
     * @return array
     */
    public function getColors($id = 0)
    {
    }

    /**
     * This method returns Fotolia list of countries.
     *
     * @param  int    $language_id
     * @return array
     */
    public function getCountries($language_id = 2)
    {
    }

    /**
     * This method returns fotolia data
     *
     * @return array
     */
    public function getData()
    {
    }

    /**
     * This method is a test method which returns success if connexion is valid
     *
     * @return array
     */
    public function test()
    {
    }

    /**
     * This method return all information about a media
     *
     * @param  int    $id
     * @param  int    $thumbnail_size
     * @param  int    $language_id
     * @return array
     */
    public function getMediaData($id, $thumbnail_size = 110, $language_id = 2)
    {
    }

    /**
     * This method return private galleries for logged user
     *
     * @param  int    $id
     * @param  int    $language_id
     * @param  int    $thumbnail_size
     * @return array
     */
    public function getMediaGalleries($id, $language_id = 2, $thumbnail_size = 110)
    {
    }

    /**
     * This method allows to purchase a media and returns url to the purchased file
     *
     * @param  int    $id
     * @param  string $license_name
     * @return array
     */
    public function getMedia($id, $license_name)
    {
    }

    /**
     * This method returns comp images. Comp images can ONLY be used to evaluate the image
     * as to suitability for a project, obtain client or internal company approvals,
     * or experiment with layout alternatives.
     *
     * @param  int    $id
     * @return array
     */
    public function getMediaComp($id)
    {
    }

    /**
     * Authenticate an user
     *
     * @param  string $login User login
     * @param  string $pass User password
     */
    public function loginUser($login, $pass)
    {
    }

    /**
     * Log out an user
     */
    public function logoutUser()
    {
    }

    /**
     * This method returns data for logged user.
     *
     * @return array
     */
    public function getUserData()
    {
    }

    /**
     * This method allows you to get sales/views/income statistics from your account.
     *
     * @param  string $type
     * @param  string $time_range
     * @param  string $easy_date_period
     * @param  string $start_date
     * @param  string $end_date
     * @return array
     */
    public function getUserAdvancedStats($type,
                                         $time_range,
                                         $easy_date_period=NULL,
                                         $start_date=NULL,
                                         $end_date=NULL)
    {
    }

    /**
     * This methods returns statistics for logged user
     *
     * @return array
     */
    public function getUserStats()
    {
    }

    /**
     * Delete a user's gallery
     *
     * @param  string $id
     */
    public function deleteUserGallery($id)
    {
    }

    /**
     * This method allows you to create a new gallery in your account.
     *
     * @param  string $name
     * @return array
     */
    public function createUserGallery($name)
    {
    }

    /**
     * This method allows you to add a content to your default lightbox or any of your existing galleries
     *
     * @param  int    $content_id
     * @param  string $id
     * @return array
     */
    public function addToUserGallery($content_id, $id = '')
    {
    }

    /**
     * This method allows you to remove a content from your default lightbox or any of your existing galleries
     *
     * @param  int    $content_id
     * @param  string $id
     * @return array
     */
    public function removeFromUserGallery($content_id, $id = '')
    {
    }

    /**
     * This method allows to search media in logged user galleries or lightbox.
     *
     * @param  int    $page
     * @param  int    $per_page
     * @param  int    $thumbnail_size
     * @param  string $id
     * @return array
     */
    public function getUserGalleryMedias($page = 0,
                                         $per_page = 32,
                                         $thumbnail_size = 110,
                                         $id = '')
    {
    }

    /**
     * This method returns private galleries for logged user.
     *
     * @return array
     */
    public function getUserGalleries()
    {
    }

    /**
     * Magic method used to call fotolia xml-rpc functions
     *
     * @param  string $method
     * @param  array  $args
     * @return array
     * @throws Zend_Service_Fotolia_Exception
     */
    public function __call($method, $args)
    {
    }

    /**
     * Returns xml-rpc client
     *
     * @return Zend_XmlRpc_Client
     */
    public function getClient()
    {
    }

    /**
     * Returns namespace associated to given method name
     *
     * @param  string $method
     * @return string
     */
    protected function _getNamespace($method)
    {
    }

    /**
     * Returns a xml-rpc proxy instance from a namespace
     *
     * @param  string $namespace
     * @return Zend_xmlRpc_Client_ServerProxy
     * @throws Zend_Service_Fotolia_Exception
     */
    protected function _getProxy($namespace)
    {
    }

    /**
     * Returns current session id
     *
     * @return string
     * @throws Zend_Service_Fotolia_Exception
     */
    protected function _getSessionId()
    {
    }
}

Page Operations

Browse Space

Zend_Service_Fotolia

Labels

Zend Framework: Zend_Service_Fotolia Component Proposal

Table of Contents

1. Overview

2. References

3. Component Requirements, Constraints, and Acceptance Criteria

4. Dependencies on Other Framework Components

5. Theory of Operation

6. Milestones / Tasks

7. Class Index

8. Use Cases

9. Class Skeletons