API Documentation

Zend/Service/Simpy/Watchlist.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 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_Service  
Subpackage
Simpy  
Version
$Id: Watchlist.php 24594 2012-01-05 21:27:01Z matthew $  

\Zend_Service_Simpy_Watchlist

Package: Zend\Service\Simpy

Category
Zend  
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  

Properties

Propertyprotectedstring  $_addDate= ''

Timestamp for when the watchlist was added

Details
Type
string
Propertyprotectedstring  $_description= ''

Description of the watchlist

Details
Type
string
Propertyprotected\Zend_Service_Simpy_WatchlistFilterSet  $_filters= ''

List of filters included in the watchlist

Propertyprotectedint  $_id= ''

Identifier for the watchlist

Details
Type
int
Propertyprotectedstring  $_name= ''

Name of the watchlist

Details
Type
string
Propertyprotectedint  $_newLinks= ''

Number of new links in the watchlist

Details
Type
int
Propertyprotectedarray  $_users= ''

List of usernames for users included in the watchlist

Details
Type
array

Methods

methodpublic__construct( \DOMNode $node ) : void

Constructor to initialize the object with data

Parameters
Name Type Description
$node \DOMNode

Individual node from a parsed response from a GetWatchlists or GetWatchlist operation

methodpublicgetAddDate( ) : string

Returns a timestamp for when the watchlist was added

Returns
Type Description
string
methodpublicgetDescription( ) : string

Returns the description of the watchlist

Returns
Type Description
string
methodpublicgetFilters( ) : \Zend_Service_Simpy_WatchlistFilterSet

Returns a list of filters included in the watchlist

Returns
Type Description
\Zend_Service_Simpy_WatchlistFilterSet
methodpublicgetId( ) : int

Returns the identifier for the watchlist

Returns
Type Description
int
methodpublicgetName( ) : string

Returns the name of the watchlist

Returns
Type Description
string
methodpublicgetNewLinks( ) : int

Returns the number of new links in the watchlist

Returns
Type Description
int
methodpublicgetUsers( ) : array

Returns a list of usernames for users included in the watchlist

Returns
Type Description
array
Documentation was generated by DocBlox 0.15.1.