Zend Framework  1.12
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
Zend_Gdata_YouTube_UserProfileEntry Class Reference

Public Member Functions

 __construct ($element=null)
 Creates a User Profile entry, representing an individual user and their attributes.
 
 getDOM ($doc=null, $majorVersion=1, $minorVersion=null)
 Retrieves a DOMElement which corresponds to this element and all child properties.
 
 setAboutMe ($aboutMe=null)
 Sets the content of the 'about me' field.
 
 getAboutMe ()
 Returns the contents of the 'about me' field.
 
 setFirstName ($firstName=null)
 Sets the content of the 'first name' field.
 
 getFirstName ()
 Returns the first name.
 
 setLastName ($lastName=null)
 Sets the content of the 'last name' field.
 
 getLastName ()
 Returns the last name.
 
 getStatistics ()
 Returns the statistics.
 
 getThumbnail ()
 Returns the thumbnail.
 
 setAge ($age=null)
 Sets the age.
 
 getAge ()
 Returns the age.
 
 setUsername ($username=null)
 Sets the username.
 
 getUsername ()
 Returns the username.
 
 setBooks ($books=null)
 Sets the books.
 
 getBooks ()
 Returns the books.
 
 setCompany ($company=null)
 Sets the company.
 
 getCompany ()
 Returns the company.
 
 setHobbies ($hobbies=null)
 Sets the hobbies.
 
 getHobbies ()
 Returns the hobbies.
 
 setHometown ($hometown=null)
 Sets the hometown.
 
 getHometown ()
 Returns the hometown.
 
 setLocation ($location=null)
 Sets the location.
 
 getLocation ()
 Returns the location.
 
 setMovies ($movies=null)
 Sets the movies.
 
 getMovies ()
 Returns the movies.
 
 setMusic ($music=null)
 Sets the music.
 
 getMusic ()
 Returns the music.
 
 setOccupation ($occupation=null)
 Sets the occupation.
 
 getOccupation ()
 Returns the occupation.
 
 setSchool ($school=null)
 Sets the school.
 
 getSchool ()
 Returns the school.
 
 setGender ($gender=null)
 Sets the gender.
 
 getGender ()
 Returns the gender.
 
 setRelationship ($relationship=null)
 Sets the relationship.
 
 getRelationship ()
 Returns the relationship.
 
 setFeedLink ($feedLink=null)
 Sets the array of embedded feeds related to the video.
 
 getFeedLink ($rel=null)
 Get the feed link property for this entry.
 
 getFeedLinkHref ($rel)
 Returns the URL in the gd:feedLink with the provided rel value.
 
 getPlaylistListFeedUrl ()
 Returns the URL of the playlist list feed.
 
 getUploadsFeedUrl ()
 Returns the URL of the uploads feed.
 
 getSubscriptionsFeedUrl ()
 Returns the URL of the subscriptions feed.
 
 getContactsFeedUrl ()
 Returns the URL of the contacts feed.
 
 getFavoritesFeedUrl ()
 Returns the URL of the favorites feed.
 
- Public Member Functions inherited from Zend_Gdata_Entry
 __construct ($element=null)
 
 getDOM ($doc=null, $majorVersion=1, $minorVersion=null)
 
- Public Member Functions inherited from Zend_Gdata_App_MediaEntry
 __construct ($element=null, $mediaSource=null)
 Constructs a new MediaEntry, representing XML data and optional file to upload.
 
 encode ()
 Return the MIME multipart representation of this MediaEntry.
 
 getMediaSource ()
 Return the MediaSource object representing the file attached to this MediaEntry.
 
 setMediaSource ($value)
 Set the MediaSource object (file) for this MediaEntry.
 
- Public Member Functions inherited from Zend_Gdata_App_Entry
 getDOM ($doc=null, $majorVersion=1, $minorVersion=null)
 
 save ($uri=null, $className=null, $extraHeaders=array())
 Uploads changes in this entry to the server using Zend_Gdata_App.
 
 delete ()
 Deletes this entry to the server using the referenced Zend_Http_Client to do a HTTP DELETE to the edit link stored in this entry's link collection.
 
 reload ($uri=null, $className=null, $extraHeaders=array())
 Reload the current entry.
 
 getContent ()
 Gets the value of the atom:content element.
 
 setContent ($value)
 Sets the value of the atom:content element.
 
 getPublished ()
 Sets the value of the atom:published element This represents the publishing date for an entry.
 
 setPublished ($value)
 Sets the value of the atom:published element This represents the publishing date for an entry.
 
 getSource ()
 Gets the value of the atom:source element.
 
 setSource ($value)
 Sets the value of the atom:source element.
 
 getSummary ()
 Gets the value of the atom:summary element This represents a textual summary of this entry's content.
 
 setSummary ($value)
 Sets the value of the atom:summary element This represents a textual summary of this entry's content.
 
 getControl ()
 Gets the value of the app:control element.
 
 setControl ($value)
 Sets the value of the app:control element.
 
