Gdata/Analytics/Extension/Dimension.php

+ Show: +

inherited

+ Classes +
- \Zend_Gdata_Analytics_Extension_Dimension

+ 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: Analytics + +
Version: $Id$ + +

\Zend_Gdata_Analytics_Extension_Dimension
jump to top

Package: Zend\Gdata\Analytics

Represents a Gdata extension

Parent(s): \Zend_Gdata_Analytics_Extension_Metric + < + \Zend_Gdata_Analytics_Extension_Property + < + \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) + +

Properties

array $_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 \Zend_Gdata_Analytics_Extension_Property::$$_extensionAttributes \Zend_Gdata_Analytics_Extension_Metric::$$_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 + +
Inherited_from: \Zend_Gdata_Analytics_Extension_Property::$$_extensionAttributes + +
Inherited_from: \Zend_Gdata_Analytics_Extension_Metric::$$_extensionAttributes + +

array $_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 \Zend_Gdata_Analytics_Extension_Property::$$_extensionElements \Zend_Gdata_Analytics_Extension_Metric::$$_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 + +
Inherited_from: \Zend_Gdata_Analytics_Extension_Property::$$_extensionElements + +
Inherited_from: \Zend_Gdata_Analytics_Extension_Metric::$$_extensionElements + +

$_name = null

Default valuenullDetails

Type: n/a

array $_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 \Zend_Gdata_Analytics_Extension_Property::$$_namespaceLookupCache \Zend_Gdata_Analytics_Extension_Metric::$$_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 + +
Inherited_from: \Zend_Gdata_Analytics_Extension_Property::$$_namespaceLookupCache + +
Inherited_from: \Zend_Gdata_Analytics_Extension_Metric::$$_namespaceLookupCache + +

array $_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 \Zend_Gdata_Analytics_Extension_Property::$$_namespaces \Zend_Gdata_Analytics_Extension_Metric::$$_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 value

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

Details

Type: array
Inherited_from: \Zend_Gdata_App_Base::$$_namespaces + +
Inherited_from: \Zend_Gdata_App_Extension::$$_namespaces + +
Inherited_from: \Zend_Gdata_Extension::$$_namespaces + +
Inherited_from: \Zend_Gdata_Analytics_Extension_Property::$$_namespaces + +
Inherited_from: \Zend_Gdata_Analytics_Extension_Metric::$$_namespaces + +
See: \lookupNamespace() + +
See: \registerNamespace() + +
See: \registerAllNamespaces() + +

string $_rootElement = 'dimension'

The XML element name, including prefix if desired

Default value'dimension'Details

Type: string

string $_rootNamespace = 'ga'

The XML namespace prefix

Default value'ga'Details

Type: string

string $_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 \Zend_Gdata_Analytics_Extension_Property::$$_rootNamespaceURI \Zend_Gdata_Analytics_Extension_Metric::$$_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 + +
Inherited_from: \Zend_Gdata_Analytics_Extension_Property::$$_rootNamespaceURI + +
Inherited_from: \Zend_Gdata_Analytics_Extension_Metric::$$_rootNamespaceURI + +

string $_text = null

inherited

XML child text node content

Inherited from: + \Zend_Gdata_App_Base::$$_text \Zend_Gdata_App_Extension::$$_text \Zend_Gdata_Extension::$$_text \Zend_Gdata_Analytics_Extension_Property::$$_text \Zend_Gdata_Analytics_Extension_Metric::$$_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 + +
Inherited_from: \Zend_Gdata_Analytics_Extension_Property::$$_text + +
Inherited_from: \Zend_Gdata_Analytics_Extension_Metric::$$_text + +

$_value = null

Default valuenullDetails

Type: n/a

Methods

__construct(string $value = null, $name = null) : void

inherited

Constructs a new Zend_Gdata_Calendar_Extension_Timezone object.

Inherited from: + \Zend_Gdata_Analytics_Extension_Property::__construct()\Zend_Gdata_Analytics_Extension_Metric::__construct()

Parameters

Name	Type	Description
$value	string	(optional) The text content of the element. +
$name

