Class ViewFeed

Controller for viewing news feeds

ViewFeed implements AlphaControllerInterface

Package: alpha::controller
Copyright: Copyright (c) 2012, John Collins (founder of Alpha Framework). All rights reserved.

Redistribution and use in source and binary forms, with or
without modification, are permitted provided that the
following conditions are met:

* Redistributions of source code must retain the above
  copyright notice, this list of conditions and the
  following disclaimer.
* Redistributions in binary form must reproduce the above
  copyright notice, this list of conditions and the
  following disclaimer in the documentation and/or other
  materials provided with the distribution.
* Neither the name of the Alpha Framework nor the names
  of its contributors may be used to endorse or promote
  products derived from this software without specific
  prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

License: The BSD License
Author: John Collins <dev@alphaframework.org>
Version: $Id: ViewFeed.php 1624 2012-12-21 12:17:55Z alphadevx $
Since: 1.0
Located at controller/ViewFeed.php

Methods summary
`public`	# `__construct( )` constructor to set up the object constructor to set up the object Since 1.0 Overrides `AlphaController::__construct()`
`public`	# `doGET( array $params )` Handle GET requests Handle GET requests Parameters `$params` `array` $params Throws `ResourceNotFoundException` Since 1.0 Implementation of `AlphaControllerInterface::doGET()`
`public`	# `doPOST( array $params )` Method to handle POST requests Method to handle POST requests Parameters `$params` `array` $params Since 1.0 Implementation of `AlphaControllerInterface::doPOST()`
`protected`	# `setup( )` setup the feed title, field mappings and description based on common BO types setup the feed title, field mappings and description based on common BO types

Methods inherited from AlphaController
abort(), accessError(), checkControllerDefExists(), checkIfAccessingFromSecureURL(), checkRights(), checkSecurityFields(), commit(), generateSecurityFields(), getBO(), getCustomControllerName(), getDescription(), getDirtyObjects(), getEndTime(), getFirstJob(), getKeywords(), getLastJob(), getMAXDuration(), getName(), getNewObjects(), getNextJob(), getPreviousJob(), getStartTime(), getStatusMessage(), getTitle(), getUnitDuration(), getVisibility(), loadControllerDef(), loadCustomController(), markDirty(), markNew(), setBO(), setDescription(), setKeywords(), setName(), setStatusMessage(), setTitle(), setUnitEndTime(), setUnitMAXDuration(), setUnitOfWork(), setUnitStartTime(), setVisibility()

Properties summary
`private string`	`$BOName`		# The name of the BO to render as a feed The name of the BO to render as a feed Since 1.0
`private string`	`$type`		# The type of feed to render (RSS, RSS2 or Atom) The type of feed to render (RSS, RSS2 or Atom) Since 1.0
`protected string`	`$title`		# The title of the feed The title of the feed Since 1.0
`protected string`	`$description`		# The description of the feed The description of the feed Since 1.0
`protected array`	`$fieldMappings`		# The BO to feed field mappings The BO to feed field mappings Since 1.0
`private string`	`$sortBy`	`'OID'`	# The BO field name to sort the feed by (descending), default is OID The BO field name to sort the feed by (descending), default is OID Since 1.0
`private static Logger`	`$logger`	`null`	# Trace logger Trace logger Since 1.0

Properties inherited from AlphaController
`$BO, $dirtyObjects, $firstJob, $keywords, $lastJob, $name, $newObjects, $nextJob, $previousJob, $statusMessage, $unitEndTime, $unitMAXDuration, $unitOfWork, $unitStartTime, $visibility`

Packages

Classes

Interfaces

Class ViewFeed

Since

Overrides

Parameters

Throws

Since

Implementation of

Parameters

Since

Implementation of

Since

Since

Since

Since

Since

Since

Since