<?php

declare( ENCODING = 'utf-8' );

/*
 * Copyright (c) 2010 Romain Ruetschi <hide@address.com>
 * 
 * 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.
 */

/**
 * Source file containing class Resource\AbstractResource.
 * 
 * @package    RRoEmbed
 * @license    http://opensource.org/licenses/mit-license.html MIT License
 * @author     Romain Ruetschi <hide@address.com>
 * @version    0.2
 * @see        RRoEmbed\Resource\AbstractResource
 */
 
// Namespace declaration.
namespace RRoEmbed\Resource;

/**
 * Class  RRoEmbed\Resource\AbstractResource.
 * 
 * @todo       Description for class Resource\AbstractResource.
 *
 * @package    RRoEmbed
 * @license    http://opensource.org/licenses/mit-license.html MIT License
 * @author     Romain Ruetschi <hide@address.com>
 * @version    0.2
 */
abstract class AbstractResource
{
    
    /**
     * Type.
     *
     * @var string
     */
    protected $_type            = '';
    
    /**
     * Version.
     *
     * @var string
     */
    protected $_version         = '1.0';
    
    /**
     * Title.
     *
     * @var string
     */
    protected $_title           = '';
    
    /**
     * Author Name.
     *
     * @var string
     */
    protected $_authorName      = '';
    
    /**
     * Author URL.
     *
     * @var string
     */
    protected $_authorUrl       = '';
    
    /**
     * Provider Name.
     *
     * @var string
     */
    protected $_providerName    = '';
    
    /**
     * Provider URL.
     *
     * @var string
     */
    protected $_providerUrl     = '';
    
    /**
     * Cache Age
     *
     * @var integer+
     */
    protected $_cacheAge        = 0;
    
    /**
     * Thumbnail URL
     *
     * @var string
     */
    protected $_thumbnailUrl    = '';
    
    /**
     * Thumbnail Width
     *
     * @var integer
     */
    protected $_thumbnailWidth  = 0;
    
    /**
     * Thumbnail Height
     *
     * @var integer
     */
    protected $_thumbnailHeight = 0;
    
    /**
     * Create a Resource object from the supplied resource.
     *
     * @param stdClass $resource The resource to create an Resource from. 
     * @return RRoEmbed\Resource\AbstractResource
     * @author Romain Ruetschi <hide@address.com>
     */
    public static function factory( $resource )
    {
        $type      = $resource->type;
        $className = 'RRoEmbed\\Resource\\' . ucfirst( strtolower( $type ) );
        
        if( !class_exists( $className ) )
        {
            throw new \RRoEmbed\Exception(
                'Unknown resource type "' . $type .'".',
                \RRoEmbed\Exception::UNKNOWN_RESOURCE_TYPE
            );
        }
        
        $object = new $className();
        
        foreach( $resource as $property => $value )
        {
            $setterMethodName = 'set' . self::_underscoreToUpperCamelCase( $property );
            
            if( !method_exists( $object, $setterMethodName ) )
            {
                continue;
            }
            
            $object->$setterMethodName( $value );
        }
        
        return $object;
    }
    
    /**
     * Get a string reprenstation of the oEmbed resource.
     *
     * @return string
     * 
     * @author Romain Ruetschi <hide@address.com>
     */
    abstract public function getAsString();
    
    /**
     * Get a string reprenstation of the oEmbed resource.
     *
     * @see    getAsString
     * 
     * @return string
     * 
     * @author Romain Ruetschi <hide@address.com>
     */
    public function __toString()
    {
        return $this->getAsString();
    }
    
    public function getType()
    {
        return $this->_type;
    }
    
    public function setType( $type )
    {
        $this->_type = $type;
         
        return $this;
    }
    
    public function getVersion()
    {
        return $this->_version;
    }

    public function setVersion( $version )
    {
        $this->_version = $version;
         
        return $this;
    }
    
    public function getTitle()
    {
        return $this->_title;
    }
    
    public function setTitle( $title )
    {
        $this->_title = $title;
         
        return $this;
    }
    
    public function getAuthorName()
    {
        return $this->_authorName;
    }
    
    public function setAuthorName( $authorName )
    {
        $this->_authorName = $authorName;
         
        return $this;
    }
    
    public function getAuthorUrl()
    {
        return $this->_authorUrl;
    }
    
    public function setAuthorUrl( $authorUrl )
    {
        $this->_authorUrl = $authorUrl;
         
        return $this;
    }
    
    public function getProviderName()
    {
        return $this->_providerName;
    }

    public function setProviderName( $providerName )
    {
        $this->_providerName = $providerName;
         
        return $this;
    }
    
    public function getProviderUrl()
    {
        return $this->_providerUrl;
    }

    public function setProviderUrl( $providerUrl )
    {
        $this->_providerUrl = $providerUrl;
         
        return $this;
    }
    
    public function getThumbnailUrl()
    {
        return $this->_thumbnailUrl;
    }
    
    public function setThumbnailUrl( $thumbnailUrl )
    {
        $this->_thumbnailUrl = $thumbnailUrl;
         
        return $this;
    }
    
    public function getThumbnailWidth()
    {
        return $this->_thumbnailWidth;
    }
    
    public function setThumbnailWidth( $thumbnailWidth )
    {
        $this->_thumbnailWidth = $thumbnailWidth;
         
        return $this;
    }
    
    public function getThumbnailHeight()
    {
        return $this->_thumbnailHeight;
    }
    
    public function setThumbnailHeight( $thumbnailHeight )
    {
        $this->_thumbnailHeight = $thumbnailHeight;
         
        return $this;
    }
    
    protected static function _underscoreToUpperCamelCase( $string )
    {
        return str_replace( ' ', '', ucwords( str_replace( '_', ' ', $string ) ) );
    }
    
}