objects.php

<?php
/**
 * Open Graph protocol global types
 *
 * @link http://ogp.me/#types Open Graph protocol global types
 * @package open-graph-protocol-tools
 * @author Niall Kennedy <niall@niallkennedy.com>
 * @version 1.3
 * @copyright Public Domain
 */
if ( !class_exists('OpenGraphProtocol') )
	require_once dirname(__FILE__) . '/open-graph-protocol.php';

abstract class OpenGraphProtocolObject {
	const PREFIX ='';
	const NS='';

	/**
	 * Output the object as HTML <meta> elements
	 * @return string HTML meta element string
	 */
	public function toHTML() {
		return rtrim( OpenGraphProtocol::buildHTML( get_object_vars($this), static::PREFIX ), PHP_EOL );
	}

	/**
	 * Convert a DateTime object to GMT and format as an ISO 8601 string.
	 * @param DateTime $date date to convert
	 * @return string ISO 8601 formatted datetime string
	 */
	public static function datetime_to_iso_8601( DateTime $date ) {
		$date->setTimezone(new DateTimeZone('GMT'));
		return $date->format('c');
	}

	/**
	 * Test a URL for validity.
	 *
	 * @uses OpenGraphProtocol::is_valid_url if OpenGraphProtocol::VERIFY_URLS is true
	 * @param string $url absolute URL addressable from the public web
	 * @return bool true if URL is non-empty string. if VERIFY_URLS set then URL must also properly respond to a HTTP request.
	 */
	public static function is_valid_url( $url ) {
		if ( is_string($url) && !empty($url) ) {
			if (OpenGraphProtocol::VERIFY_URLS) {
				$url = OpenGraphProtocol::is_valid_url( $url, array( 'text/html', 'application/xhtml+xml' ) );
				if (!empty($url))
					return true;
			} else {
				return true;
			}
		}
		return false;
	}
}

class OpenGraphProtocolArticle extends OpenGraphProtocolObject {
	/**
	 * Property prefix
	 * @var string
	 */
	const PREFIX = 'article';

	/**
	 * prefix namespace
	 * @var string
	 */
	const NS = 'http://ogp.me/ns/article#';

	/**
	 * When the article was first published.
	 * ISO 8601 formatted string.
	 * @var string
	 */
	protected $published_time;

	/**
	 * When the article was last changed
	 * ISO 8601 formatted string.
	 * @var string
	 */
	protected $modified_time;

	/**
	 * When the article is considered out-of-date
	 * ISO 8601 formatted string.
	 * @var string
	 */
	protected $expiration_time;

	/**
	 * Writers of the article.
	 * Array of author URIs
	 * @var array
	 */
	protected $author;

	/**
	 * High-level section or category
	 * @var string
	 */
	protected $section;

	/**
	 * Content tag
	 * Array of tag strings
	 * @var array
	 */
	protected $tag;

	/**
	 * Initialize arrays
	 */
	public function __construct() {
		$this->author = array();
		$this->tag = array();
	}

	/**
	 * When the article was first published
	 * @return string ISO 8601 formatted publication date and optional time
	 */
	public function getPublishedTime() {
		return $this->published_time;
	}

	/**
	 * Set when the article was first published
	 * @param DateTime|string $pubdate ISO 8601 formatted datetime string or DateTime object for conversion
	 */
	public function setPublishedTime( $pubdate ) {
		if ( $pubdate instanceof DateTime )
			$this->published_time = static::datetime_to_iso_8601($pubdate);
		else if ( is_string($pubdate) && strlen($pubdate) >= 10 ) // at least YYYY-MM-DD
			$this->published_time = $pubdate;
		return $this;
	}

	/**
	 * When article was last changed
	 * @return string ISO 8601 formatted modified date and optional time
	 */
	public function getModifiedTime() {
		return $this->modified_time;
	}

	/**
	 * Set when the article was last changed
	 * @param DateTime|string $updated ISO 8601 formatted datetime string or DateTime object for conversion
	 */
	public function setModifiedTime( $updated ) {
		if ( $updated instanceof DateTime )
			$this->modified_time = static::datetime_to_iso_8601($updated);
		else if ( is_string($updated) && strlen($updated) >= 10 ) // at least YYYY-MM-DD
			$this->modified_time = $updated;
		return $this;
	}

