Gdata/Exif/Extension/Tags.php

Show: inherited
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 [email protected] 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
Exif  
Version
$Id: Tags.php 24593 2012-01-05 20:35:02Z matthew $  

\Zend_Gdata_Exif_Extension_Tags

Package: Zend\Gdata\Exif

Represents the exif:tags element used by the Gdata Exif extensions.

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

Propertyprotected\Zend_Gdata_Exif_Extension_Distance $_distance = null

exif:distance value

Default valuenullDetails
Type
\Zend_Gdata_Exif_Extension_Distance
Propertyprotected\Zend_Gdata_Exif_Extension_Exposure $_exposure = null

exif:exposure value

Default valuenullDetails
Type
\Zend_Gdata_Exif_Extension_Exposure
Propertyprotectedarray $_extensionAttributes = array()
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  
Propertyprotectedarray $_extensionElements = array()
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  
Propertyprotected\Zend_Gdata_Exif_Extension_FStop $_fStop = null

exif:fStop value

Default valuenullDetails
Type
\Zend_Gdata_Exif_Extension_FStop
Propertyprotected\Zend_Gdata_Exif_Extension_Flash $_flash = null

exif:flash value

Default valuenullDetails
Type
\Zend_Gdata_Exif_Extension_Flash
Propertyprotected\Zend_Gdata_Exif_Extension_FocalLength $_focalLength = null

exif:focalLength value

Default valuenullDetails
Type
\Zend_Gdata_Exif_Extension_FocalLength
Propertyprotected\Zend_Gdata_Exif_Extension_ImageUniqueId $_imageUniqueId = null

exif:imageUniqueID value

Default valuenullDetails
Type
\Zend_Gdata_Exif_Extension_ImageUniqueId
Propertyprotected\Zend_Gdata_Exif_Extension_Iso $_iso = null

exif:iso value

Default valuenullDetails
Type
\Zend_Gdata_Exif_Extension_Iso
Propertyprotected\Zend_Gdata_Exif_Extension_Make $_make = null

exif:make value

Default valuenullDetails
Type
\Zend_Gdata_Exif_Extension_Make
Propertyprotected\Zend_Gdata_Exif_Extension_Model $_model = null

exif:model value

Default valuenullDetails
Type
\Zend_Gdata_Exif_Extension_Model
Propertyprotectedarray $_namespaceLookupCache = array()
staticinherited<p>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().</p>

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  
Propertyprotectedarray $_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
\global\lookupNamespace()  
See
\global\registerNamespace()  
See
\global\registerAllNamespaces()  
Propertyprotectedstring $_rootElement = 'tags'

<p>The XML element name, including prefix if desired</p>
Default value'tags'Details
Type
string
Propertyprotectedstring $_rootNamespace = 'exif'

<p>The XML namespace prefix</p>
Default value'exif'Details
Type
string
Propertyprotectedstring $_rootNamespaceURI = null
inherited<p>The XML namespace URI - takes precedence over lookup up the corresponding URI for $_rootNamespace</p>

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  
Propertyprotectedstring $_text = null
inherited<p>XML child text node content</p>

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  
Propertyprotected\Zend_Gdata_Exif_Extension_Time $_time = null

exif:time value

Default valuenullDetails
Type
\Zend_Gdata_Exif_Extension_Time

Methods

methodpublic__construct(\Zend_Gdata_Exif_Extension_Distance $distance = null, \Zend_Gdata_Exif_Extension_Exposure $exposure = null, \Zend_Gdata_Exif_Extension_Flash $flash = null, \Zend_Gdata_Exif_Extension_FocalLength$focalLength $focalLength = null, \Zend_Gdata_Exif_Extension_FStop $fStop = null, \Zend_Gdata_Exif_Extension_ImageUniqueId $imageUniqueId = null, \Zend_Gdata_Exif_Extension_Iso $iso = null, \Zend_Gdata_Exif_Extension_Make $make = null, \Zend_Gdata_Exif_Extension_Model $model = null, \Zend_Gdata_Exif_Extension_Time $time = null) : void

Constructs a new Zend_Gdata_Exif_Extension_Tags object.

Parameters
Name Type Description
$distance \Zend_Gdata_Exif_Extension_Distance

(optional) The exif:distance value to be set in the constructed object.

$exposure \Zend_Gdata_Exif_Extension_Exposure

(optional) The exif:exposure value to be set in the constructed object.

$flash \Zend_Gdata_Exif_Extension_Flash