__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()\Zend_Gdata_Analytics_Extension_Property::__get()\Zend_Gdata_Analytics_Extension_Metric::__get()

TODO Remove ability to bypass getFoo() methods??

Parameters

Name	Type	Description
$name	string	The variable name sought

__isset(string $name) : void

inherited

Magic __isset method

Inherited from: + \Zend_Gdata_App_Base::__isset()\Zend_Gdata_App_Extension::__isset()\Zend_Gdata_Extension::__isset()\Zend_Gdata_Analytics_Extension_Property::__isset()\Zend_Gdata_Analytics_Extension_Metric::__isset()

Parameters

Name	Type	Description
$name	string

__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()\Zend_Gdata_Analytics_Extension_Property::__set()\Zend_Gdata_Analytics_Extension_Metric::__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

Name	Type	Description
$name	string
$val

__toString() : string

inherited

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

Inherited from: + \Zend_Gdata_Analytics_Extension_Property::__toString()\Zend_Gdata_Analytics_Extension_Metric::__toString()

Returns

Type	Description
string	The text representation of this object

__unset(string $name) : void

inherited

Magic __unset method

Inherited from: + \Zend_Gdata_App_Base::__unset()\Zend_Gdata_App_Extension::__unset()\Zend_Gdata_Extension::__unset()\Zend_Gdata_Analytics_Extension_Property::__unset()\Zend_Gdata_Analytics_Extension_Metric::__unset()

Parameters

Name	Type	Description
$name	string

encode() : string

inherited

Alias for saveXML()

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

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

Returns

Type	Description
string	Encoded string content

flushNamespaceLookupCache() : void

staticinherited

Flush namespace lookup cache.

Inherited from: + \Zend_Gdata_App_Base::flushNamespaceLookupCache()\Zend_Gdata_App_Extension::flushNamespaceLookupCache()\Zend_Gdata_Extension::flushNamespaceLookupCache()\Zend_Gdata_Analytics_Extension_Property::flushNamespaceLookupCache()\Zend_Gdata_Analytics_Extension_Metric::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().