	/**
	 * Time the article content expires
	 * @return string ISO 8601 formatted expiration date and optional time
	 */
	public function getExpirationTime() {
		return $this->expiration_time;
	}

	/**
	 * Set when the article content expires
	 * @param DateTime|string $expires ISO formatted datetime string or DateTime object for conversion
	 */
	public function setExpirationTime( $expires ) {
		if ( $expires instanceof DateTime )
			$this->expiration_time = static::datetime_to_iso_8601($expires);
		else if ( is_string($expires) && strlen($expires) >= 10 )
			$this->expiration_time = $expires;
		return $this;
	}

	/**
	 * Article author URIs
	 * @return array Article author URIs
	 */
	public function getAuthors() {
		return $this->author;
	}

	/**
	 * Add an author URI
	 * @param string $author_uri Author URI
	 */
	public function addAuthor( $author_uri ) {
		if ( static::is_valid_url($author_uri) && !in_array($author_uri, $this->author))
			$this->author[] = $author_uri;
		return $this;
	}

	/**
	 * High-level section name
	 */
	public function getSection() {
		return $this->section;
	}

	/**
	 * Set the top-level content section
	 * @param string $section
	 */
	public function setSection( $section ) {
		if ( is_string($section) && !empty($section) )
			$this->section = $section;
		return $this;
	}

	/**
	 * Content tags
	 * @return array content tags
	 */
	public function getTags() {
		return $this->tag;
	}

	/**
	 * Add a content tag
	 * @param string $tag content tag
	 */
	public function addTag( $tag ) {
		if ( is_string($tag) && !empty($tag) )
			$this->tag[] = $tag;
		return $this;
	}
}

class OpenGraphProtocolProfile extends OpenGraphProtocolObject {
	/**
	 * Property prefix
	 * @var string
	 */
	const PREFIX = 'profile';

	/**
	 * prefix namespace
	 * @var string
	 */
	const NS = 'http://ogp.me/ns/profile#';

	/**
	 * A person's given name
	 * @var string
	 */
	protected $first_name;

	/**
	 * A person's last name
	 * @var string
	 */
	protected $last_name;

	/**
	 * The profile's unique username
	 * @var string
	 */
	protected $username;

	/**
	 * Gender: male or female
	 */
	protected $gender;

	/**
	 * Get the person's given name
	 * @return string given name
	 */
	public function getFirstName() {
		return $this->first_name;
	}

	/**
	 * Set the person's given name
	 * @param string $first_name given name
	 */
	public function setFirstName( $first_name ) {
		if ( is_string($first_name) && !empty($first_name) )
			$this->first_name = $first_name;
		return $this;
	}

	/**
	 * The person's family name
	 * @return string famil name
	 */
	public function getLastName() {
		return $this->last_name;
	}

	/**
	 * Set the person's family name
	 * @param string $last_name family name
	 */
	public function setLastName( $last_name ) {
		if ( is_string($last_name) && !empty($last_name) )
			$this->last_name = $last_name;
		return $this;
	}

	/**
	 * Person's username on your site
	 * @return string account username
	 */
	public function getUsername() {
		return $this->username;
	}

	/**
	 * Set the account username
	 * @param string $username username
	 */
	public function setUsername( $username ) {
		if ( is_string($username) && !empty($username) )
			$this->username = $username;
		return $this;
	}

	/**
	 * The person's gender. male|female
	 * @return string male|female
	 */
	public function getGender() {
		return $this->gender;
	}

	/**
	 * Set the person's gender
	 * @param string $gender male|female
	 */
	public function setGender( $gender ) {
		if ( is_string($gender) && ( $gender === 'male' || $gender === 'female' ) )
			$this->gender = $gender;
		return $this;
	}
}

class OpenGraphProtocolBook extends OpenGraphProtocolObject {
	/**
	 * Property prefix
	 * @var string
	 */
	const PREFIX = 'book';

	/**
	 * prefix namespace
	 * @var string
	 */
	const NS = 'http://ogp.me/ns/book#';

	/**
	 * Book authors as an array of URIs.
	 * The target URI is expected to have an Open Graph protocol type of 'profile'
	 * @var array
	 */
	protected $author;

