From 06f945f27840b53e57795dadbc38e76f7e11ab1c Mon Sep 17 00:00:00 2001 From: Horus3 Date: Mon, 24 Feb 2014 16:42:14 +0100 Subject: init --- .../files/Gdata.YouTube.Extension.Hometown.html | 200 +++++++++++++++++++++ 1 file changed, 200 insertions(+) create mode 100644 zend/documentation/api/core/files/Gdata.YouTube.Extension.Hometown.html (limited to 'zend/documentation/api/core/files/Gdata.YouTube.Extension.Hometown.html') diff --git a/zend/documentation/api/core/files/Gdata.YouTube.Extension.Hometown.html b/zend/documentation/api/core/files/Gdata.YouTube.Extension.Hometown.html new file mode 100644 index 0000000..999099c --- /dev/null +++ b/zend/documentation/api/core/files/Gdata.YouTube.Extension.Hometown.html @@ -0,0 +1,200 @@ + +Zend Gdata API Documentation

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

\Zend_Gdata_YouTube_Extension_Hometown
jump to top

Package: Zend\Gdata\YouTube
Represents the yt:hometown element
Parent(s)
\Zend_Gdata_Extension + < + \Zend_Gdata_App_Extension + < + \Zend_Gdata_App_Base
Category
Zend +   +
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com) +   +
License
New BSD License +   +

Properties

>VPropertyprotectedarray $_extensionAttributes = array()
inherited

Leftover attributes which were not handled

Inherited from: + \Zend_Gdata_App_Base::$$_extensionAttributes\Zend_Gdata_App_Extension::$$_extensionAttributes\Zend_Gdata_Extension::$$_extensionAttributes
Default valuearray()Details
Type
array
Inherited_from
\Zend_Gdata_App_Base::$$_extensionAttributes +   +
Inherited_from
\Zend_Gdata_App_Extension::$$_extensionAttributes +   +
Inherited_from
\Zend_Gdata_Extension::$$_extensionAttributes +   +
>VPropertyprotectedarray $_extensionElements = array()
inherited

Leftover elements which were not handled

Inherited from: + \Zend_Gdata_App_Base::$$_extensionElements\Zend_Gdata_App_Extension::$$_extensionElements\Zend_Gdata_Extension::$$_extensionElements
Default valuearray()Details
Type
array
Inherited_from
\Zend_Gdata_App_Base::$$_extensionElements +   +
Inherited_from
\Zend_Gdata_App_Extension::$$_extensionElements +   +
Inherited_from
\Zend_Gdata_Extension::$$_extensionElements +   +
>VPropertyprotectedarray $_namespaceLookupCache = array()
staticinherited

Memoized results from calls to lookupNamespace() to avoid expensive calls to getGreatestBoundedValue(). The key is in the form 'prefix-majorVersion-minorVersion', and the value is the output from getGreatestBoundedValue().

+
Inherited from: + \Zend_Gdata_App_Base::$$_namespaceLookupCache\Zend_Gdata_App_Extension::$$_namespaceLookupCache\Zend_Gdata_Extension::$$_namespaceLookupCache
Default valuearray()Details
Type
array
Inherited_from
\Zend_Gdata_App_Base::$$_namespaceLookupCache +   +
Inherited_from
\Zend_Gdata_App_Extension::$$_namespaceLookupCache +   +
Inherited_from
\Zend_Gdata_Extension::$$_namespaceLookupCache +   +
>VPropertyprotectedarray $_namespaces = array('atom' => array(1 => array(0 => 'http://www.w3.org/2005/Atom')), 'app' => array(1 => array(0 => 'http://purl.org/atom/app#'), 2 => array(0 => 'http://www.w3.org/2007/app')))
inherited
List of namespaces, as a three-dimensional array.
Inherited from: + \Zend_Gdata_App_Base::$$_namespaces\Zend_Gdata_App_Extension::$$_namespaces\Zend_Gdata_Extension::$$_namespaces

The first dimension +represents the namespace prefix, the second dimension represents the +minimum major protocol version, and the third dimension is the minimum +minor protocol version. Null keys are NOT allowed.

+ +

When looking up a namespace for a given prefix, the greatest version +number (both major and minor) which is less than the effective version +should be used.

