[ Index ]

PHP Cross Reference of Phabricator

title

Body

[close]

/externals/twilio-php/Services/Twilio/ -> ListResource.php (summary)

(no description)

Author: Neuman Vong [email protected]
License: http://creativecommons.org/licenses/MIT/ MIT
File Size: 203 lines (7 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 9 functions

  __construct()
  get()
  getObjectFromJson()
  delete()
  _create()
  getPage()
  count()
  getIterator()
  getPageGenerator()

Functions
Functions that are not part of a class:

__construct($client, $uri)   X-Ref
No description

get($sid)   X-Ref
Gets a resource from this list.

:param string $sid: The resource SID
:return: The resource
:rtype: :php:class:`InstanceResource <Services_Twilio_InstanceResource>`

getObjectFromJson($params, $idParam = "sid")   X-Ref
Construct an :php:class:`InstanceResource
<Services_Twilio_InstanceResource>` with the specified params.

:param array $params: usually a JSON HTTP response from the API
:return: An instance with properties
initialized to the values in the params array.
:rtype: :php:class:`InstanceResource <Services_Twilio_InstanceResource>`

delete($sid, $params = array()   X-Ref
Deletes a resource from this list.

:param string $sid: The resource SID
:rtype: null

_create($params)   X-Ref
Create a resource on the list and then return its representation as an
InstanceResource.

:param array $params: The parameters with which to create the resource

:return: The created resource
:rtype: :php:class:`InstanceResource <Services_Twilio_InstanceResource>`

getPage($page = 0, $size = 50, $filters = array()   X-Ref
Returns a page of :php:class:`InstanceResources
<Services_Twilio_InstanceResource>` from this list.

:param int    $page: The start page
:param int    $size: Number of items per page
:param array  $filters: Optional filters
:param string $deep_paging_uri: if provided, the $page and $size
parameters will be ignored and this URI will be requested directly.

:return: A page of resources
:rtype: :php:class:`Services_Twilio_Page`

count()   X-Ref
Get the total number of instances for this list.

This will make one HTTP request to retrieve the total, every time this
method is called.

If the total is not set, or an Exception was thrown, returns 0

:return: The total number of instance members
:rtype: integer

getIterator($page = 0, $size = 50, $filters = array()   X-Ref
Returns an iterable list of
:php:class:`instance resources <Services_Twilio_InstanceResource>`.

:param int   $page: The start page
:param int   $size: Number of items per page
:param array $filters: Optional filters.
The filter array can accept full datetimes when StartTime or DateCreated
are used. Inequalities should be within the key portion of the array and
multiple filter parameters can be combined for more specific searches.

.. code-block:: php

array('DateCreated>' => '2011-07-05 08:00:00', 'DateCreated<' => '2011-08-01')

.. code-block:: php

array('StartTime<' => '2011-07-05 08:00:00')

:return: An iterator
:rtype: :php:class:`Services_Twilio_AutoPagingIterator`

getPageGenerator($page, $size, $filters = array()   X-Ref
Retrieve a new page of API results, and update iterator parameters. This
function is called by the paging iterator to retrieve a new page and
shouldn't be called directly.




Generated: Sun Nov 30 09:20:46 2014 Cross-referenced by PHPXref 0.7.1