getDOM(\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()\Zend_Gdata_Analytics_Extension_Property::getDOM()\Zend_Gdata_Analytics_Extension_Metric::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

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.

getExtensionAttributes() : 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()\Zend_Gdata_Analytics_Extension_Property::getExtensionAttributes()\Zend_Gdata_Analytics_Extension_Metric::getExtensionAttributes()

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

Returns

Type	Description
array	All extension attributes

getExtensionElements() : 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()\Zend_Gdata_Analytics_Extension_Property::getExtensionElements()\Zend_Gdata_Analytics_Extension_Metric::getExtensionElements()

Returns

Type	Description
array	All elements not matched to data model classes during parsing

getName() : string

inherited

Inherited from: + \Zend_Gdata_Analytics_Extension_Property::getName()\Zend_Gdata_Analytics_Extension_Metric::getName()

Returns

Type	Description
string

getText( $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()\Zend_Gdata_Analytics_Extension_Property::getText()\Zend_Gdata_Analytics_Extension_Metric::getText()

Parameters

Name	Type	Description
$trim

Returns

Type	Description
string	Child text node

getValue() : string

inherited

Get the value for this element's value attribute.

Inherited from: + \Zend_Gdata_Analytics_Extension_Property::getValue()\Zend_Gdata_Analytics_Extension_Metric::getValue()

Returns

Type	Description
string	The value associated with this attribute.

getXML() : 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()\Zend_Gdata_Analytics_Extension_Property::getXML()\Zend_Gdata_Analytics_Extension_Metric::getXML()

Returns

Type	Description
string	XML content

lookupNamespace(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()\Zend_Gdata_Analytics_Extension_Property::lookupNamespace()\Zend_Gdata_Analytics_Extension_Metric::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

Name	Type	Description
$prefix	string	The namespace prefix to lookup.
$majorVersion	integer	The major protocol version in effect. + Defaults to '1'. +
$minorVersion	integer	The minor protocol version in effect. + Defaults to null (use latest). +

Returns

Type	Description
string

registerAllNamespaces(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()\Zend_Gdata_Analytics_Extension_Property::registerAllNamespaces()\Zend_Gdata_Analytics_Extension_Metric::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

Name	Type	Description
$namespaceArray	array	An array of namespaces.

registerNamespace(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()\Zend_Gdata_Analytics_Extension_Property::registerNamespace()\Zend_Gdata_Analytics_Extension_Metric::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

Name	Type	Description
$prefix	string	The namespace prefix
$namespaceUri	string	The full namespace URI
$majorVersion	integer	The major protocol version in effect. + Defaults to '1'. +
$minorVersion	integer	The minor protocol version in effect. + Defaults to null (use latest). +

saveXML() : 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()\Zend_Gdata_Analytics_Extension_Property::saveXML()\Zend_Gdata_Analytics_Extension_Metric::saveXML()

Returns

Type	Description
string	XML content

setExtensionAttributes(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()\Zend_Gdata_Analytics_Extension_Property::setExtensionAttributes()\Zend_Gdata_Analytics_Extension_Metric::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

Name	Type	Description
$value	array	All extension attributes

Returns

Type	Description
\Zend_Gdata_App_Base	Returns an object of the same type as 'this' to provide a fluent interface.

setExtensionElements(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()\Zend_Gdata_Analytics_Extension_Property::setExtensionElements()\Zend_Gdata_Analytics_Extension_Metric::setExtensionElements()

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

Parameters

Name	Type	Description
$value	array	All extension elements

Returns

Type	Description
\Zend_Gdata_App_Base	Returns an object of the same type as 'this' to provide a fluent interface.

setName(string $name) : \Zend_Gdata_Analytics_Extension_Property

inherited

Inherited from: + \Zend_Gdata_Analytics_Extension_Property::setName()\Zend_Gdata_Analytics_Extension_Metric::setName()

Parameters

Name	Type	Description
$name	string

Returns

Type	Description
\Zend_Gdata_Analytics_Extension_Property

setText(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()\Zend_Gdata_Analytics_Extension_Property::setText()\Zend_Gdata_Analytics_Extension_Metric::setText()

Parameters

Name	Type	Description
$value	string	Child text node

Returns

Type	Description
\Zend_Gdata_App_Base	Returns an object of the same type as 'this' to provide a fluent interface.

setValue(string $value) : \Zend_Gdata_Analytics_Extension_Property

inherited

Set the value for this element's value attribute.

Inherited from: + \Zend_Gdata_Analytics_Extension_Property::setValue()\Zend_Gdata_Analytics_Extension_Metric::setValue()

Parameters

Name	Type	Description
$value	string	The desired value for this attribute.

Returns

Type	Description
\Zend_Gdata_Analytics_Extension_Property	The element being modified.

takeAttributeFromDOM(\DOMNode $attribute) : void

inherited

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

Inherited from: + \Zend_Gdata_Analytics_Extension_Metric::takeAttributeFromDOM()

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

Parameters

Name	Type	Description
$attribute	\DOMNode	The DOMNode attribute needed to be handled

takeChildFromDOM(\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()\Zend_Gdata_Analytics_Extension_Property::takeChildFromDOM()\Zend_Gdata_Analytics_Extension_Metric::takeChildFromDOM()

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

Parameters

Name	Type	Description
$child	\DOMNode	The DOMNode needed to be handled

transferFromDOM(\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()\Zend_Gdata_Analytics_Extension_Property::transferFromDOM()\Zend_Gdata_Analytics_Extension_Metric::transferFromDOM()

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

Parameters

Name	Type	Description
$node	\DOMNode	The DOMNode that represents this object's data +

transferFromXML(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()\Zend_Gdata_Analytics_Extension_Property::transferFromXML()\Zend_Gdata_Analytics_Extension_Metric::transferFromXML()

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

Parameters

Name	Type	Description
$xml	string	The XML text to parse

Gdata/Analytics/Extension/Dimension.php

\Zend_Gdata_Analytics_Extension_Dimensionjump to top

Properties

Methods

\Zend_Gdata_Analytics_Extension_Dimension
jump to top