(optional) The exif:flash value to be set in the constructed object.

$focalLength \Zend_Gdata_Exif_Extension_FocalLength$focalLength

(optional) The exif:focallength value to be set in the constructed object.

$fStop \Zend_Gdata_Exif_Extension_FStop

(optional) The exif:fstop value to be set in the constructed object.

$imageUniqueId \Zend_Gdata_Exif_Extension_ImageUniqueId

(optional) The exif:imageUniqueID value to be set in the constructed object.

$iso \Zend_Gdata_Exif_Extension_Iso

(optional) The exif:iso value to be set in the constructed object.

$make \Zend_Gdata_Exif_Extension_Make

(optional) The exif:make value to be set in the constructed object.

$model \Zend_Gdata_Exif_Extension_Model

(optional) The exif:model value to be set in the constructed object.

$time \Zend_Gdata_Exif_Extension_Time

(optional) The exif:time value to be set in the constructed object.

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
Name Type Description
$name string

The variable name sought

methodpublic__isset(string $name) : void
Parameters
Name Type Description
$name string
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
Name Type Description
$name string
$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
Type Description
string The text representation of this object
methodpublic__unset(string $name) : void
Parameters
Name Type Description
$name string
methodpublicencode() : string

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

Returns
Type Description
string Encoded string content
methodpublicflushNamespaceLookupCache() : void

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

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 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.
methodpublicgetDistance() : \Zend_Gdata_Exif_Extension_Distance

Get the value for this element's distance attribute.

Returns
Type Description
\Zend_Gdata_Exif_Extension_Distance The requested attribute.
Details
See
\global\setDistance  
methodpublicgetExposure() : \Zend_Gdata_Exif_Extension_Exposure

Get the value for this element's exposure attribute.

Returns
Type Description
\Zend_Gdata_Exif_Extension_Exposure The requested attribute.
Details
See
\global\setExposure  
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
Type Description
array All 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
Type Description
array All elements not matched to data model classes during parsing
methodpublicgetFStop() : \Zend_Gdata_Exif_Extension_FStop

Get the value for this element's fStop attribute.

Returns
Type Description
\Zend_Gdata_Exif_Extension_FStop The requested attribute.
Details
See
\global\setFStop  
methodpublicgetFlash() : \Zend_Gdata_Exif_Extension_Flash

Get the value for this element's flash attribute.

Returns
Type Description
\Zend_Gdata_Exif_Extension_Flash The requested attribute.
Details
See
\global\setFlash  
methodpublicgetFocalLength() : \Zend_Gdata_Exif_Extension_FocalLength

Get the value for this element's name attribute.

Returns
Type Description
\Zend_Gdata_Exif_Extension_FocalLength The requested attribute.
Details
See
\global\setFocalLength  
methodpublicgetImageUniqueId() : \Zend_Gdata_Exif_Extension_ImageUniqueId

Get the value for this element's imageUniqueId attribute.

Returns
Type Description
\Zend_Gdata_Exif_Extension_ImageUniqueId The requested attribute.
Details
See
\global\setImageUniqueId  
methodpublicgetIso() : \Zend_Gdata_Exif_Extension_Iso

Get the value for this element's iso attribute.

Returns
Type Description
\Zend_Gdata_Exif_Extension_Iso The requested attribute.
Details
See
\global\setIso  
methodpublicgetMake() : \Zend_Gdata_Exif_Extension_Make

Get the value for this element's make attribute.

Returns
Type Description
\Zend_Gdata_Exif_Extension_Make The requested attribute.
Details
See
\global\setMake  
methodpublicgetModel() : \Zend_Gdata_Exif_Extension_Model

Get the value for this element's model attribute.

Returns
Type Description
\Zend_Gdata_Exif_Extension_Model The requested attribute.
Details
See
\global\setModel  
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
Name Type Description
$trim
Returns
Type Description
string Child text node
methodpublicgetTime() : \Zend_Gdata_Exif_Extension_Time

Get the value for this element's time attribute.

Returns
Type Description
\Zend_Gdata_Exif_Extension_Time The requested attribute.
Details
See
\global\setTime  
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
Type Description
string XML content
methodpubliclookupNamespace(string $prefix, integer $majorVersion = 1, integer $minorVersion = null) : string

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
methodpublicregisterAllNamespaces(array $namespaceArray) : void

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.

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

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

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
Type Description
string XML content
methodpublicsetDistance(\Zend_Gdata_Exif_Extension_Distance $value) : \Zend_Gdata_Exif_Extension_Tags