- Public Member Functions inherited from Zend_Gdata_App_FeedEntryParent
 __construct ($element=null)
 Constructs a Feed or Entry.
 
 setHttpClient (Zend_Http_Client $httpClient)
 Set the HTTP client instance.
 
 getHttpClient ()
 Gets the HTTP client object.
 
 setService ($instance)
 Set the active service instance for this object.
 
 getService ()
 Get the active service instance for this object.
 
 getDOM ($doc=null, $majorVersion=1, $minorVersion=null)
 
 getAuthor ()
 
 setAuthor ($value)
 Sets the list of the authors of this feed/entry.
 
 getCategory ()
 Returns the array of categories that classify this feed/entry.
 
 setCategory ($value)
 Sets the array of categories that classify this feed/entry.
 
 getContributor ()
 Returns the array of contributors to this feed/entry.
 
 setContributor ($value)
 Sets the array of contributors to this feed/entry.
 
 getId ()
 
 setId ($value)
 
 getLink ($rel=null)
 Given a particular 'rel' value, this method returns a matching Zend_Gdata_App_Extension_Link element.
 
 getEditLink ()
 Returns the Zend_Gdata_App_Extension_Link element which represents the URL used to edit this resource.
 
 getNextLink ()
 Returns the Zend_Gdata_App_Extension_Link element which represents the URL used to retrieve the next chunk of results when paging through a feed.
 
 getPreviousLink ()
 Returns the Zend_Gdata_App_Extension_Link element which represents the URL used to retrieve the previous chunk of results when paging through a feed.
 
 getLicenseLink ()
 
 getSelfLink ()
 Returns the Zend_Gdata_App_Extension_Link element which represents the URL used to retrieve the entry or feed represented by this object This link is in the atom feed/entry as an atom:link with a rel attribute value of 'self'.
 
 getAlternateLink ()
 Returns the Zend_Gdata_App_Extension_Link element which represents the URL for an alternate view of the data represented by this feed or entry.
 
 setLink ($value)
 
 getRights ()
 
 setRights ($value)
 
 getTitle ()
 Returns the title of this feed or entry.
 
 getTitleValue ()
 Returns a string representation of the title of this feed or entry.
 
 setTitle ($value)
 Returns the title of this feed or entry.
 
 getUpdated ()
 
 setUpdated ($value)
 
 setEtag ($value)
 Set the Etag for the current entry to $value.
 
 getEtag ()
 Return the Etag for the current entry, or null if not set.
 
 setMajorProtocolVersion ($value)
 Set the major protocol version that should be used.
 
 getMajorProtocolVersion ()
 Get the major protocol version that is in use.
 
 setMinorProtocolVersion ($value)
 Set the minor protocol version that should be used.
 
 getMinorProtocolVersion ()
 Get the minor protocol version that is in use.
 
 lookupNamespace ($prefix, $majorVersion=null, $minorVersion=null)
 Get the full version of a namespace prefix.
 
