Gdata/YouTube/UserProfileEntry.php

Show: PublicProtectedPrivateinherited
Table of Contents
Zend Framework
LICENSE This source file is subject to the new BSD license that is bundled with this package in the file LICENSE.txt. It is also available through the world-wide-web at this URL: http://framework.zend.com/license/new-bsd If you did not receive a copy of the license and are unable to obtain it through the world-wide-web, please send an email to license@zend.com so we can send you a copy immediately.
Category
Zend  
Copyright
Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  
Package
Zend_Gdata  
Subpackage
YouTube  
Version
$Id$  

\Zend_Gdata_YouTube_UserProfileEntry
jump to top

Package: Zend_Gdata\YouTube
Represents the YouTube video playlist flavor of an Atom entry
Parent(s)
\Zend_Gdata_Entry < \Zend_Gdata_App_MediaEntry < \Zend_Gdata_App_Entry < \Zend_Gdata_App_FeedEntryParent < \Zend_Gdata_App_Base
Children
\Zend_Gdata_YouTube_ContactEntry
Category
Zend  
Copyright
Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  

Properties

>VPropertyprotectedstring $_aboutMe = null
The contents of the 'About Me' field.
Default valuenullDetails
Type
string
>VPropertyprotectedint $_age = null
The age of the user
Default valuenullDetails
Type
int
>VPropertyprotectedstring $_books = null
Books of interest to the user
Default valuenullDetails
Type
string
>VPropertyprotectedstring $_company = null
Company
Default valuenullDetails
Type
string
>VPropertyprotectedstring $_description = null
The description of the user
Default valuenullDetails
Type
string
>VPropertyprotected$_entryClassName = 'Zend_Gdata_YouTube_UserProfileEntry'
Default value'Zend_Gdata_YouTube_UserProfileEntry'Details
Type
n/a
>VPropertyprotectedarray $_feedLink = array()
Nested feed links
Default valuearray()Details
Type
array
>VPropertyprotectedstring $_firstName = null
First name
Default valuenullDetails
Type
string
>VPropertyprotectedstring $_gender = null
Gender
Default valuenullDetails
Type
string
>VPropertyprotectedstring $_hobbies = null
Hobbies
Default valuenullDetails
Type
string
>VPropertyprotectedstring $_hometown = null
Hometown
Default valuenullDetails
Type
string
>VPropertyprotectedstring $_lastName = null
Last name
Default valuenullDetails
Type
string
>VPropertyprotectedstring $_location = null
Location
Default valuenullDetails
Type
string
>VPropertyprotectedstring $_movies = null
Movies
Default valuenullDetails
Type
string
>VPropertyprotectedstring $_music = null
Music
Default valuenullDetails
Type
string
>VPropertyprotectedstring $_occupation = null
Occupation
Default valuenullDetails
Type
string
>VPropertyprotectedstring $_relationship = null
Relationship
Default valuenullDetails
Type
string
>VPropertyprotectedstring $_school = null
School
Default valuenullDetails
Type
string
>VPropertyprotected\Zend_Gdata_YouTube_Extension_Statistics $_statistics = null
Statistics
Default valuenullDetails
Type
\Zend_Gdata_YouTube_Extension_Statistics
>VPropertyprotected\Zend_Gdata_Media_Extension_MediaThumbnail $_thumbnail = null
Thumbnail
Default valuenullDetails
Type
\Zend_Gdata_Media_Extension_MediaThumbnail
>VPropertyprotectedstring $_username = null
The username for this profile entry
Default valuenullDetails
Type
string

Methods

methodpublic__construct(\DOMElement $element = null) : void

Creates a User Profile entry, representing an individual user and their attributes.

Parameters
NameTypeDescription
$element\DOMElement

(optional) DOMElement from which this

     object should be constructed.
methodpublicgetAboutMe() : \Zend_Gdata_YouTube_Extension_AboutMe

Returns the contents of the 'about me' field.

Returns
TypeDescription
\Zend_Gdata_YouTube_Extension_AboutMeThe 'about me' information
Throws
ExceptionDescription
\Zend_Gdata_App_VersionException
methodpublicgetAge() : \Zend_Gdata_YouTube_Extension_Age

Returns the age

Returns
TypeDescription
\Zend_Gdata_YouTube_Extension_AgeThe age
methodpublicgetBooks() : \Zend_Gdata_YouTube_Extension_Books