	/**
	 * International Standard Book Number. ISBN-10 and ISBN-13 accepted
	 * @link http://en.wikipedia.org/wiki/International_Standard_Book_Number ISBN
	 * @var string
	 */
	protected $isbn;

	/**
	 * The date the book was released, or planned release if in future.
	 * Stored as an ISO 8601 date string normalized to UTC for consistency
	 * @var string
	 */
	protected $release_date;

	/**
	 * Tag words describing book content and subjects
	 * @var array
	 */
	protected $tag;

	public function __construct() {
		$this->author = array();
		$this->tag = array();
	}

	/**
	 * Book author URIs
	 * @return array author URIs
	 */
	public function getAuthors() {
		return $this->author;
	}

	/**
	 * Add an author URI.
	 *
	 * @param string $author_uri
	 */
	public function addAuthor( $author_uri ) {
		if ( static::is_valid_url($author_uri) && !in_array($author_uri, $this->author))
			$this->author[] = $author_uri;
		return $this;
	}

	/**
	 * International Standard Book Number
	 *
	 * @return string
	 */
	public function getISBN() {
		return $this->isbn;
	}

	/**
	 * Set an International Standard Book Number
	 *
	 * @param string $isbn
	 */
	public function setISBN( $isbn ) {
		if ( is_string( $isbn ) ) {
			$isbn = trim( str_replace('-', '', $isbn) );
			if ( strlen($isbn) === 10 && is_numeric( substr($isbn, 0 , 9) ) ) { // published before 2007
				$verifysum = 0;
				$chars = str_split( $isbn );
				for( $i=0; $i<9; $i++ ) {
					$verifysum += ( (int) $chars[$i] ) * (10 - $i);
				}
				$check_digit = 11 - ($verifysum % 11);
				if ( $check_digit == $chars[9] || ($chars[9] == 'X' && $check_digit == 10) )
					$this->isbn = $isbn;
			} elseif ( strlen($isbn) === 13 && is_numeric( substr($isbn, 0, 12 ) ) ) {
				$verifysum = 0;
				$chars = str_split( $isbn );
				for( $i=0; $i<12; $i++ ) {
					$verifysum += ( (int) $chars[$i] ) * ( ( ($i%2) ===0 ) ? 1:3 );
				}
				$check_digit = 10 - ( $verifysum%10 );
				if ( $check_digit == $chars[12] )
					$this->isbn = $isbn;
			}
		}
		return $this;
	}

	/**
	 * Book release date
	 *
	 * @return string release date in ISO 8601 format
	 */
	public function getReleaseDate() {
		return $this->release_date;
	}

	/**
	 * Set the book release date
	 *
	 * @param DateTime|string $release_date release date as DateTime or as an ISO 8601 formatted string
	 */
	public function setReleaseDate( $release_date ) {
		if ( $release_date instanceof DateTime )
			$this->release_date = static::datetime_to_iso_8601($release_date);
		else if ( is_string($release_date) && strlen($release_date) >= 10 ) // at least YYYY-MM-DD
			$this->release_date = $release_date;
		return $this;
	}

	/**
	 * Book subject tags
	 *
	 * @return array Topic tags
	 */
	public function getTags() {
		return $this->tag;
	}

	/**
	 * Add a book topic tag
	 *
	 * @param string $tag topic tag
	 */
	public function addTag( $tag ) {
		if ( is_string($tag) && !empty($tag) && !in_array($tag, $this->tag) )
			$this->tag[] = $tag;
		return $this;
	}
}

/**
 * Video movie, TV show, and other all share the same properies.
 * Video episode extends this class to associate with a TV show 
 * 
 * @link http://ogp.me/#type_video Open Graph protocol video object
 */
class OpenGraphProtocolVideoObject extends OpenGraphProtocolObject {
	/**
	 * Property prefix
	 * @var string
	 */
	const PREFIX = 'video';

	/**
	 * prefix namespace
	 * @var string
	 */
	const NS = 'http://ogp.me/ns/video#';

	/**
	 * Array of actor URLs
	 * @var array
	 */
	protected $actor;

	/**
	 * Array of director URLs
	 * @var array
	 */
	protected $director;

