API Documentation

Gdata/YouTube/UserProfileEntry.php

Includes Classes 
category
Zend
copyright
Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license
http://framework.zend.com/license/new-bsd New BSD License
package
Zend_Gdata
subpackage
YouTube
version
$Id: UserProfileEntry.php 20096 2010-01-06 02:05:09Z bkarwin $
Classes
Zend_Gdata_YouTube_UserProfileEntry

Description

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.

Zend_Gdata_YouTube_UserProfileEntry
jump to top

Extends from
Zend_Gdata_Entry
category
Zend
copyright
Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license
http://framework.zend.com/license/new-bsd New BSD License
package
Zend_Gdata
subpackage
YouTube
Properties
$_entryClassName
$_feedLink
$_username
$_description
$_aboutMe
$_age
$_books
$_company
$_hobbies
$_hometown
$_location
$_movies
$_music
$_occupation
$_school
$_gender
$_relationship
$_firstName
$_lastName
$_statistics
$_thumbnail
Methods
__construct
getDOM
takeChildFromDOM
setAboutMe
getAboutMe
setFirstName
getFirstName
setLastName
getLastName
getStatistics
getThumbnail
setAge
getAge
setUsername
getUsername
setBooks
getBooks
setCompany
getCompany
setHobbies
getHobbies
setHometown
getHometown
setLocation
getLocation
setMovies
getMovies
setMusic
getMusic
setOccupation
getOccupation
setSchool
getSchool
setGender
getGender
setRelationship
getRelationship
setFeedLink
getFeedLink
getFeedLinkHref
getPlaylistListFeedUrl
getUploadsFeedUrl
getSubscriptionsFeedUrl
getContactsFeedUrl
getFavoritesFeedUrl

Description

Represents the YouTube video playlist flavor of an Atom entry

Properties

$_aboutMe
jump to class

string $_aboutMe = 'null'

The contents of the 'About Me' field.

Details

$_aboutMe
string
visibility
protected
default
null
final
false
static
false

$_age
jump to class

int $_age = 'null'

The age of the user

Details

$_age
int
visibility
protected
default
null
final
false
static
false

$_books
jump to class

string $_books = 'null'

Books of interest to the user

Details

$_books
string
visibility
protected
default
null
final
false
static
false

$_company
jump to class

string $_company = 'null'

Company

Details

$_company
string
visibility
protected
default
null
final
false
static
false

$_description
jump to class

string $_description = 'null'

The description of the user

Details

$_description
string
visibility
protected
default
null
final
false
static
false

$_entryClassName
jump to class

 $_entryClassName = 'Zend_Gdata_YouTube_UserProfileEntry'

Details

visibility
protected
default
Zend_Gdata_YouTube_UserProfileEntry
final
false
static
false

$_feedLink
jump to class

array $_feedLink = 'array'

Nested feed links

Details

$_feedLink
array
visibility
protected
default
array
final
false
static
false

$_firstName
jump to class

string $_firstName = 'null'

First name

Details

$_firstName
string
visibility
protected
default
null
final
false
static
false

$_gender
jump to class

string $_gender = 'null'

Gender

Details

$_gender
string
visibility
protected
default
null
final
false
static
false

$_hobbies
jump to class

string $_hobbies = 'null'

Hobbies

Details

$_hobbies
string
visibility
protected
default
null
final
false
static
false

$_hometown
jump to class

string $_hometown = 'null'

Hometown

Details

$_hometown
string
visibility
protected
default
null
final
false
static
false

$_lastName
jump to class

string $_lastName = 'null'

Last name

Details

$_lastName
string
visibility
protected
default
null
final
false
static
false

$_location
jump to class

string $_location = 'null'

Location

Details

$_location
string
visibility
protected
default
null
final
false
static
false

$_movies
jump to class

string $_movies = 'null'

Movies

Details

$_movies
string
visibility
protected
default
null
final
false
static
false

$_music
jump to class

string $_music = 'null'

Music

Details

$_music
string
visibility
protected
default
null
final
false
static
false

$_occupation
jump to class

string $_occupation = 'null'

Occupation

Details

$_occupation
string
visibility
protected
default
null
final
false
static
false

$_relationship
jump to class

string $_relationship = 'null'

Relationship

Details

$_relationship
string
visibility
protected
default
null
final
false
static
false

$_school
jump to class

string $_school = 'null'

School

Details

$_school
string
visibility
protected
default
null
final
false
static
false

$_statistics
jump to class

Zend_Gdata_YouTube_Extension_Statistics $_statistics = 'null'

Statistics

Details

$_statistics
Zend_Gdata_YouTube_Extension_Statistics
visibility
protected
default
null
final
false
static
false

$_thumbnail
jump to class