Returns the books

Returns
TypeDescription
\Zend_Gdata_YouTube_Extension_BooksThe books
methodpublicgetCompany() : \Zend_Gdata_YouTube_Extension_Company

Returns the company

Returns
TypeDescription
\Zend_Gdata_YouTube_Extension_CompanyThe company
methodpublicgetContactsFeedUrl() : string

Returns the URL of the contacts feed

Returns
TypeDescription
stringThe URL of the contacts feed
methodpublicgetDOM(\DOMDocument $doc = null,  $majorVersion = 1,  $minorVersion = null) : \DOMElement

Retrieves a DOMElement which corresponds to this element and all child properties. This is used to build an entry back into a DOM and eventually XML text for sending to the server upon updates, or for application storage/persistence.

Parameters
NameTypeDescription
$doc\DOMDocument

The DOMDocument used to construct DOMElements

$majorVersion
$minorVersion
Returns
TypeDescription
\DOMElementThe DOMElement representing this element and all child properties.
methodpublicgetFavoritesFeedUrl() : string

Returns the URL of the favorites feed

Returns
TypeDescription
stringThe URL of the favorites feed
methodpublicgetFeedLink(string $rel = null) : mixed

Get the feed link property for this entry.

Parameters
NameTypeDescription
$relstring

(optional) The rel value of the link to be found.

     If null, the array of links is returned.
Returns
TypeDescription
mixedIf $rel is specified, a Zend_Gdata_Extension_FeedLink object corresponding to the requested rel value is returned if found, or null if the requested value is not found. If $rel is null or not specified, an array of all available feed links for this entry is returned, or null if no feed links are set.
Details
See
 
methodpublicgetFeedLinkHref(string $rel) : mixed

Returns the URL in the gd:feedLink with the provided rel value

Parameters
NameTypeDescription
$relstring

The rel value to find

Returns
TypeDescription
mixedEither the URL as a string or null if a feedLink wasn't found with the provided rel value
methodpublicgetFirstName() : \Zend_Gdata_YouTube_Extension_FirstName

Returns the first name

Returns
TypeDescription
\Zend_Gdata_YouTube_Extension_FirstNameThe first name
Throws
ExceptionDescription
\Zend_Gdata_App_VersionException
methodpublicgetGender() : \Zend_Gdata_YouTube_Extension_Gender

Returns the gender

Returns
TypeDescription
\Zend_Gdata_YouTube_Extension_GenderThe gender
methodpublicgetHobbies() : \Zend_Gdata_YouTube_Extension_Hobbies

Returns the hobbies

Returns
TypeDescription
\Zend_Gdata_YouTube_Extension_HobbiesThe hobbies
methodpublicgetHometown() : \Zend_Gdata_YouTube_Extension_Hometown

Returns the hometown

Returns
TypeDescription
\Zend_Gdata_YouTube_Extension_HometownThe hometown
methodpublicgetLastName() : \Zend_Gdata_YouTube_Extension_LastName

Returns the last name

Returns
TypeDescription
\Zend_Gdata_YouTube_Extension_LastNameThe last name
Throws
ExceptionDescription
\Zend_Gdata_App_VersionException
methodpublicgetLocation() : \Zend_Gdata_YouTube_Extension_Location

Returns the location

Returns
TypeDescription
\Zend_Gdata_YouTube_Extension_LocationThe location
methodpublicgetMovies() : \Zend_Gdata_YouTube_Extension_Movies

Returns the movies

Returns
TypeDescription
\Zend_Gdata_YouTube_Extension_MoviesThe movies
methodpublicgetMusic() : \Zend_Gdata_YouTube_Extension_Music

Returns the music

Returns
TypeDescription
\Zend_Gdata_YouTube_Extension_MusicThe music
methodpublicgetOccupation() : \Zend_Gdata_YouTube_Extension_Occupation

Returns the occupation

Returns
TypeDescription
\Zend_Gdata_YouTube_Extension_OccupationThe occupation
methodpublicgetPlaylistListFeedUrl() : string

Returns the URL of the playlist list feed

Returns
TypeDescription
stringThe URL of the playlist video feed
methodpublicgetRelationship() : \Zend_Gdata_YouTube_Extension_Relationship

Returns the relationship

Returns
TypeDescription
\Zend_Gdata_YouTube_Extension_RelationshipThe relationship
methodpublicgetSchool() : \Zend_Gdata_YouTube_Extension_School

