oshyvesapilibphp5
[ class tree: oshyvesapilibphp5 ] [ index: oshyvesapilibphp5 ] [ all elements ]

Class: HA_COL

Source Location: /HA.php

Class Overview

HA_ERRORS
   |
   --HA_COL

A collection of HA_CALL objects.


Constants

Methods


Inherited Constants

Inherited Variables

Inherited Methods

Class: HA_ERRORS

HA_ERRORS::addError()
Add an error array
HA_ERRORS::errorCodeToErrorMessage()
Helper for converting error codes within the ERROR_SCOPE_LIBRARY scope to an error message.
HA_ERRORS::getErrors()
Returns an array of error arrays
HA_ERRORS::getLastError()
Returns the last error array or FALSE
HA_ERRORS::hasErrors()
Return TRUE if the object has errors, else FALSE
HA_ERRORS::log()
Log the errors if a log file isset.
HA_ERRORS::nrOfErrors()
Returns the numer of errors

Class Details

[line 1434]
A collection of HA_CALL objects.



[ Top ]


Class Methods


constructor __construct [line 1451]

HA_COL __construct( )



Tags:

access:  public


[ Top ]

method addCall [line 1541]

bool addCall( HA_CALL $object)

Add a HA_CALL object for batching



Tags:

return:  TRUE if the HA_CALL object is added, else FALSE
access:  public


Parameters:

HA_CALL   $object  

[ Top ]

method execute [line 1558]

HA_CALL|bool execute( [constant $batch_mode = self::BATCH_MODE_CURL])

Execute batch.



Tags:

access:  public


Parameters:

constant   $batch_mode   Constant of HA_COL::BATCH_*

[ Top ]

method getCallByIndex [line 1465]

HA_CALL|bool getCallByIndex( int $index)

Get a HA_CALL object by index, starting at 0



Tags:

access:  public


Parameters:

int   $index  

[ Top ]

method getCalls [line 1522]

array getCalls( )

Get an array of HA_CALL objects.



Tags:

access:  public


[ Top ]

method getCallsByTag [line 1479]

array getCallsByTag( string|array $tag,...)

Get calls by tag.



Tags:

return:  Return an array of HA_CALL objects.
access:  public


Parameters:

string|array   $tag,...  

[ Top ]

method nrOfCalls [line 1531]

integer nrOfCalls( )

Returns the number of HA_CALL objects in the batch



Tags:

return:  Numer of HA_CALL objects in the batch
access:  public


[ Top ]


Class Constants

BATCH_CURL =  "curl"

[line 1445]

Batch method constant for using cURL multi


[ Top ]

BATCH_HYVES =  "hyves"

[line 1449]

Batch method constant for using Hyves API method 'batch.execute'


[ Top ]



Documentation generated on Sat, 10 Jan 2009 01:27:20 +0100 by phpDocumentor 1.4.1