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

Class: Application_PingServiceConfiguration

Source Location: /application_classes/pingserviceconfiguration.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_PingServiceConfiguration __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 addPingServiceConfiguration [line 86]

int addPingServiceConfiguration( array $sqlData)

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



Tags:

return:  Ping service configuration id
throws:  Application_PingServiceConfigurationException
access:  public


Parameters:

array   $sqlData   Row data

[ Top ]

method countPingServiceConfigurations [line 380]

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

Method to count ping service configurations. Takes key=>value array with count params as first argument. Returns int.

List of supported params:

  • page, int, optional: Page id
  • ping_service, int, optional: Ping service id




Tags:

throws:  Application_PingServiceConfigurationException
access:  public


Parameters:

array   $params   Count params

[ Top ]

method deletePingServiceConfiguration [line 166]

int deletePingServiceConfiguration( int $id)

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



Tags:

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


Parameters:

int   $id   Ping service configuration id

[ Top ]

method pingServiceConfigurationBelongsToCurrentProject [line 449]

int pingServiceConfigurationBelongsToCurrentProject( int $ping_service_configuration)

Tests whether given ping service configuration belongs to current project.

Takes the ping service configuration id as first argument. Returns bool.




Tags:

return:  bool
throws:  Application_PingServiceConfiguration
access:  public


Parameters:

int   $ping_service_configuration   Text macro id

[ Top ]

method pingServiceConfigurationBelongsToCurrentUser [line 500]

bool pingServiceConfigurationBelongsToCurrentUser( int $ping_service_configuration)

Test whether ping service configuration belongs to current user or not.

Takes the ping service configuration id as first argument. Returns bool.




Tags:

throws:  Application_PingServiceConfiguration
access:  public


Parameters:

int   $ping_service_configuration   Ping service configuration id

[ Top ]

method selectPingServiceConfiguration [line 206]

array selectPingServiceConfiguration( int $id)

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



Tags:

throws:  Application_PingServiceConfigurationException
access:  public


Parameters:

int   $id   Ping service configuration id

[ Top ]

method selectPingServiceConfigurations [line 278]

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

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

List of supported params:

  • page, int, optional: Page id
  • ping_service, int, optional: Ping service id
  • start, int, optional: row offset
  • limit, int, optional: amount of rows to return




Tags:

throws:  Application_PingServiceConfigurationException
access:  public


Parameters:

array   $params   Select params

[ Top ]

method updatePingServiceConfiguration [line 123]

int updatePingServiceConfiguration( int $id, array $sqlData)

Updates ping service configuration. Takes the ping service configuration id as first argument, a field=>value array with the new ping service configuration data as second argument. Returns amount of affected rows.



Tags:

return:  Affected rows
throws:  Application_PingServiceConfigurationException
access:  public


Parameters:

int   $id   Ping service configuration id
array   $sqlData   Row data

[ Top ]


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