- Public Member Functions inherited from Zend_Gdata_App_Base
 __construct ()
 
 getText ($trim=true)
 Returns the child text node of this element This represents any raw text contained within the XML element.
 
 setText ($value)
 Sets the child text node of this element This represents any raw text contained within the XML element.
 
 getExtensionElements ()
 Returns an array of all elements not matched to data model classes during the parsing of the XML.
 
 setExtensionElements ($value)
 Sets an array of all elements not matched to data model classes during the parsing of the XML.
 
 getExtensionAttributes ()
 Returns an array of all extension attributes not transformed into data model properties during parsing of the XML.
 
 setExtensionAttributes ($value)
 Sets an array of all extension attributes not transformed into data model properties during parsing of the XML.
 
 getDOM ($doc=null, $majorVersion=1, $minorVersion=null)
 Retrieves a DOMElement which corresponds to this element and all child properties.
 
 transferFromDOM ($node)
 Transfers each child and attribute into member variables.
 
 transferFromXML ($xml)
 Parses the provided XML text and generates data model classes for each know element by turning the XML text into a DOM tree and calling transferFromDOM($element).
 
 saveXML ()
 Converts this element and all children into XML text using getDOM()
 
 getXML ()
 Alias for saveXML() returns XML content for this element and all children.
 
 encode ()
 Alias for saveXML()
 
 lookupNamespace ($prefix, $majorVersion=1, $minorVersion=null)
 Get the full version of a namespace prefix.
 
 registerNamespace ($prefix, $namespaceUri, $majorVersion=1, $minorVersion=0)
 Add a namespace and prefix to the registered list.
 
 registerAllNamespaces ($namespaceArray)
 Add an array of namespaces to the registered list.
 
 __get ($name)
 Magic getter to allow access like $entry->foo to call $entry->getFoo() Alternatively, if no getFoo() is defined, but a $_foo protected variable is defined, this is returned.
 
 __set ($name, $val)
 Magic setter to allow acces like $entry->foo='bar' to call $entry->setFoo('bar') automatically.
 
 __isset ($name)
 Magic __isset method.
 
 __unset ($name)
 Magic __unset method.
 
 __toString ()
 Magic toString method allows using this directly via echo Works best in PHP >= 4.2.0.
 

Protected Member Functions

 takeChildFromDOM ($child)
 Creates individual Entry objects of the appropriate type and stores them in the $_entry array based upon DOM data.
 
- Protected Member Functions inherited from Zend_Gdata_Entry
 takeChildFromDOM ($child)
 
 takeAttributeFromDOM ($attribute)
 Given a DOMNode representing an attribute, tries to map the data into instance members.
 

Protected Attributes

 $_entryClassName = 'Zend_Gdata_YouTube_UserProfileEntry'
 
 $_feedLink = array()
 
 $_username = null
 
 $_description = null
 
 $_aboutMe = null
 
 $_age = null
 
 $_books = null
 
 $_company = null
 
 $_hobbies = null
 
 $_hometown = null
 
 $_location = null
 
 $_movies = null
 
 $_music = null
 
 $_occupation = null
 
 $_school = null
 
 $_gender = null
 
 $_relationship = null
 
 $_firstName = null
 
 $_lastName = null
 
 $_statistics = null
 
 $_thumbnail = null
 
- Protected Attributes inherited from Zend_Gdata_Entry
 $_entryClassName = 'Zend_Gdata_Entry'
 
- Protected Attributes inherited from Zend_Gdata_App_MediaEntry
 $_mediaSource = null
 
- Protected Attributes inherited from Zend_Gdata_App_Entry
 $_rootElement = 'entry'
 
 $_entryClassName = 'Zend_Gdata_App_Entry'
 
 $_content = null
 
 $_published = null
 
 $_source = null
 
 $_summary = null
 
 $_control = null
 
 $_edited = null
 
- Protected Attributes inherited from Zend_Gdata_App_FeedEntryParent
 $_service = null
 Service instance used to make network requests.
 
 $_etag = NULL
 
 $_author = array()
 
 $_category = array()
 
 $_contributor = array()
 
 $_id = null
 
 $_link = array()
 
 $_rights = null
 
 $_title = null
 
 $_updated = null
 
 $_majorProtocolVersion = 1
 Indicates the major protocol version that should be used.
 
 $_minorProtocolVersion = null
 Indicates the minor protocol version that should be used.
 
- Protected Attributes inherited from Zend_Gdata_App_Base
 $_rootElement = null
 
 $_rootNamespace = 'atom'
 
 $_rootNamespaceURI = null
 
 $_extensionElements = array()
 
 $_extensionAttributes = array()
 
 $_text = null
 
 $_namespaces
 

Additional Inherited Members

- Static Public Member Functions inherited from Zend_Gdata_App_Base
static flushNamespaceLookupCache ()
 Flush namespace lookup cache.
 
- Static Protected Attributes inherited from Zend_Gdata_App_Base
static $_namespaceLookupCache = array()
 

Constructor & Destructor Documentation

__construct (   $element = null)

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