Default valuearray('atom' => array(1 => array(0 => 'http://www.w3.org/2005/Atom')), 'app' => array(1 => array(0 => 'http://purl.org/atom/app#'), 2 => array(0 => 'http://www.w3.org/2007/app')))Details
Type
array
Inherited_from
\Zend_Gdata_App_Base::$$_namespaces +   +
Inherited_from
\Zend_Gdata_App_Extension::$$_namespaces +   +
Inherited_from
\Zend_Gdata_Extension::$$_namespaces +   +
See
\lookupNamespace() +   +
See
\registerNamespace() +   +
See
\registerAllNamespaces() +   +
>VPropertyprotectedstring $_rootElement = 'hometown'

The XML element name, including prefix if desired

Default value'hometown'Details
Type
string
>VPropertyprotectedstring $_rootNamespace = 'yt'

The XML namespace prefix

Default value'yt'Details
Type
string
>VPropertyprotectedstring $_rootNamespaceURI = null
inherited

The XML namespace URI - takes precedence over lookup up the corresponding URI for $_rootNamespace

+
Inherited from: + \Zend_Gdata_App_Base::$$_rootNamespaceURI\Zend_Gdata_App_Extension::$$_rootNamespaceURI\Zend_Gdata_Extension::$$_rootNamespaceURI
Default valuenullDetails
Type
string
Inherited_from
\Zend_Gdata_App_Base::$$_rootNamespaceURI +   +
Inherited_from
\Zend_Gdata_App_Extension::$$_rootNamespaceURI +   +
Inherited_from
\Zend_Gdata_Extension::$$_rootNamespaceURI +   +
>VPropertyprotectedstring $_text = null
inherited

XML child text node content

Inherited from: + \Zend_Gdata_App_Base::$$_text\Zend_Gdata_App_Extension::$$_text\Zend_Gdata_Extension::$$_text
Default valuenullDetails
Type
string
Inherited_from
\Zend_Gdata_App_Base::$$_text +   +
Inherited_from
\Zend_Gdata_App_Extension::$$_text +   +
Inherited_from
\Zend_Gdata_Extension::$$_text +   +

Methods

methodpublic__construct( $text = null) : void

Parameters
NameTypeDescription
$text
methodpublic__get(string $name) : void
inherited

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.

Inherited from: + \Zend_Gdata_App_Base::__get()\Zend_Gdata_App_Extension::__get()\Zend_Gdata_Extension::__get()

TODO Remove ability to bypass getFoo() methods??

Parameters
NameTypeDescription
$namestring

The variable name sought

methodpublic__isset(string $name) : void
inherited

Magic __isset method

Inherited from: + \Zend_Gdata_App_Base::__isset()\Zend_Gdata_App_Extension::__isset()\Zend_Gdata_Extension::__isset()
Parameters
NameTypeDescription
$namestring
methodpublic__set(string $name,  $val) : void
inherited

Magic setter to allow acces like $entry->foo='bar' to call +$entry->setFoo('bar') automatically.

Inherited from: + \Zend_Gdata_App_Base::__set()\Zend_Gdata_App_Extension::__set()\Zend_Gdata_Extension::__set()

Alternatively, if no setFoo() is defined, but a $_foo protected variable +is defined, this is returned.

+ +

TODO Remove ability to bypass getFoo() methods??

Parameters
NameTypeDescription
$namestring
$val
methodpublic__toString() : string
inherited

Magic toString method allows using this directly via echo +Works best in PHP >= 4.2.0

Inherited from: + \Zend_Gdata_App_Base::__toString()\Zend_Gdata_App_Extension::__toString()\Zend_Gdata_Extension::__toString()
Returns
TypeDescription
stringThe text representation of this object
methodpublic__unset(string $name) : void
inherited

Magic __unset method

Inherited from: + \Zend_Gdata_App_Base::__unset()\Zend_Gdata_App_Extension::__unset()\Zend_Gdata_Extension::__unset()
Parameters
NameTypeDescription
$namestring
methodpublicencode() : string
inherited

Alias for saveXML()

Inherited from: + \Zend_Gdata_App_Base::encode()\Zend_Gdata_App_Extension::encode()\Zend_Gdata_Extension::encode()

Can be overridden by children to provide more complex representations +of entries.

Returns
TypeDescription
stringEncoded string content
methodpublicflushNamespaceLookupCache() : void
staticinherited

Flush namespace lookup cache.

Inherited from: + \Zend_Gdata_App_Base::flushNamespaceLookupCache()\Zend_Gdata_App_Extension::flushNamespaceLookupCache()\Zend_Gdata_Extension::flushNamespaceLookupCache()