Returns the school

Returns
TypeDescription
\Zend_Gdata_YouTube_Extension_SchoolThe school
methodpublicgetStatistics() : \Zend_Gdata_YouTube_Extension_Statistics

Returns the statistics

Returns
TypeDescription
\Zend_Gdata_YouTube_Extension_StatisticsThe profile statistics
Throws
ExceptionDescription
\Zend_Gdata_App_VersionException
methodpublicgetSubscriptionsFeedUrl() : string

Returns the URL of the subscriptions feed

Returns
TypeDescription
stringThe URL of the subscriptions feed
methodpublicgetThumbnail() : \Zend_Gdata_Media_Extension_MediaThumbnail

Returns the thumbnail

Returns
TypeDescription
\Zend_Gdata_Media_Extension_MediaThumbnailThe profile thumbnail
Throws
ExceptionDescription
\Zend_Gdata_App_VersionException
methodpublicgetUploadsFeedUrl() : string

Returns the URL of the uploads feed

Returns
TypeDescription
stringThe URL of the uploads video feed
methodpublicgetUsername() : \Zend_Gdata_YouTube_Extension_Username

Returns the username

Returns
TypeDescription
\Zend_Gdata_YouTube_Extension_UsernameThe username
methodpublicsetAboutMe(\Zend_Gdata_YouTube_Extension_AboutMe $aboutMe = null) : \Zend_Gdata_YouTube_UserProfileEntry

Sets the content of the 'about me' field.

Parameters
NameTypeDescription
$aboutMe\Zend_Gdata_YouTube_Extension_AboutMe

The 'about me'

   information.
Returns
TypeDescription
\Zend_Gdata_YouTube_UserProfileEntryProvides a fluent interface
Throws
ExceptionDescription
\Zend_Gdata_App_VersionException
methodpublicsetAge(\Zend_Gdata_YouTube_Extension_Age $age = null) : \Zend_Gdata_YouTube_UserProfileEntry

Sets the age

Parameters
NameTypeDescription
$age\Zend_Gdata_YouTube_Extension_Age

The age

Returns
TypeDescription
\Zend_Gdata_YouTube_UserProfileEntryProvides a fluent interface
methodpublicsetBooks(\Zend_Gdata_YouTube_Extension_Books $books = null) : \Zend_Gdata_YouTube_UserProfileEntry

Sets the books

Parameters
NameTypeDescription
$books\Zend_Gdata_YouTube_Extension_Books

The books

Returns
TypeDescription
\Zend_Gdata_YouTube_UserProfileEntryProvides a fluent interface
methodpublicsetCompany(\Zend_Gdata_YouTube_Extension_Company $company = null) : \Zend_Gdata_YouTube_UserProfileEntry

Sets the company

Parameters
NameTypeDescription
$company\Zend_Gdata_YouTube_Extension_Company

The company

Returns
TypeDescription
\Zend_Gdata_YouTube_UserProfileEntryProvides a fluent interface
methodpublicsetFeedLink(array $feedLink = null) : \Zend_Gdata_YouTube_UserProfileEntry

Sets the array of embedded feeds related to the video

Parameters
NameTypeDescription
$feedLinkarray

The array of embedded feeds relating to the video

Returns
TypeDescription
\Zend_Gdata_YouTube_UserProfileEntryProvides a fluent interface
methodpublicsetFirstName(\Zend_Gdata_YouTube_Extension_FirstName $firstName = null) : \Zend_Gdata_YouTube_UserProfileEntry

Sets the content of the 'first name' field.

Parameters
NameTypeDescription
$firstName\Zend_Gdata_YouTube_Extension_FirstName

The first name

Returns
TypeDescription
\Zend_Gdata_YouTube_UserProfileEntryProvides a fluent interface
Throws
ExceptionDescription
\Zend_Gdata_App_VersionException
methodpublicsetGender(\Zend_Gdata_YouTube_Extension_Gender $gender = null) : \Zend_Gdata_YouTube_UserProfileEntry

Sets the gender

Parameters
NameTypeDescription
$gender\Zend_Gdata_YouTube_Extension_Gender

The gender

Returns
TypeDescription
\Zend_Gdata_YouTube_UserProfileEntryProvides a fluent interface
methodpublicsetHobbies(\Zend_Gdata_YouTube_Extension_Hobbies $hobbies = null) : \Zend_Gdata_YouTube_UserProfileEntry

