phpDocumentor Swift
[ class tree: Swift ] [ index: Swift ] [ all elements ]

Class: SwiftPinger

Source Location: /classes/SwiftPinger.php

Class SwiftPinger

Class Overview

This class contains functions to send out automated XML RPC pings to search engines.

Located in /classes/SwiftPinger.php [line 42]



		
		
		
		

Methods

[ Top ]
Method Summary
SwiftPinger   __construct()   Creates and initializes a new SwiftPinger object with the provided parameters.
integer   extendedPingAll()   Send extended ping to entire list of servers.
string   getChangedUrl()   Gets the current changed or updated url for this Pinger object.
string   getFeedUrl()   Gets the current RSS or Atom feed url for this Pinger object.
string   getName()   Gets the current website name or title for this Pinger object.
string   getUrl()   Gets the current homepage URL for this Pinger object.
integer   pingAll()   Ping entire list of servers.
boolean   sendExtendedPing()   Send extended ping the given server.
boolean   sendPing()   Ping the given server.
void   setChangedUrl()   Set the changed or updated url for this Pinger object.
void   setFeedUrl()   Set the optional RSS or Atom feed url for this Pinger object.
void   setName()   Set the website name or title for this Pinger object.
void   setUrl()   Set the website URL for this Pinger object.

[ Top ]
Methods
Constructor __construct  [line 72]

  SwiftPinger __construct( string $name, string $url, [string $changedUrl = null], [string $feedUrl = null]  )

Creates and initializes a new SwiftPinger object with the provided parameters.

Parameters:
string   $name:  Name or title of website
string   $url:  The URL of the homepage.
string   $changedUrl:  The changed or updated url.
string   $feedUrl:  Optional RSS/ATOM feed url to include in ping.

API Tags:
Return:  The new SwiftPinger object
Access:  public


[ Top ]
extendedPingAll  [line 195]

  integer extendedPingAll( )

Send extended ping to entire list of servers.


API Tags:
Return:  Number of server an extended ping was sent to.
Access:  public


[ Top ]
getChangedUrl  [line 123]

  string getChangedUrl( )

Gets the current changed or updated url for this Pinger object.


API Tags:
Return:  URL string
Access:  public


[ Top ]
getFeedUrl  [line 139]

  string getFeedUrl( )

Gets the current RSS or Atom feed url for this Pinger object.


API Tags:
Return:  URL string
Access:  public


[ Top ]
getName  [line 91]

  string getName( )

Gets the current website name or title for this Pinger object.


API Tags:
Return:  Website name or title string.
Access:  public


[ Top ]
getUrl  [line 107]

  string getUrl( )

Gets the current homepage URL for this Pinger object.


API Tags:
Return:  URL string
Access:  public


[ Top ]
pingAll  [line 182]

  integer pingAll( )

Ping entire list of servers.


API Tags:
Return:  Number of server a ping was sent to.
Access:  public


[ Top ]
sendExtendedPing  [line 221]

  boolean sendExtendedPing( $server  )

Send extended ping the given server.

Parameters:
   $server: 

API Tags:
Return:  True if extended ping sent. False on error.
Access:  public


[ Top ]
sendPing  [line 208]

  boolean sendPing( $server  )

Ping the given server.

Parameters:
   $server: 

API Tags:
Return:  True if ping sent. False on error.
Access:  public


[ Top ]
setChangedUrl  [line 115]

  void setChangedUrl( string $value  )

Set the changed or updated url for this Pinger object.

Parameters:
string   $value:  URL string

API Tags:
Access:  public


[ Top ]
setFeedUrl  [line 131]

  void setFeedUrl( string $value  )

Set the optional RSS or Atom feed url for this Pinger object.

Parameters:
string   $value:  URL string

API Tags:
Access:  public


[ Top ]
setName  [line 83]

  void setName( string $value  )

Set the website name or title for this Pinger object.

Parameters:
string   $value:  Website name or title string

API Tags:
Access:  public


[ Top ]
setUrl  [line 99]

  void setUrl( string $value  )

Set the website URL for this Pinger object.

Parameters:
string   $value:  Website URL string

API Tags:
Access:  public


[ Top ]

Documentation generated on Tue, 08 Oct 2013 05:37:16 +0200 by phpDocumentor 1.4.4