Zend/Gdata/YouTube/UserProfileEntry.php

Show:

inherited

Classes
- \Zend_Gdata_YouTube_UserProfileEntry

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-2012 Zend Technologies USA Inc. (http://www.zend.com)
License: New BSD License
Package: Zend_Gdata
Subpackage: YouTube
Version: $Id: UserProfileEntry.php 24593 2012-01-05 20:35:02Z matthew $

\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-2012 Zend Technologies USA Inc. (http://www.zend.com)
License: New BSD License

Properties

string
                 $_aboutMe= 'null'

The contents of the 'About Me' field.

Default valuenullDetails

Type: string

int
                 $_age= 'null'

The age of the user

Default valuenullDetails

Type: int

string
                 $_books= 'null'

Books of interest to the user

Default valuenullDetails

Type: string

string
                 $_company= 'null'

Company

Default valuenullDetails

Type: string

string
                 $_description= 'null'

The description of the user

Default valuenullDetails

Type: string


                 $_entryClassName= ''Zend_Gdata_YouTube_UserProfileEntry''

Default value'Zend_Gdata_YouTube_UserProfileEntry'Details

Type

array
                 $_feedLink= 'array()'

Nested feed links

Default valuearray()Details

Type: array

string
                 $_firstName= 'null'

First name

Default valuenullDetails

Type: string

string
                 $_gender= 'null'

Gender

Default valuenullDetails

Type: string

string
                 $_hobbies= 'null'

Hobbies

Default valuenullDetails

Type: string

string
                 $_hometown= 'null'

Hometown

Default valuenullDetails

Type: string

string
                 $_lastName= 'null'

Last name

Default valuenullDetails

Type: string

string
                 $_location= 'null'

Location

Default valuenullDetails

Type: string

string
                 $_movies= 'null'

Movies

Default valuenullDetails

Type: string

string
                 $_music= 'null'

Music

Default valuenullDetails

Type: string

string
                 $_occupation= 'null'

Occupation

Default valuenullDetails

Type: string

string
                 $_relationship= 'null'

Relationship

Default valuenullDetails

Type: string

string
                 $_school= 'null'

School

Default valuenullDetails

Type: string

\Zend_Gdata_YouTube_Extension_Statistics
                 $_statistics= 'null'

Statistics

Default valuenullDetails

Type: \Zend_Gdata_YouTube_Extension_Statistics

\Zend_Gdata_Media_Extension_MediaThumbnail
                 $_thumbnail= 'null'

Thumbnail

Default valuenullDetails

Type: \Zend_Gdata_Media_Extension_MediaThumbnail

string
                 $_username= 'null'

The username for this profile entry

Default valuenullDetails

Type: string

Methods

__construct(
          \DOMElement $element
              =
              null
          )
        
        :
          void

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

Parameters

Name	Type	Description
$element	\DOMElement	(optional) DOMElement from which this object should be constructed.

getAboutMe(
          
          )
        
        :
          \Zend_Gdata_YouTube_Extension_AboutMe

Returns the contents of the 'about me' field.

Returns

Type	Description
\Zend_Gdata_YouTube_Extension_AboutMe	The 'about me' information

Throws

Exception	Description
\Zend_Gdata_App_VersionException

getAge(
          
          )
        
        :
          \Zend_Gdata_YouTube_Extension_Age

Returns the age

Returns

Type	Description
\Zend_Gdata_YouTube_Extension_Age	The age

getBooks(
          
          )
        
        :
          \Zend_Gdata_YouTube_Extension_Books

Returns the books

Returns

Type	Description
\Zend_Gdata_YouTube_Extension_Books	The books

getCompany(
          
          )
        
        :
          \Zend_Gdata_YouTube_Extension_Company

Returns the company

Returns

Type	Description
\Zend_Gdata_YouTube_Extension_Company	The company

getContactsFeedUrl(
          
          )
        
        :
          string

Returns the URL of the contacts feed

Returns

Type	Description
string	The URL of the contacts feed

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.

Parameters

Name	Type	Description
$doc	\DOMDocument	The DOMDocument used to construct DOMElements
$majorVersion
$minorVersion

Returns

Type	Description
\DOMElement	The DOMElement representing this element and all child properties.

getFavoritesFeedUrl(
          
          )
        
        :
          string

Returns the URL of the favorites feed

Returns

Type	Description
string	The URL of the favorites feed

getFeedLink(
          string $rel
              =
              null
          )
        
        :
          mixed

Get the feed link property for this entry.

Parameters

Name	Type	Description
$rel	string	(optional) The rel value of the link to be found. If null, the array of links is returned.

Returns

Type	Description
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

See: \setFeedLink

getFeedLinkHref(
          string $rel
          )
        
        :
          mixed

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

Parameters

Name	Type	Description
$rel	string	The rel value to find

Returns

Type	Description
mixed	Either the URL as a string or null if a feedLink wasn't found with the provided rel value

getFirstName(
          
          )
        
        :
          \Zend_Gdata_YouTube_Extension_FirstName

Returns the first name

Returns

Type	Description
\Zend_Gdata_YouTube_Extension_FirstName	The first name

Throws

Exception	Description
\Zend_Gdata_App_VersionException

getGender(
          
          )
        
        :
          \Zend_Gdata_YouTube_Extension_Gender

Returns the gender

Returns

Type	Description
\Zend_Gdata_YouTube_Extension_Gender	The gender

getHobbies(
          
          )
        
        :
          \Zend_Gdata_YouTube_Extension_Hobbies

Returns the hobbies

Returns

Type	Description
\Zend_Gdata_YouTube_Extension_Hobbies	The hobbies

getHometown(
          
          )
        
        :
          \Zend_Gdata_YouTube_Extension_Hometown

Returns the hometown

Returns

Type	Description
\Zend_Gdata_YouTube_Extension_Hometown	The hometown

getLastName(
          
          )
        
        :
          \Zend_Gdata_YouTube_Extension_LastName

Returns the last name

Returns

Type	Description
\Zend_Gdata_YouTube_Extension_LastName	The last name

Throws

Exception	Description
\Zend_Gdata_App_VersionException

getLocation(
          
          )
        
        :
          \Zend_Gdata_YouTube_Extension_Location

Returns the location

Returns

Type	Description
\Zend_Gdata_YouTube_Extension_Location	The location

getMovies(
          
          )
        
        :
          \Zend_Gdata_YouTube_Extension_Movies

Returns the movies

Returns

Type	Description
\Zend_Gdata_YouTube_Extension_Movies	The movies

getMusic(
          
          )
        
        :
          \Zend_Gdata_YouTube_Extension_Music

Returns the music

Returns

Type	Description
\Zend_Gdata_YouTube_Extension_Music	The music

getOccupation(
          
          )
        
        :
          \Zend_Gdata_YouTube_Extension_Occupation

Returns the occupation

Returns

Type	Description
\Zend_Gdata_YouTube_Extension_Occupation	The occupation

getPlaylistListFeedUrl(
          
          )
        
        :
          string

Returns the URL of the playlist list feed

Returns

Type	Description
string	The URL of the playlist video feed

getRelationship(
          
          )
        
        :
          \Zend_Gdata_YouTube_Extension_Relationship

Returns the relationship

Returns

Type	Description
\Zend_Gdata_YouTube_Extension_Relationship	The relationship

getSchool(
          
          )
        
        :
          \Zend_Gdata_YouTube_Extension_School

Returns the school

Returns

Type	Description
\Zend_Gdata_YouTube_Extension_School	The school

getStatistics(
          
          )
        
        :
          \Zend_Gdata_YouTube_Extension_Statistics

Returns the statistics

Returns

Type	Description
\Zend_Gdata_YouTube_Extension_Statistics	The profile statistics

Throws

Exception	Description
\Zend_Gdata_App_VersionException

getSubscriptionsFeedUrl(
          
          )
        
        :
          string

Returns the URL of the subscriptions feed

Returns

Type	Description
string	The URL of the subscriptions feed

getThumbnail(
          
          )
        
        :
          \Zend_Gdata_Media_Extension_MediaThumbnail

Returns the thumbnail

Returns

Type	Description
\Zend_Gdata_Media_Extension_MediaThumbnail	The profile thumbnail

Throws

Exception	Description
\Zend_Gdata_App_VersionException

getUploadsFeedUrl(
          
          )
        
        :
          string

Returns the URL of the uploads feed

Returns

Type	Description
string	The URL of the uploads video feed

getUsername(
          
          )
        
        :
          \Zend_Gdata_YouTube_Extension_Username

Returns the username

Returns

Type	Description
\Zend_Gdata_YouTube_Extension_Username	The username

setAboutMe(
          \Zend_Gdata_YouTube_Extension_AboutMe $aboutMe
              =
              null
          )
        
        :
          \Zend_Gdata_YouTube_UserProfileEntry

Sets the content of the 'about me' field.

Parameters

Name	Type	Description
$aboutMe	\Zend_Gdata_YouTube_Extension_AboutMe	The 'about me' information.

Returns

Type	Description
\Zend_Gdata_YouTube_UserProfileEntry	Provides a fluent interface

Throws

Exception	Description
\Zend_Gdata_App_VersionException

setAge(
          \Zend_Gdata_YouTube_Extension_Age $age
              =
              null
          )
        
        :
          \Zend_Gdata_YouTube_UserProfileEntry

Sets the age

Parameters

Name	Type	Description
$age	\Zend_Gdata_YouTube_Extension_Age	The age

Returns

Type	Description
\Zend_Gdata_YouTube_UserProfileEntry	Provides a fluent interface

setBooks(
          \Zend_Gdata_YouTube_Extension_Books $books
              =
              null
          )
        
        :
          \Zend_Gdata_YouTube_UserProfileEntry

Sets the books

Parameters

Name	Type	Description
$books	\Zend_Gdata_YouTube_Extension_Books	The books

Returns

Type	Description
\Zend_Gdata_YouTube_UserProfileEntry	Provides a fluent interface

setCompany(
          \Zend_Gdata_YouTube_Extension_Company $company
              =
              null
          )
        
        :
          \Zend_Gdata_YouTube_UserProfileEntry

Sets the company

Parameters

Name	Type	Description
$company	\Zend_Gdata_YouTube_Extension_Company	The company

Returns

Type	Description
\Zend_Gdata_YouTube_UserProfileEntry	Provides a fluent interface

setFeedLink(
          array $feedLink
              =
              null
          )
        
        :
          \Zend_Gdata_YouTube_UserProfileEntry

Sets the array of embedded feeds related to the video

Parameters

Name	Type	Description
$feedLink	array	The array of embedded feeds relating to the video

Returns

Type	Description
\Zend_Gdata_YouTube_UserProfileEntry	Provides a fluent interface

setFirstName(
          \Zend_Gdata_YouTube_Extension_FirstName $firstName
              =
              null
          )
        
        :
          \Zend_Gdata_YouTube_UserProfileEntry

Sets the content of the 'first name' field.

Parameters

Name	Type	Description
$firstName	\Zend_Gdata_YouTube_Extension_FirstName	The first name

Returns

Type	Description
\Zend_Gdata_YouTube_UserProfileEntry	Provides a fluent interface

Throws

Exception	Description
\Zend_Gdata_App_VersionException

setGender(
          \Zend_Gdata_YouTube_Extension_Gender $gender
              =
              null
          )
        
        :
          \Zend_Gdata_YouTube_UserProfileEntry

Sets the gender

Parameters

Name	Type	Description
$gender	\Zend_Gdata_YouTube_Extension_Gender	The gender

Returns

Type	Description
\Zend_Gdata_YouTube_UserProfileEntry	Provides a fluent interface

setHobbies(
          \Zend_Gdata_YouTube_Extension_Hobbies $hobbies
              =
              null
          )
        
        :
          \Zend_Gdata_YouTube_UserProfileEntry

Sets the hobbies

Parameters

Name	Type	Description
$hobbies	\Zend_Gdata_YouTube_Extension_Hobbies	The hobbies

Returns

Type	Description
\Zend_Gdata_YouTube_UserProfileEntry	Provides a fluent interface

setHometown(
          \Zend_Gdata_YouTube_Extension_Hometown $hometown
              =
              null
          )
        
        :
          \Zend_Gdata_YouTube_UserProfileEntry

Sets the hometown

Parameters

Name	Type	Description
$hometown	\Zend_Gdata_YouTube_Extension_Hometown	The hometown

Returns

Type	Description
\Zend_Gdata_YouTube_UserProfileEntry	Provides a fluent interface

setLastName(
          \Zend_Gdata_YouTube_Extension_LastName $lastName
              =
              null
          )
        
        :
          \Zend_Gdata_YouTube_UserProfileEntry

Sets the content of the 'last name' field.

Parameters

Name	Type	Description
$lastName	\Zend_Gdata_YouTube_Extension_LastName	The last name

Returns

Type	Description
\Zend_Gdata_YouTube_UserProfileEntry	Provides a fluent interface

Throws

Exception	Description
\Zend_Gdata_App_VersionException

setLocation(
          \Zend_Gdata_YouTube_Extension_Location $location
              =
              null
          )
        
        :
          \Zend_Gdata_YouTube_UserProfileEntry

Sets the location

Parameters

Name	Type	Description
$location	\Zend_Gdata_YouTube_Extension_Location	The location

Returns

Type	Description
\Zend_Gdata_YouTube_UserProfileEntry	Provides a fluent interface

setMovies(
          \Zend_Gdata_YouTube_Extension_Movies $movies
              =
              null
          )
        
        :
          \Zend_Gdata_YouTube_UserProfileEntry

Sets the movies

Parameters

Name	Type	Description
$movies	\Zend_Gdata_YouTube_Extension_Movies	The movies

Returns

Type	Description
\Zend_Gdata_YouTube_UserProfileEntry	Provides a fluent interface

setMusic(
          \Zend_Gdata_YouTube_Extension_Music $music
              =
              null
          )
        
        :
          \Zend_Gdata_YouTube_UserProfileEntry

Sets the music

Parameters

Name	Type	Description
$music	\Zend_Gdata_YouTube_Extension_Music	The music

Returns

Type	Description
\Zend_Gdata_YouTube_UserProfileEntry	Provides a fluent interface

setOccupation(
          \Zend_Gdata_YouTube_Extension_Occupation $occupation
              =
              null
          )
        
        :
          \Zend_Gdata_YouTube_UserProfileEntry

Sets the occupation

Parameters

Name	Type	Description
$occupation	\Zend_Gdata_YouTube_Extension_Occupation	The occupation

Returns

Type	Description
\Zend_Gdata_YouTube_UserProfileEntry	Provides a fluent interface

setRelationship(
          \Zend_Gdata_YouTube_Extension_Relationship $relationship
              =
              null
          )
        
        :
          \Zend_Gdata_YouTube_UserProfileEntry

Sets the relationship

Parameters

Name	Type	Description
$relationship	\Zend_Gdata_YouTube_Extension_Relationship	The relationship

Returns

Type	Description
\Zend_Gdata_YouTube_UserProfileEntry	Provides a fluent interface

setSchool(
          \Zend_Gdata_YouTube_Extension_School $school
              =
              null
          )
        
        :
          \Zend_Gdata_YouTube_UserProfileEntry

Sets the school

Parameters

Name	Type	Description
$school	\Zend_Gdata_YouTube_Extension_School	The school

Returns

Type	Description
\Zend_Gdata_YouTube_UserProfileEntry	Provides a fluent interface

setUsername(
          \Zend_Gdata_YouTube_Extension_Username $username
              =
              null
          )
        
        :
          \Zend_Gdata_YouTube_UserProfileEntry

Sets the username

Parameters

Name	Type	Description
$username	\Zend_Gdata_YouTube_Extension_Username	The username

Returns

Type	Description
\Zend_Gdata_YouTube_UserProfileEntry	Provides a fluent interface

takeChildFromDOM(
          \DOMNode $child
          )
        
        :
          void

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

Parameters

Name	Type	Description
$child	\DOMNode	The DOMNode to process

API Documentation

Zend/Gdata/YouTube/UserProfileEntry.php

\Zend_Gdata_YouTube_UserProfileEntryjump to top

Properties

Methods

\Zend_Gdata_YouTube_UserProfileEntry
jump to top