Set the value for this element's distance attribute.

Parameters
Name Type Description
$value \Zend_Gdata_Exif_Extension_Distance

The desired value for this attribute.

Returns
Type Description
\Zend_Gdata_Exif_Extension_Tags Provides a fluent interface
methodpublicsetExposure(\Zend_Gdata_Exif_Extension_Exposure $value) : \Zend_Gdata_Exif_Extension_Tags

Set the value for this element's exposure attribute.

Parameters
Name Type Description
$value \Zend_Gdata_Exif_Extension_Exposure

The desired value for this attribute.

Returns
Type Description
\Zend_Gdata_Exif_Extension_Tags Provides a fluent interface
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
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.
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
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.
methodpublicsetFStop(\Zend_Gdata_Exif_Extension_FStop $value) : \Zend_Gdata_Exif_Extension_Tags

Set the value for this element's fStop attribute.

Parameters
Name Type Description
$value \Zend_Gdata_Exif_Extension_FStop

The desired value for this attribute.

Returns
Type Description
\Zend_Gdata_Exif_Extension_Tags Provides a fluent interface
methodpublicsetFlash(\Zend_Gdata_Exif_Extension_Flash $value) : \Zend_Gdata_Exif_Extension_Tags

Set the value for this element's flash attribute.

Parameters
Name Type Description
$value \Zend_Gdata_Exif_Extension_Flash

The desired value for this attribute.

Returns
Type Description
\Zend_Gdata_Exif_Extension_Tags Provides a fluent interface
methodpublicsetFocalLength(\Zend_Gdata_Exif_Extension_FocalLength $value) : \Zend_Gdata_Exif_Extension_Tags

Set the value for this element's focalLength attribute.

Parameters
Name Type Description
$value \Zend_Gdata_Exif_Extension_FocalLength

The desired value for this attribute.

Returns
Type Description
\Zend_Gdata_Exif_Extension_Tags Provides a fluent interface
methodpublicsetImageUniqueId(\Zend_Gdata_Exif_Extension_ImageUniqueId $value) : \Zend_Gdata_Exif_Extension_Tags

Set the value for this element's imageUniqueId attribute.

Parameters
Name Type Description
$value \Zend_Gdata_Exif_Extension_ImageUniqueId

The desired value for this attribute.

Returns
Type Description
\Zend_Gdata_Exif_Extension_Tags Provides a fluent interface
methodpublicsetIso(\Zend_Gdata_Exif_Extension_Iso $value) : \Zend_Gdata_Exif_Extension_Tags

Set the value for this element's iso attribute.

Parameters
Name Type Description
$value \Zend_Gdata_Exif_Extension_Iso

The desired value for this attribute.

Returns
Type Description
\Zend_Gdata_Exif_Extension_Tags Provides a fluent interface
methodpublicsetMake(\Zend_Gdata_Exif_Extension_Make $value) : \Zend_Gdata_Exif_Extension_Tags

Set the value for this element's make attribute.

Parameters
Name Type Description
$value \Zend_Gdata_Exif_Extension_Make

The desired value for this attribute.

Returns
Type Description
\Zend_Gdata_Exif_Extension_Tags Provides a fluent interface
methodpublicsetModel(\Zend_Gdata_Exif_Extension_Model $value) : \Zend_Gdata_Exif_Extension_Tags

Set the value for this element's model attribute.

Parameters
Name Type Description
$value \Zend_Gdata_Exif_Extension_Model

The desired value for this attribute.

Returns
Type Description
\Zend_Gdata_Exif_Extension_Tags Provides 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
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.
methodpublicsetTime(\Zend_Gdata_Exif_Extension_Time $value) : \Zend_Gdata_Exif_Extension_Tags

Set the value for this element's time attribute.

Parameters
Name Type Description
$value \Zend_Gdata_Exif_Extension_Time

The desired value for this attribute.

Returns
Type Description
\Zend_Gdata_Exif_Extension_Tags Provides 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
Name Type Description
$attribute \DOMNode

The DOMNode attribute needed to be handled

methodprotectedtakeChildFromDOM(\DOMNode $child) : void

Creates individual Entry objects of the appropriate type and stores them as members of this entry based upon DOM data.

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

Parameters
Name Type Description
$child \DOMNode

The DOMNode to process

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
Name Type Description
$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
Name Type Description
$xml string

The XML text to parse

Documentation was generated by phpDocumentor 2.0.0a8.