Zend_Gdata_Media_Extension_MediaThumbnail $_thumbnail = 'null'

Thumbnail

Details

$_thumbnail
Zend_Gdata_Media_Extension_MediaThumbnail
visibility
protected
default
null
final
false
static
false

$_username
jump to class

string $_username = 'null'

The username for this profile entry

Details

$_username
string
visibility
protected
default
null
final
false
static
false

Methods

__construct
jump to class

__construct( DOMElement $element = null ) :

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

Arguments
$element
DOMElement
(optional) DOMElement from which this object should be constructed.
Details
visibility
public
final
false
static
false

getAboutMe
jump to class

getAboutMe( ) : Zend_Gdata_YouTube_Extension_AboutMe

Returns the contents of the 'about me' field.

Output
Zend_Gdata_YouTube_Extension_AboutMe
The 'about me' information
Details
visibility
public
final
false
static
false
throws

getAge
jump to class

getAge( ) : Zend_Gdata_YouTube_Extension_Age

Returns the age

Output
Zend_Gdata_YouTube_Extension_Age
The age
Details
visibility
public
final
false
static
false

getBooks
jump to class

getBooks( ) : Zend_Gdata_YouTube_Extension_Books

Returns the books

Output
Zend_Gdata_YouTube_Extension_Books
The books
Details
visibility
public
final
false
static
false

getCompany
jump to class

getCompany( ) : Zend_Gdata_YouTube_Extension_Company

Returns the company

Output
Zend_Gdata_YouTube_Extension_Company
The company
Details
visibility
public
final
false
static
false

getContactsFeedUrl
jump to class

getContactsFeedUrl( ) : string

Returns the URL of the contacts feed

Output
string
The URL of the contacts feed
Details
visibility
public
final
false
static
false

getDOM
jump to class