Empties the namespace lookup cache. Call this function if you have +added data to the namespace lookup table that contradicts values that +may have been cached during a previous call to lookupNamespace().

methodpublicgetDOM(\DOMDocument $doc = null,  $majorVersion = 1,  $minorVersion = null) : \DOMElement
inherited

Retrieves a DOMElement which corresponds to this element and all +child properties.

Inherited from: + \Zend_Gdata_App_Base::getDOM()\Zend_Gdata_App_Extension::getDOM()\Zend_Gdata_Extension::getDOM()

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.
methodpublicgetExtensionAttributes() : array
inherited

Returns an array of all extension attributes not transformed into data +model properties during parsing of the XML.

Inherited from: + \Zend_Gdata_App_Base::getExtensionAttributes()\Zend_Gdata_App_Extension::getExtensionAttributes()\Zend_Gdata_Extension::getExtensionAttributes()

Each element of the array +is a hashed array of the format: + array('namespaceUri' => string, 'name' => string, 'value' => string);

Returns
TypeDescription
arrayAll extension attributes
methodpublicgetExtensionElements() : array
inherited

Returns an array of all elements not matched to data model classes +during the parsing of the XML

Inherited from: + \Zend_Gdata_App_Base::getExtensionElements()\Zend_Gdata_App_Extension::getExtensionElements()\Zend_Gdata_Extension::getExtensionElements()
Returns
TypeDescription
arrayAll elements not matched to data model classes during parsing
methodpublicgetText( $trim = true) : string
inherited

Returns the child text node of this element +This represents any raw text contained within the XML element

Inherited from: + \Zend_Gdata_App_Base::getText()\Zend_Gdata_App_Extension::getText()\Zend_Gdata_Extension::getText()
Parameters
NameTypeDescription
$trim
Returns
TypeDescription
stringChild text node
methodpublicgetXML() : string
inherited

Alias for saveXML() returns XML content for this element and all +children

Inherited from: + \Zend_Gdata_App_Base::getXML()\Zend_Gdata_App_Extension::getXML()\Zend_Gdata_Extension::getXML()
Returns
TypeDescription
stringXML content
methodpubliclookupNamespace(string $prefix, integer $majorVersion = 1, integer $minorVersion = null) : string
inherited

Get the full version of a namespace prefix

Inherited from: + \Zend_Gdata_App_Base::lookupNamespace()\Zend_Gdata_App_Extension::lookupNamespace()\Zend_Gdata_Extension::lookupNamespace()

Looks up a prefix (atom:, etc.) in the list of registered +namespaces and returns the full namespace URI if +available. Returns the prefix, unmodified, if it's not +registered.

Parameters
NameTypeDescription
$prefixstring

The namespace prefix to lookup.

$majorVersioninteger

The major protocol version in effect. + Defaults to '1'.

+
$minorVersioninteger

The minor protocol version in effect. + Defaults to null (use latest).

+
Returns
TypeDescription
string
methodpublicregisterAllNamespaces(array $namespaceArray) : void
inherited

Add an array of namespaces to the registered list.

Inherited from: + \Zend_Gdata_App_Base::registerAllNamespaces()\Zend_Gdata_App_Extension::registerAllNamespaces()\Zend_Gdata_Extension::registerAllNamespaces()

Takes an array in the format of: +namespace prefix, namespace URI, major protocol version, +minor protocol version and adds them with calls to ->registerNamespace()

Parameters
NameTypeDescription
$namespaceArrayarray

An array of namespaces.

methodpublicregisterNamespace(string $prefix, string $namespaceUri, integer $majorVersion = 1, integer $minorVersion = 0) : void
inherited

Add a namespace and prefix to the registered list

Inherited from: + \Zend_Gdata_App_Base::registerNamespace()\Zend_Gdata_App_Extension::registerNamespace()\Zend_Gdata_Extension::registerNamespace()

Takes a prefix and a full namespace URI and adds them to the +list of registered namespaces for use by +$this->lookupNamespace().

+ +

WARNING: Currently, registering a namespace will NOT invalidate any + memoized data stored in $_namespaceLookupCache. Under normal + use, this behavior is acceptable. If you are adding + contradictory data to the namespace lookup table, you must + call flushNamespaceLookupCache().

Parameters
NameTypeDescription
$prefixstring

The namespace prefix

$namespaceUristring

The full namespace URI