Parameters
DOMElement$element(optional) DOMElement from which this object should be constructed.

Member Function Documentation

getAboutMe ( )

Returns the contents of the 'about me' field.

Exceptions
Zend_Gdata_App_VersionException
Returns
Zend_Gdata_YouTube_Extension_AboutMe The 'about me' information
getAge ( )

Returns the age.

Returns
Zend_Gdata_YouTube_Extension_Age The age
getBooks ( )

Returns the books.

Returns
Zend_Gdata_YouTube_Extension_Books The books
getCompany ( )

Returns the company.

Returns
Zend_Gdata_YouTube_Extension_Company The company
getContactsFeedUrl ( )

Returns the URL of the contacts feed.

Returns
string The URL of the contacts feed
getDOM (   $doc = null,
  $majorVersion = 1,
  $minorVersion = null 
)

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
DOMDocument$docThe DOMDocument used to construct DOMElements
Returns
DOMElement The DOMElement representing this element and all child properties.
getFavoritesFeedUrl ( )

Returns the URL of the favorites feed.

Returns
string The URL of the favorites feed
getFeedLink (   $rel = null)

Get the feed link property for this entry.

See Also
setFeedLink
Parameters
string$rel(optional) The rel value of the link to be found. If null, the array of links is returned.
Returns
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.
getFeedLinkHref (   $rel)

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

Parameters
string$relThe rel value to find
Returns
mixed Either the URL as a string or null if a feedLink wasn't found with the provided rel value
getFirstName ( )

Returns the first name.

Exceptions
Zend_Gdata_App_VersionException
Returns
Zend_Gdata_YouTube_Extension_FirstName The first name
getGender ( )

Returns the gender.

Returns
Zend_Gdata_YouTube_Extension_Gender The gender
getHobbies ( )

Returns the hobbies.

Returns
Zend_Gdata_YouTube_Extension_Hobbies The hobbies
getHometown ( )

Returns the hometown.

Returns
Zend_Gdata_YouTube_Extension_Hometown The hometown
getLastName ( )

Returns the last name.

Exceptions
Zend_Gdata_App_VersionException
Returns
Zend_Gdata_YouTube_Extension_LastName The last name
getLocation ( )

Returns the location.

Returns
Zend_Gdata_YouTube_Extension_Location The location
getMovies ( )

Returns the movies.

Returns
Zend_Gdata_YouTube_Extension_Movies The movies
getMusic ( )

Returns the music.

Returns
Zend_Gdata_YouTube_Extension_Music The music
getOccupation ( )

Returns the occupation.

Returns
Zend_Gdata_YouTube_Extension_Occupation The occupation
getPlaylistListFeedUrl ( )

Returns the URL of the playlist list feed.

Returns
string The URL of the playlist video feed
getRelationship ( )

Returns the relationship.

Returns
Zend_Gdata_YouTube_Extension_Relationship The relationship
getSchool ( )

Returns the school.

Returns
Zend_Gdata_YouTube_Extension_School The school
getStatistics ( )

Returns the statistics.

Exceptions
Zend_Gdata_App_VersionException
Returns
Zend_Gdata_YouTube_Extension_Statistics The profile statistics
getSubscriptionsFeedUrl ( )

Returns the URL of the subscriptions feed.

Returns
string The URL of the subscriptions feed
getThumbnail ( )

Returns the thumbnail.

Exceptions
Zend_Gdata_App_VersionException
Returns
Zend_Gdata_Media_Extension_MediaThumbnail The profile thumbnail
getUploadsFeedUrl ( )

Returns the URL of the uploads feed.

Returns
string The URL of the uploads video feed
getUsername ( )

Returns the username.

Returns
Zend_Gdata_YouTube_Extension_Username The username
setAboutMe (   $aboutMe = null)

Sets the content of the 'about me' field.

Parameters
Zend_Gdata_YouTube_Extension_AboutMe$aboutMeThe 'about me' information.
Exceptions
Zend_Gdata_App_VersionException
Returns
Zend_Gdata_YouTube_UserProfileEntry Provides a fluent interface
setAge (   $age = null)

Sets the age.

Parameters
Zend_Gdata_YouTube_Extension_Age$ageThe age
Returns
Zend_Gdata_YouTube_UserProfileEntry Provides a fluent interface
setBooks (   $books = null)

Sets the books.