Sets the hobbies

Parameters
NameTypeDescription
$hobbies\Zend_Gdata_YouTube_Extension_Hobbies

The hobbies

Returns
TypeDescription
\Zend_Gdata_YouTube_UserProfileEntryProvides a fluent interface
methodpublicsetHometown(\Zend_Gdata_YouTube_Extension_Hometown $hometown = null) : \Zend_Gdata_YouTube_UserProfileEntry

Sets the hometown

Parameters
NameTypeDescription
$hometown\Zend_Gdata_YouTube_Extension_Hometown

The hometown

Returns
TypeDescription
\Zend_Gdata_YouTube_UserProfileEntryProvides a fluent interface
methodpublicsetLastName(\Zend_Gdata_YouTube_Extension_LastName $lastName = null) : \Zend_Gdata_YouTube_UserProfileEntry

Sets the content of the 'last name' field.

Parameters
NameTypeDescription
$lastName\Zend_Gdata_YouTube_Extension_LastName

The last name

Returns
TypeDescription
\Zend_Gdata_YouTube_UserProfileEntryProvides a fluent interface
Throws
ExceptionDescription
\Zend_Gdata_App_VersionException
methodpublicsetLocation(\Zend_Gdata_YouTube_Extension_Location $location = null) : \Zend_Gdata_YouTube_UserProfileEntry

Sets the location

Parameters
NameTypeDescription
$location\Zend_Gdata_YouTube_Extension_Location

The location

Returns
TypeDescription
\Zend_Gdata_YouTube_UserProfileEntryProvides a fluent interface
methodpublicsetMovies(\Zend_Gdata_YouTube_Extension_Movies $movies = null) : \Zend_Gdata_YouTube_UserProfileEntry

Sets the movies

Parameters
NameTypeDescription
$movies\Zend_Gdata_YouTube_Extension_Movies

The movies

Returns
TypeDescription
\Zend_Gdata_YouTube_UserProfileEntryProvides a fluent interface
methodpublicsetMusic(\Zend_Gdata_YouTube_Extension_Music $music = null) : \Zend_Gdata_YouTube_UserProfileEntry

Sets the music

Parameters
NameTypeDescription
$music\Zend_Gdata_YouTube_Extension_Music

The music

Returns
TypeDescription
\Zend_Gdata_YouTube_UserProfileEntryProvides a fluent interface
methodpublicsetOccupation(\Zend_Gdata_YouTube_Extension_Occupation $occupation = null) : \Zend_Gdata_YouTube_UserProfileEntry

Sets the occupation

Parameters
NameTypeDescription
$occupation\Zend_Gdata_YouTube_Extension_Occupation

The occupation

Returns
TypeDescription
\Zend_Gdata_YouTube_UserProfileEntryProvides a fluent interface
methodpublicsetRelationship(\Zend_Gdata_YouTube_Extension_Relationship $relationship = null) : \Zend_Gdata_YouTube_UserProfileEntry

Sets the relationship

Parameters
NameTypeDescription
$relationship\Zend_Gdata_YouTube_Extension_Relationship

The relationship

Returns
TypeDescription
\Zend_Gdata_YouTube_UserProfileEntryProvides a fluent interface
methodpublicsetSchool(\Zend_Gdata_YouTube_Extension_School $school = null) : \Zend_Gdata_YouTube_UserProfileEntry

Sets the school

Parameters
NameTypeDescription
$school\Zend_Gdata_YouTube_Extension_School

The school

Returns
TypeDescription
\Zend_Gdata_YouTube_UserProfileEntryProvides a fluent interface
methodpublicsetUsername(\Zend_Gdata_YouTube_Extension_Username $username = null) : \Zend_Gdata_YouTube_UserProfileEntry

Sets the username

Parameters
NameTypeDescription
$username\Zend_Gdata_YouTube_Extension_Username

The username

Returns
TypeDescription
\Zend_Gdata_YouTube_UserProfileEntryProvides a fluent interface
methodprotectedtakeChildFromDOM(\DOMNode $child) : void

Creates individual Entry objects of the appropriate type and stores them in the $_entry array based upon DOM data.

Parameters
NameTypeDescription
$child\DOMNode

The DOMNode to process

Documentation was generated by phpDocumentor 2.2.0 .