API Documentation

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

\Zend_Service_Delicious_PostList

Package: Zend\Service\Delicious

List of posts retrived from the del.icio.us web service

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

Properties

Propertyprotectedint  $_iteratorKey= '0'

Iterator key
Default value0Details
Type
int
Propertyprotectedarray  $_posts= 'array()'

Array of Zend_Service_Delicious_Post
Default valuearray()Details
Type
array
Propertyprotected\Zend_Service_Delicious  $_service= ''

Service that has downloaded the post list

Methods

methodpublic__construct( \Zend_Service_Delicious $service, \DOMNodeList|array $posts = null ) : void

Parameters
Name Type Description
$service \Zend_Service_Delicious

Service that has downloaded the post

$posts \DOMNodeList|array
methodprotected_addPost( \Zend_Service_Delicious_SimplePost $post ) : \Zend_Service_Delicious_PostList

Add a post

Parameters
Name Type Description
$post \Zend_Service_Delicious_SimplePost
Returns
Type Description
\Zend_Service_Delicious_PostList
methodprivate_constructFromArray( array $postList ) : void

Transforms the Array to array of posts

Parameters
Name Type Description
$postList array
methodprivate_constructFromNodeList( \DOMNodeList $nodeList ) : void

Transforms DOMNodeList to array of posts

Parameters
Name Type Description
$nodeList \DOMNodeList
methodpubliccount( ) : int

Return number of posts

Implement Countable::count()

Returns
Type Description
int
methodpubliccurrent( ) : \Zend_Service_Delicious_SimplePost

Return the current element

Implement Iterator::current()

Returns
Type Description
\Zend_Service_Delicious_SimplePost
methodpublickey( ) : int

Return the key of the current element

Implement Iterator::key()

Returns
Type Description
int
methodpublicnext( ) : void

Move forward to next element

Implement Iterator::next()

methodpublicoffsetExists( int $offset ) : bool

Whether the offset exists

Implement ArrayAccess::offsetExists()

Parameters
Name Type Description
$offset int
Returns
Type Description
bool
methodpublicoffsetGet( int $offset ) : \Zend_Service_Delicious_SimplePost

Return value at given offset

Implement ArrayAccess::offsetGet()

Parameters
Name Type Description
$offset int
Returns
Type Description
\Zend_Service_Delicious_SimplePost
Throws
Exception Description
\OutOfBoundsException
methodpublicoffsetSet( int $offset, string $value ) : void

Throws exception because all values are read-only

Implement ArrayAccess::offsetSet()

Parameters
Name Type Description
$offset int
$value string
Throws
Exception Description
\Zend_Service_Delicious_Exception
methodpublicoffsetUnset( int $offset ) : void

Throws exception because all values are read-only

Implement ArrayAccess::offsetUnset()

Parameters
Name Type Description
$offset int
Throws
Exception Description
\Zend_Service_Delicious_Exception
methodpublicrewind( ) : void

Rewind the Iterator to the first element

Implement Iterator::rewind()

methodpublicvalid( ) : bool

Check if there is a current element after calls to rewind() or next()

Implement Iterator::valid()

Returns
Type Description
bool
methodpublicwithTag( string $tag ) : \Zend_Service_Delicious_PostList

Filter list by tag

Parameters
Name Type Description
$tag string
Returns
Type Description
\Zend_Service_Delicious_PostList
methodpublicwithTags( array $tags ) : \Zend_Service_Delicious_PostList

Filter list by list of tags

Parameters
Name Type Description
$tags array
Returns
Type Description
\Zend_Service_Delicious_PostList
methodpublicwithUrl( string $regexp ) : \Zend_Service_Delicious_PostList

Filter list by urls matching a regular expression

Parameters
Name Type Description
$regexp string
Returns
Type Description
\Zend_Service_Delicious_PostList
Documentation was generated by DocBlox 0.15.1.