Parameters
Zend_Gdata_YouTube_Extension_Books$booksThe books
Returns
Zend_Gdata_YouTube_UserProfileEntry Provides a fluent interface
setCompany (   $company = null)

Sets the company.

Parameters
Zend_Gdata_YouTube_Extension_Company$companyThe company
Returns
Zend_Gdata_YouTube_UserProfileEntry Provides a fluent interface
setFeedLink (   $feedLink = null)

Sets the array of embedded feeds related to the video.

Parameters
array$feedLinkThe array of embedded feeds relating to the video
Returns
Zend_Gdata_YouTube_UserProfileEntry Provides a fluent interface
setFirstName (   $firstName = null)

Sets the content of the 'first name' field.

Parameters
Zend_Gdata_YouTube_Extension_FirstName$firstNameThe first name
Exceptions
Zend_Gdata_App_VersionException
Returns
Zend_Gdata_YouTube_UserProfileEntry Provides a fluent interface
setGender (   $gender = null)

Sets the gender.

Parameters
Zend_Gdata_YouTube_Extension_Gender$genderThe gender
Returns
Zend_Gdata_YouTube_UserProfileEntry Provides a fluent interface
setHobbies (   $hobbies = null)

Sets the hobbies.

Parameters
Zend_Gdata_YouTube_Extension_Hobbies$hobbiesThe hobbies
Returns
Zend_Gdata_YouTube_UserProfileEntry Provides a fluent interface
setHometown (   $hometown = null)

Sets the hometown.

Parameters
Zend_Gdata_YouTube_Extension_Hometown$hometownThe hometown
Returns
Zend_Gdata_YouTube_UserProfileEntry Provides a fluent interface
setLastName (   $lastName = null)

Sets the content of the 'last name' field.

Parameters
Zend_Gdata_YouTube_Extension_LastName$lastNameThe last name
Exceptions
Zend_Gdata_App_VersionException
Returns
Zend_Gdata_YouTube_UserProfileEntry Provides a fluent interface
setLocation (   $location = null)

Sets the location.

Parameters
Zend_Gdata_YouTube_Extension_Location$locationThe location
Returns
Zend_Gdata_YouTube_UserProfileEntry Provides a fluent interface
setMovies (   $movies = null)

Sets the movies.

Parameters
Zend_Gdata_YouTube_Extension_Movies$moviesThe movies
Returns
Zend_Gdata_YouTube_UserProfileEntry Provides a fluent interface
setMusic (   $music = null)

Sets the music.

Parameters
Zend_Gdata_YouTube_Extension_Music$musicThe music
Returns
Zend_Gdata_YouTube_UserProfileEntry Provides a fluent interface
setOccupation (   $occupation = null)

Sets the occupation.

Parameters
Zend_Gdata_YouTube_Extension_Occupation$occupationThe occupation
Returns
Zend_Gdata_YouTube_UserProfileEntry Provides a fluent interface
setRelationship (   $relationship = null)

Sets the relationship.

Parameters
Zend_Gdata_YouTube_Extension_Relationship$relationshipThe relationship
Returns
Zend_Gdata_YouTube_UserProfileEntry Provides a fluent interface
setSchool (   $school = null)

Sets the school.

Parameters
Zend_Gdata_YouTube_Extension_School$schoolThe school
Returns
Zend_Gdata_YouTube_UserProfileEntry Provides a fluent interface
setUsername (   $username = null)

Sets the username.

Parameters
Zend_Gdata_YouTube_Extension_Username$usernameThe username
Returns
Zend_Gdata_YouTube_UserProfileEntry Provides a fluent interface
takeChildFromDOM (   $child)
protected

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

Parameters
DOMNode$childThe DOMNode to process

Member Data Documentation

$_aboutMe = null
protected
$_age = null
protected
$_books = null
protected
$_company = null
protected
$_description = null
protected
$_entryClassName = 'Zend_Gdata_YouTube_UserProfileEntry'
protected
$_feedLink = array()
protected
$_firstName = null
protected
$_gender = null
protected
$_hobbies = null
protected
$_hometown = null
protected
$_lastName = null
protected
$_location = null
protected
$_movies = null
protected
$_music = null
protected
$_occupation = null
protected
$_relationship = null
protected
$_school = null
protected
$_statistics = null
protected
$_thumbnail = null
protected
$_username = null
protected