$majorVersioninteger

The major protocol version in effect. + Defaults to '1'.

+
$minorVersioninteger

The minor protocol version in effect. + Defaults to null (use latest).

+
methodpublicsaveXML() : string
inherited

Converts this element and all children into XML text using getDOM()

Inherited from: + \Zend_Gdata_App_Base::saveXML()\Zend_Gdata_App_Extension::saveXML()\Zend_Gdata_Extension::saveXML()
Returns
TypeDescription
stringXML content
methodpublicsetExtensionAttributes(array $value) : \Zend_Gdata_App_Base
inherited

Sets an array of all extension attributes not transformed into data +model properties during parsing of the XML.

Inherited from: + \Zend_Gdata_App_Base::setExtensionAttributes()\Zend_Gdata_App_Extension::setExtensionAttributes()\Zend_Gdata_Extension::setExtensionAttributes()

Each element of the array +is a hashed array of the format: + array('namespaceUri' => string, 'name' => string, 'value' => string); +This can be used to add arbitrary attributes to any data model element

Parameters
NameTypeDescription
$valuearray

All extension attributes

Returns
TypeDescription
\Zend_Gdata_App_BaseReturns an object of the same type as 'this' to provide a fluent interface.
methodpublicsetExtensionElements(array $value) : \Zend_Gdata_App_Base
inherited

Sets an array of all elements not matched to data model classes +during the parsing of the XML.

Inherited from: + \Zend_Gdata_App_Base::setExtensionElements()\Zend_Gdata_App_Extension::setExtensionElements()\Zend_Gdata_Extension::setExtensionElements()

This method can be used to add arbitrary +child XML elements to any data model class.

Parameters
NameTypeDescription
$valuearray

All extension elements

Returns
TypeDescription
\Zend_Gdata_App_BaseReturns an object of the same type as 'this' to provide a fluent interface.
methodpublicsetText(string $value) : \Zend_Gdata_App_Base
inherited

Sets the child text node of this element +This represents any raw text contained within the XML element

Inherited from: + \Zend_Gdata_App_Base::setText()\Zend_Gdata_App_Extension::setText()\Zend_Gdata_Extension::setText()
Parameters
NameTypeDescription
$valuestring

Child text node

Returns
TypeDescription
\Zend_Gdata_App_BaseReturns an object of the same type as 'this' to provide a fluent interface.
methodprotectedtakeAttributeFromDOM(\DOMNode $attribute) : void
inherited

Given a DOMNode representing an attribute, tries to map the data into +instance members.

Inherited from: + \Zend_Gdata_App_Base::takeAttributeFromDOM()\Zend_Gdata_App_Extension::takeAttributeFromDOM()\Zend_Gdata_Extension::takeAttributeFromDOM()

If no mapping is defined, the name and value are +stored in an array.

Parameters
NameTypeDescription
$attribute\DOMNode

The DOMNode attribute needed to be handled

methodprotectedtakeChildFromDOM(\DOMNode $child) : void
inherited

Given a child DOMNode, tries to determine how to map the data into +object instance members.

Inherited from: + \Zend_Gdata_App_Base::takeChildFromDOM()\Zend_Gdata_App_Extension::takeChildFromDOM()\Zend_Gdata_Extension::takeChildFromDOM()

If no mapping is defined, Extension_Element +objects are created and stored in an array.

Parameters
NameTypeDescription
$child\DOMNode

The DOMNode needed to be handled

methodpublictransferFromDOM(\DOMNode $node) : void
inherited

Transfers each child and attribute into member variables.

Inherited from: + \Zend_Gdata_App_Base::transferFromDOM()\Zend_Gdata_App_Extension::transferFromDOM()\Zend_Gdata_Extension::transferFromDOM()

This is called when XML is received over the wire and the data +model needs to be built to represent this XML.

Parameters
NameTypeDescription
$node\DOMNode

The DOMNode that represents this object's data

+
methodpublictransferFromXML(string $xml) : void
inherited

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).

Inherited from: + \Zend_Gdata_App_Base::transferFromXML()\Zend_Gdata_App_Extension::transferFromXML()\Zend_Gdata_Extension::transferFromXML()

The first data model element with the same +name as $this->_rootElement is used and the child elements are +recursively parsed.

Parameters
NameTypeDescription
$xmlstring

The XML text to parse

+ Documentation was generated by + phpDocumentor + 2.0.0a12. + -- cgit v1.2.3