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

Class: Application_PingService

Source Location: /application_classes/pingservice.class.php

Class Overview




Variables

Methods



Class Details

[line 38]


[ Top ]


Class Variables

static $instance =  null

[line 45]

Singleton



Tags:

access:  public

Type:   object


[ Top ]

$base =  null

[line 52]

Reference to base class



Tags:

access:  public

Type:   object


[ Top ]



Class Methods


constructor __construct [line 59]

Application_PingService __construct( )

Start instance of base class, load configuration and establish database connection. Please don't call the constructor direcly, use the singleton pattern instead.



Tags:

access:  public


[ Top ]

method addPingService [line 85]

int addPingService( array $sqlData)

Adds ping service to the ping service table. Takes a field=>value array with ping service data as first argument. Returns insert id.



Tags:

return:  Insert id
throws:  Application_PingServiceException
access:  public


Parameters:

array   $sqlData   Row data

[ Top ]

method countPingServices [line 334]

array countPingServices( [array $params = array()])

Method to count the available ping services. Takes key=>value array with count params as first argument. Returns array.

List of supported params:

No params supported.




Tags:

throws:  Application_PingServiceException
access:  public


Parameters:

array   $params   Count params

[ Top ]

method deletePingService [line 163]

int deletePingService( int $id)

Removes ping service from the ping services table. Takes the ping service id as first argument. Returns amount of affected rows.



Tags:

return:  Amount of affected rows
throws:  Application_PingServiceException
access:  public


Parameters:

int   $id   Ping service id

[ Top ]

method pingService [line 446]

bool pingService( int $configuration_id)

Notifies ping service. Takes the id of the ping service configuration to use as first argument. Returns true.



Tags:

throws:  Application_PingServiceException
access:  public


Parameters:

int   $configuration_id   Ping service configuration id

[ Top ]

method pingServiceBelongsToCurrentProject [line 528]

int pingServiceBelongsToCurrentProject( int $ping_service)

Tests whether given ping service belongs to current project. Takes the ping service id as first argument. Returns bool.



Tags:

return:  bool
throws:  Application_PingServiceException
access:  public


Parameters:

int   $ping_service   Ping service id

[ Top ]

method pingServiceBelongsToCurrentUser [line 574]

bool pingServiceBelongsToCurrentUser( int $ping_service)

Test whether ping service belongs to current user or not. Takes the ping service id as first argument. Returns bool.



Tags:

throws:  Application_PingServiceException
access:  public


Parameters:

int   $ping_service   Ping service id

[ Top ]

method selectPingService [line 201]

array selectPingService( int $id)

Selects one ping service. Takes the ping service id as first argument. Returns array with ping service information.



Tags:

throws:  Application_PingServiceException
access:  public


Parameters:

int   $id   Ping service id

[ Top ]

method selectPingServices [line 260]

array selectPingServices( [array $params = array()])

Method to select one or more ping services. Takes key=>value array with select params as first argument. Returns array.

List of supported params:

  • start, int, optional: row offset
  • limit, int, optional: amount of rows to return




Tags:

throws:  Application_PingServiceException
access:  public


Parameters:

array   $params   Select params

[ Top ]

method testForUniqueName [line 388]

bool testForUniqueName( string $name, [int $id = null])

Tests given ping service name for uniqueness. Takes the ping service name as first argument and an optional ping service id as second argument.

If the ping service id is given, this ping service won't be considered when checking for uniqueness (useful for updates). Returns boolean true if ping service name is unique.




Tags:

throws:  Application_PingServiceException
access:  public


Parameters:

string   $name   Ping service name
int   $id   Ping service id

[ Top ]

method updatePingService [line 120]

int updatePingService( int $id, array $sqlData)

Updates ping service. Takes the ping service id as first argument, a field=>value array with the new ping service data as second argument.

Returns amount of affected rows.




Tags:

return:  Affected rows
throws:  Application_PingServiceException
access:  public


Parameters:

int   $id   Ping service id
array   $sqlData   Row data

[ Top ]


Documentation generated on Sun, 08 Jan 2012 17:51:57 +0100 by phpDocumentor 1.4.3