Documentation

CleantalkAPI
in package

Table of Contents

Constants

URL  = 'https://api.cleantalk.org'

Methods

check_response()  : mixed
Function checks server response
method__backlinks_check_cms()  : type
Function gets spam domains report
method__get_2s_blacklists_db()  : mixed
method__get_antispam_report()  : type
Function gets spam report
method__get_antispam_report_breif()  : type
Function gets spam statistics
method__get_api_key()  : type
Function gets access key automatically
method__notice_paid_till()  : type
Function gets information about renew notice
method__notice_validate_key()  : type
Function gets information about renew notice
method__security_firewall_data()  : mixed
method__security_firewall_data_file()  : mixed
method__security_linksscan_logs()  : mixed
method__security_logs()  : mixed
method__security_logs__feedback()  : mixed
method__security_logs__sendFWData()  : mixed
method__security_mscan_files()  : mixed
method__security_mscan_logs()  : mixed
method__sfw_logs()  : type
Wrapper for sfw_logs API method
method__spam_check_cms()  : type
Function gets spam report
send_request()  : type
Function sends raw request to API server

Constants

Methods

check_response()

Function checks server response

public static check_response(mixed $result[, mixed $method_name = null ]) : mixed
Parameters
$result : mixed
$method_name : mixed = null
Return values
mixed —

(array || array('error' => true))

method__backlinks_check_cms()

Function gets spam domains report

public static method__backlinks_check_cms(mixed $api_key, mixed $data[, mixed $date = null ][, mixed $do_check = true ]) : type
Parameters
$api_key : mixed
$data : mixed
$date : mixed = null
$do_check : mixed = true
Return values
type

method__get_2s_blacklists_db()

public static method__get_2s_blacklists_db(mixed $api_key[, mixed $do_check = true ]) : mixed
Parameters
$api_key : mixed
$do_check : mixed = true

method__get_antispam_report()

Function gets spam report

public static method__get_antispam_report(mixed $host[, mixed $period = 1 ]) : type
Parameters
$host : mixed
$period : mixed = 1
Return values
type

method__get_antispam_report_breif()

Function gets spam statistics

public static method__get_antispam_report_breif(mixed $api_key[, mixed $do_check = true ]) : type
Parameters
$api_key : mixed
$do_check : mixed = true
Return values
type

method__get_api_key()

Function gets access key automatically

public static method__get_api_key(mixed $email, mixed $host, mixed $platform[, mixed $timezone = null ][, mixed $language = null ][, mixed $ip = null ][, mixed $white_label = 0 ][, mixed $hoster_api_key = '' ][, mixed $do_check = true ]) : type
Parameters
$email : mixed
$host : mixed
$platform : mixed
$timezone : mixed = null
$language : mixed = null
$ip : mixed = null
$white_label : mixed = 0
$hoster_api_key : mixed = ''
$do_check : mixed = true
Return values
type

method__notice_paid_till()

Function gets information about renew notice

public static method__notice_paid_till(mixed $api_key[, mixed $do_check = true ]) : type
Parameters
$api_key : mixed
$do_check : mixed = true
Return values
type

method__notice_validate_key()

Function gets information about renew notice

public static method__notice_validate_key(mixed $api_key, mixed $path_to_cms[, mixed $do_check = true ]) : type
Parameters
$api_key : mixed
$path_to_cms : mixed
$do_check : mixed = true
Return values
type

method__security_firewall_data()

public static method__security_firewall_data(mixed $api_key[, mixed $do_check = true ]) : mixed
Parameters
$api_key : mixed
$do_check : mixed = true

method__security_firewall_data_file()

public static method__security_firewall_data_file(mixed $api_key[, mixed $do_check = true ]) : mixed
Parameters
$api_key : mixed
$do_check : mixed = true

method__security_linksscan_logs()

public static method__security_linksscan_logs(mixed $api_key, mixed $scan_time, mixed $scan_result, mixed $links_total, mixed $links_list[, mixed $do_check = true ]) : mixed
Parameters
$api_key : mixed
$scan_time : mixed
$scan_result : mixed
$links_total : mixed
$links_list : mixed
$do_check : mixed = true

method__security_logs()

public static method__security_logs(mixed $api_key, mixed $data[, mixed $do_check = true ]) : mixed
Parameters
$api_key : mixed
$data : mixed
$do_check : mixed = true

method__security_logs__feedback()

public static method__security_logs__feedback(mixed $api_key[, mixed $do_check = true ]) : mixed
Parameters
$api_key : mixed
$do_check : mixed = true

method__security_logs__sendFWData()

public static method__security_logs__sendFWData(mixed $api_key, mixed $data[, mixed $do_check = true ]) : mixed
Parameters
$api_key : mixed
$data : mixed
$do_check : mixed = true

method__security_mscan_files()

public static method__security_mscan_files(mixed $api_key, mixed $file_path, mixed $file, mixed $file_md5, mixed $weak_spots[, mixed $do_check = true ]) : mixed
Parameters
$api_key : mixed
$file_path : mixed
$file : mixed
$file_md5 : mixed
$weak_spots : mixed
$do_check : mixed = true

method__security_mscan_logs()

public static method__security_mscan_logs(mixed $api_key, mixed $service_id, mixed $scan_time, mixed $scan_result, mixed $scanned_total, mixed $modified, mixed $unknown[, mixed $do_check = true ]) : mixed
Parameters
$api_key : mixed
$service_id : mixed
$scan_time : mixed
$scan_result : mixed
$scanned_total : mixed
$modified : mixed
$unknown : mixed
$do_check : mixed = true

method__sfw_logs()

Wrapper for sfw_logs API method

public static method__sfw_logs(mixed $api_key, mixed $data[, mixed $do_check = true ]) : type
Parameters
$api_key : mixed
$data : mixed
$do_check : mixed = true
Return values
type —

returns mixed STRING || array('error' => true, 'error_string' => STRING)

method__spam_check_cms()

Function gets spam report

public static method__spam_check_cms(mixed $api_key, mixed $data[, mixed $date = null ][, mixed $do_check = true ]) : type
Parameters
$api_key : mixed
$data : mixed
$date : mixed = null
$do_check : mixed = true
Return values
type

send_request()

Function sends raw request to API server

public static send_request(mixed $data[, mixed $url = self::URL ][, mixed $timeout = 5 ][, mixed $ssl = false ]) : type
Parameters
$data : mixed
$url : mixed = self::URL
$timeout : mixed = 5
$ssl : mixed = false
Return values
type 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results