getDOM( 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.

Arguments
$doc
DOMDocument
The DOMDocument used to construct DOMElements
$majorVersion
$minorVersion
Output
DOMElement
The DOMElement representing this element and all child properties.
Details
visibility
public
final
false
static
false

getFavoritesFeedUrl
jump to class

getFavoritesFeedUrl( ) : string

Returns the URL of the favorites feed

Output
string
The URL of the favorites feed
Details
visibility
public
final
false
static
false

getFeedLink
jump to class

getFeedLink( string $rel = null ) : mixed

Get the feed link property for this entry.

Arguments
$rel
string
(optional) The rel value of the link to be found. If null, the array of links is returned.
Output
mixed
If $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
visibility
public
final
false
static
false
see
setFeedLink

getFeedLinkHref
jump to class

getFeedLinkHref( string $rel ) : mixed

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

Arguments
$rel
string
The rel value to find
Output
mixed
Either the URL as a string or null if a feedLink wasn't found with the provided rel value
Details
visibility
public
final
false
static
false

getFirstName
jump to class

getFirstName( ) : Zend_Gdata_YouTube_Extension_FirstName

Returns the first name

Output
Zend_Gdata_YouTube_Extension_FirstName
The first name
Details
visibility
public
final
false
static
false
throws

getGender
jump to class

getGender( ) : Zend_Gdata_YouTube_Extension_Gender

Returns the gender

Output
Zend_Gdata_YouTube_Extension_Gender
The gender
Details
visibility
public
final
false
static
false

getHobbies
jump to class

getHobbies( ) : Zend_Gdata_YouTube_Extension_Hobbies

Returns the hobbies

Output
Zend_Gdata_YouTube_Extension_Hobbies
The hobbies
Details
visibility
public
final
false
static
false

getHometown
jump to class

getHometown( ) : Zend_Gdata_YouTube_Extension_Hometown

Returns the hometown

Output
Zend_Gdata_YouTube_Extension_Hometown
The hometown
Details
visibility
public
final
false
static
false

getLastName
jump to class

getLastName( ) : Zend_Gdata_YouTube_Extension_LastName

Returns the last name

Output
Zend_Gdata_YouTube_Extension_LastName
The last name
Details
visibility
public
final
false
static
false
throws

getLocation
jump to class

getLocation( ) : Zend_Gdata_YouTube_Extension_Location

Returns the location

Output
Zend_Gdata_YouTube_Extension_Location
The location
Details
visibility
public
final
false
static
false

getMovies
jump to class

getMovies( ) : Zend_Gdata_YouTube_Extension_Movies

Returns the movies

Output
Zend_Gdata_YouTube_Extension_Movies
The movies
Details
visibility
public
final
false
static
false

getMusic
jump to class

getMusic( ) : Zend_Gdata_YouTube_Extension_Music

Returns the music

Output
Zend_Gdata_YouTube_Extension_Music
The music
Details
visibility
public
final
false
static
false

getOccupation
jump to class

getOccupation( ) : Zend_Gdata_YouTube_Extension_Occupation

Returns the occupation

Output
Zend_Gdata_YouTube_Extension_Occupation
The occupation
Details
visibility
public
final
false
static
false

getPlaylistListFeedUrl
jump to class

getPlaylistListFeedUrl( ) : string

Returns the URL of the playlist list feed

Output
string
The URL of the playlist video feed
Details
visibility
public
final
false
static
false

getRelationship
jump to class

getRelationship( ) : Zend_Gdata_YouTube_Extension_Relationship

Returns the relationship

Output
Zend_Gdata_YouTube_Extension_Relationship
The relationship
Details
visibility
public
final
false
static
false

getSchool
jump to class

getSchool( ) : Zend_Gdata_YouTube_Extension_School

Returns the school

Output
Zend_Gdata_YouTube_Extension_School
The school
Details
visibility
public
final
false
static
false

getStatistics
jump to class

getStatistics( ) : Zend_Gdata_YouTube_Extension_Statistics

Returns the statistics

Output
Zend_Gdata_YouTube_Extension_Statistics
The profile statistics
Details
visibility
public
final
false
static
false
throws

getSubscriptionsFeedUrl
jump to class

getSubscriptionsFeedUrl( ) : string

Returns the URL of the subscriptions feed

Output
string
The URL of the subscriptions feed
Details
visibility
public
final
false
static
false

getThumbnail
jump to class

getThumbnail( ) : Zend_Gdata_Media_Extension_MediaThumbnail

Returns the thumbnail

Output
Zend_Gdata_Media_Extension_MediaThumbnail
The profile thumbnail
Details
visibility
public
final
false
static
false
throws

getUploadsFeedUrl
jump to class

getUploadsFeedUrl( ) : string

Returns the URL of the uploads feed

Output
string
The URL of the uploads video feed
Details
visibility
public
final
false
static
false

getUsername
jump to class

getUsername( ) : Zend_Gdata_YouTube_Extension_Username

Returns the username

Output
Zend_Gdata_YouTube_Extension_Username
The username
Details
visibility
public
final
false
static
false

setAboutMe
jump to class

setAboutMe( Zend_Gdata_YouTube_Extension_AboutMe $aboutMe = null ) : Zend_Gdata_YouTube_UserProfileEntry

Sets the content of the 'about me' field.

Arguments
$aboutMe
Zend_Gdata_YouTube_Extension_AboutMe
The 'about me' information.
Output
Zend_Gdata_YouTube_UserProfileEntry
Provides a fluent interface
Details
visibility
public
final
false
static
false
throws

setAge
jump to class

setAge( Zend_Gdata_YouTube_Extension_Age $age = null ) : Zend_Gdata_YouTube_UserProfileEntry

Sets the age

Arguments
$age
Zend_Gdata_YouTube_Extension_Age
The age
Output
Zend_Gdata_YouTube_UserProfileEntry
Provides a fluent interface
Details
visibility
public
final
false
static
false

setBooks
jump to class

setBooks( Zend_Gdata_YouTube_Extension_Books $books = null ) : Zend_Gdata_YouTube_UserProfileEntry

Sets the books

Arguments
$books
Zend_Gdata_YouTube_Extension_Books
The books
Output
Zend_Gdata_YouTube_UserProfileEntry
Provides a fluent interface
Details
visibility
public
final
false
static
false

setCompany
jump to class

setCompany( Zend_Gdata_YouTube_Extension_Company $company = null ) : Zend_Gdata_YouTube_UserProfileEntry

Sets the company

Arguments
$company
Zend_Gdata_YouTube_Extension_Company
The company
Output
Zend_Gdata_YouTube_UserProfileEntry
Provides a fluent interface
Details
visibility
public
final
false
static
false

setFeedLink
jump to class

setFeedLink( array $feedLink = null ) : Zend_Gdata_YouTube_UserProfileEntry

Sets the array of embedded feeds related to the video

Arguments
$feedLink
array
The array of embedded feeds relating to the video
Output
Zend_Gdata_YouTube_UserProfileEntry
Provides a fluent interface
Details
visibility
public
final
false
static
false

setFirstName
jump to class

setFirstName( Zend_Gdata_YouTube_Extension_FirstName $firstName = null ) : Zend_Gdata_YouTube_UserProfileEntry

Sets the content of the 'first name' field.

Arguments
$firstName
Zend_Gdata_YouTube_Extension_FirstName
The first name
Output
Zend_Gdata_YouTube_UserProfileEntry
Provides a fluent interface
Details
visibility
public
final
false
static
false
throws

setGender
jump to class

setGender( Zend_Gdata_YouTube_Extension_Gender $gender = null ) : Zend_Gdata_YouTube_UserProfileEntry

Sets the gender

Arguments
$gender
Zend_Gdata_YouTube_Extension_Gender
The gender
Output
Zend_Gdata_YouTube_UserProfileEntry
Provides a fluent interface
Details
visibility
public
final
false
static
false

setHobbies
jump to class

setHobbies( Zend_Gdata_YouTube_Extension_Hobbies $hobbies = null ) : Zend_Gdata_YouTube_UserProfileEntry

Sets the hobbies

Arguments
$hobbies
Zend_Gdata_YouTube_Extension_Hobbies
The hobbies
Output
Zend_Gdata_YouTube_UserProfileEntry
Provides a fluent interface
Details
visibility
public
final
false
static
false

setHometown
jump to class

setHometown( Zend_Gdata_YouTube_Extension_Hometown $hometown = null ) : Zend_Gdata_YouTube_UserProfileEntry

Sets the hometown

Arguments
$hometown
Zend_Gdata_YouTube_Extension_Hometown
The hometown
Output
Zend_Gdata_YouTube_UserProfileEntry
Provides a fluent interface
Details
visibility
public
final
false
static
false

setLastName
jump to class

setLastName( Zend_Gdata_YouTube_Extension_LastName $lastName = null ) : Zend_Gdata_YouTube_UserProfileEntry

Sets the content of the 'last name' field.

Arguments
$lastName
Zend_Gdata_YouTube_Extension_LastName
The last name
Output
Zend_Gdata_YouTube_UserProfileEntry
Provides a fluent interface
Details
visibility
public
final
false
static
false
throws

setLocation
jump to class

setLocation( Zend_Gdata_YouTube_Extension_Location $location = null ) : Zend_Gdata_YouTube_UserProfileEntry

Sets the location

Arguments
$location
Zend_Gdata_YouTube_Extension_Location
The location
Output
Zend_Gdata_YouTube_UserProfileEntry
Provides a fluent interface
Details
visibility
public
final
false
static
false

setMovies
jump to class

setMovies( Zend_Gdata_YouTube_Extension_Movies $movies = null ) : Zend_Gdata_YouTube_UserProfileEntry

Sets the movies

Arguments
$movies
Zend_Gdata_YouTube_Extension_Movies
The movies
Output
Zend_Gdata_YouTube_UserProfileEntry
Provides a fluent interface
Details
visibility
public
final
false
static
false

setMusic
jump to class

setMusic( Zend_Gdata_YouTube_Extension_Music $music = null ) : Zend_Gdata_YouTube_UserProfileEntry

Sets the music

Arguments
$music
Zend_Gdata_YouTube_Extension_Music
The music
Output
Zend_Gdata_YouTube_UserProfileEntry
Provides a fluent interface
Details
visibility
public
final
false
static
false

setOccupation
jump to class

setOccupation( Zend_Gdata_YouTube_Extension_Occupation $occupation = null ) : Zend_Gdata_YouTube_UserProfileEntry

Sets the occupation

Arguments
$occupation
Zend_Gdata_YouTube_Extension_Occupation
The occupation
Output
Zend_Gdata_YouTube_UserProfileEntry
Provides a fluent interface
Details
visibility
public
final
false
static
false

setRelationship
jump to class

setRelationship( Zend_Gdata_YouTube_Extension_Relationship $relationship = null ) : Zend_Gdata_YouTube_UserProfileEntry

Sets the relationship

Arguments
$relationship
Zend_Gdata_YouTube_Extension_Relationship
The relationship
Output
Zend_Gdata_YouTube_UserProfileEntry
Provides a fluent interface
Details
visibility
public
final
false
static
false

setSchool
jump to class

setSchool( Zend_Gdata_YouTube_Extension_School $school = null ) : Zend_Gdata_YouTube_UserProfileEntry

Sets the school

Arguments
$school
Zend_Gdata_YouTube_Extension_School
The school
Output
Zend_Gdata_YouTube_UserProfileEntry
Provides a fluent interface
Details
visibility
public
final
false
static
false

setUsername
jump to class

setUsername( Zend_Gdata_YouTube_Extension_Username $username = null ) : Zend_Gdata_YouTube_UserProfileEntry

Sets the username

Arguments
$username
Zend_Gdata_YouTube_Extension_Username
The username
Output
Zend_Gdata_YouTube_UserProfileEntry
Provides a fluent interface
Details
visibility
public
final
false
static
false

takeChildFromDOM
jump to class

takeChildFromDOM( DOMNode $child ) :

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

Arguments
$child
DOMNode
The DOMNode to process
Details
visibility
protected
final
false
static
false
Documentation was generated by DocBlox.