	/**
	 * Array of writer URIs
	 * @var array
	 */
	protected $writer;

	/**
	 * Video duration in whole seconds
	 * @var int
	 */
	protected $duration;

	/**
	 * The date the movie was first released. ISO 8601 formatted string
	 * @var string
	 */
	protected $release_date;

	/**
	 * Tag words associated with the movie
	 * @var array
	 */
	protected $tag;

	public function __construct() {
		$this->actor = array();
		$this->director = array();
		$this->writer = array();
		$this->tag = array();
	}

	/**
	 * Get an array of actor URLs
	 *
	 * @return array actor URLs
	 */
	public function getActors() {
		return $this->actor;
	}

	/**
	 * Add an actor URL with an optional role association
	 *
	 * @param string $url Author URL of og:type profile
	 * @param string $role The role the given actor played in this video work.
	 */
	public function addActor( $url, $role='' ) {
		if ( static::is_valid_url($url) && !in_array($url, $this->actor) ) {
			if ( !empty($role) && is_string($role) )
				$this->actor[] = array( $url, 'role' => $role );
			else
				$this->actor[] = $url;
		}
		return $this;
	}

	/**
	 * An array of director URLs
	 *
	 * @return array director URLs
	 */
	public function getDirectors() {
		return $this->director;
	}

	/**
	 * Add a director profile URL
	 *
	 * @param string $url director profile URL
	 */
	public function addDirector( $url ) {
		if ( static::is_valid_url($url) && !in_array($url, $this->director) )
			$this->director[] = $url;
		return $this;
	}

	/**
	 * An array of writer URLs
	 *
	 * @return array writer URLs
	 */
	public function getWriters() {
		return $this->writer;
	}

	/**
	 * Add a writer profile URL
	 *
	 * @param string $url writer profile URL
	 *
	 * @return OpenGraphProtocolVideoObject
	 */
	public function addWriter( $url ) {
		if ( static::is_valid_url($url) && !in_array($url, $this->writer) )
			$this->writer[] = $url;
			
		return $this;
	}

	/**
	 * Duration of the video in whole seconds
	 *
	 * @return int duration in whole seconds
	 */
	public function getDuration() {
		return $this->duration;
	}

	/**
	 * Set the video duration in whole seconds
	 *
	 * @param int $duration video duration in whole seconds 
	 */
	public function setDuration( $duration ) {
		if ( is_int($duration) && $duration > 0 )
			$this->duration = $duration;
		return $this;
	}

	/**
	 * The release date as an ISO 8601 formatted string
	 *
	 * @return string release date as an ISO 8601 formatted string
	 */
	public function getReleaseDate() {
		return $this->release_date;
	}

	/**
	 * Set the date this video was first released
	 *
	 * @param DateTime|string $release_date date video was first released
	 */
	public function setReleaseDate( $release_date ) {
		if ( $release_date instanceof DateTime )
			$this->release_date = static::datetime_to_iso_8601($release_date);
		else if ( is_string($release_date) && strlen($release_date) >= 10 ) // at least YYYY-MM-DD
			$this->release_date = $release_date;
		return $this;
	}

	/**
	 * An array of tag words associated with this video
	 *
	 * @return array tags
	 */
	public function getTags() {
		return $this->tag;
	}

	/**
	 * Add a tag word or topic related to this video
	 *
	 * @param string $tag tag word or topic 
	 */
	public function addTag( $tag ) {
		if ( is_string($tag) && !in_array($tag, $this->tag) )
			$this->tag[] = $tag;
		return $this;
	}
}

/**
 * @link http://ogp.me/#type_video.episode Video episode
 */
class OpenGraphProtocolVideoEpisode extends OpenGraphProtocolVideoObject {
	/**
	 * URL of a video.tv_show which this episode belongs to
	 * @var string
	 */
	protected $series;

	/**
	 * URL of a video.tv_show which this episode belongs to
	 */
	public function getSeries() {
		return $this->series;
	}

	/**
	 * Set the URL of a video.tv_show which this episode belongs to
	 *
	 * @param string $url URL of a video.tv_show
	 */
	public function setSeries( $url ) {
		if ( static::is_valid_url($url) )
			$this->series = $url;
		return $this;
	}
}
?>