184 lines
4.0 KiB
PHP
184 lines
4.0 KiB
PHP
|
<?php
|
||
|
/**
|
||
|
* Copyright 2017 Facebook, Inc.
|
||
|
*
|
||
|
* You are hereby granted a non-exclusive, worldwide, royalty-free license to
|
||
|
* use, copy, modify, and distribute this software in source code or binary
|
||
|
* form for use in connection with the web services and APIs provided by
|
||
|
* Facebook.
|
||
|
*
|
||
|
* As with any software that integrates with the Facebook platform, your use
|
||
|
* of this software is subject to the Facebook Developer Principles and
|
||
|
* Policies [http://developers.facebook.com/policy/]. This copyright 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.
|
||
|
*
|
||
|
*/
|
||
|
namespace Facebook\GraphNodes;
|
||
|
|
||
|
/**
|
||
|
* Class GraphAlbum
|
||
|
*
|
||
|
* @package Facebook
|
||
|
*/
|
||
|
|
||
|
class GraphAlbum extends GraphNode
|
||
|
{
|
||
|
/**
|
||
|
* @var array Maps object key names to Graph object types.
|
||
|
*/
|
||
|
protected static $graphObjectMap = [
|
||
|
'from' => '\Facebook\GraphNodes\GraphUser',
|
||
|
'place' => '\Facebook\GraphNodes\GraphPage',
|
||
|
];
|
||
|
|
||
|
/**
|
||
|
* Returns the ID for the album.
|
||
|
*
|
||
|
* @return string|null
|
||
|
*/
|
||
|
public function getId()
|
||
|
{
|
||
|
return $this->getField('id');
|
||
|
}
|
||
|
|
||
|
/**
|
||
|
* Returns whether the viewer can upload photos to this album.
|
||
|
*
|
||
|
* @return boolean|null
|
||
|
*/
|
||
|
public function getCanUpload()
|
||
|
{
|
||
|
return $this->getField('can_upload');
|
||
|
}
|
||
|
|
||
|
/**
|
||
|
* Returns the number of photos in this album.
|
||
|
*
|
||
|
* @return int|null
|
||
|
*/
|
||
|
public function getCount()
|
||
|
{
|
||
|
return $this->getField('count');
|
||
|
}
|
||
|
|
||
|
/**
|
||
|
* Returns the ID of the album's cover photo.
|
||
|
*
|
||
|
* @return string|null
|
||
|
*/
|
||
|
public function getCoverPhoto()
|
||
|
{
|
||
|
return $this->getField('cover_photo');
|
||
|
}
|
||
|
|
||
|
/**
|
||
|
* Returns the time the album was initially created.
|
||
|
*
|
||
|
* @return \DateTime|null
|
||
|
*/
|
||
|
public function getCreatedTime()
|
||
|
{
|
||
|
return $this->getField('created_time');
|
||
|
}
|
||
|
|
||
|
/**
|
||
|
* Returns the time the album was updated.
|
||
|
*
|
||
|
* @return \DateTime|null
|
||
|
*/
|
||
|
public function getUpdatedTime()
|
||
|
{
|
||
|
return $this->getField('updated_time');
|
||
|
}
|
||
|
|
||
|
/**
|
||
|
* Returns the description of the album.
|
||
|
*
|
||
|
* @return string|null
|
||
|
*/
|
||
|
public function getDescription()
|
||
|
{
|
||
|
return $this->getField('description');
|
||
|
}
|
||
|
|
||
|
/**
|
||
|
* Returns profile that created the album.
|
||
|
*
|
||
|
* @return GraphUser|null
|
||
|
*/
|
||
|
public function getFrom()
|
||
|
{
|
||
|
return $this->getField('from');
|
||
|
}
|
||
|
|
||
|
/**
|
||
|
* Returns profile that created the album.
|
||
|
*
|
||
|
* @return GraphPage|null
|
||
|
*/
|
||
|
public function getPlace()
|
||
|
{
|
||
|
return $this->getField('place');
|
||
|
}
|
||
|
|
||
|
/**
|
||
|
* Returns a link to this album on Facebook.
|
||
|
*
|
||
|
* @return string|null
|
||
|
*/
|
||
|
public function getLink()
|
||
|
{
|
||
|
return $this->getField('link');
|
||
|
}
|
||
|
|
||
|
/**
|
||
|
* Returns the textual location of the album.
|
||
|
*
|
||
|
* @return string|null
|
||
|
*/
|
||
|
public function getLocation()
|
||
|
{
|
||
|
return $this->getField('location');
|
||
|
}
|
||
|
|
||
|
/**
|
||
|
* Returns the title of the album.
|
||
|
*
|
||
|
* @return string|null
|
||
|
*/
|
||
|
public function getName()
|
||
|
{
|
||
|
return $this->getField('name');
|
||
|
}
|
||
|
|
||
|
/**
|
||
|
* Returns the privacy settings for the album.
|
||
|
*
|
||
|
* @return string|null
|
||
|
*/
|
||
|
public function getPrivacy()
|
||
|
{
|
||
|
return $this->getField('privacy');
|
||
|
}
|
||
|
|
||
|
/**
|
||
|
* Returns the type of the album.
|
||
|
*
|
||
|
* enum{ profile, mobile, wall, normal, album }
|
||
|
*
|
||
|
* @return string|null
|
||
|
*/
|
||
|
public function getType()
|
||
|
{
|
||
|
return $this->getField('type');
|
||
|
}
|
||
|
}
|