CodeIgniter v3.0.0 API
\

\CI_Trackback

Trackback Class

Trackback Sending/Receiving Class

Summary

Methods
Properties
Constants
__construct()
send()
receive()
send_error()
send_success()
data()
process()
extract_urls()
validate_url()
get_id()
convert_xml()
limit_characters()
convert_ascii()
set_error()
display_errors()
$charset
$data
$convert_ascii
$response
$error_msg
No constants found
No protected methods found
No protected properties found
N/A
No private methods found
No private properties found
N/A

Properties

$charset

$charset : string

Character set

Type

string

$data

$data : array

Trackback data

Type

array

$convert_ascii

$convert_ascii : boolean

Convert ASCII flag

Whether to convert high-ASCII and MS Word characters to HTML entities.

Type

boolean

$response

$response : string

Response

Type

string

$error_msg

$error_msg : array<mixed,string>

Error messages list

Type

array<mixed,string>

Methods

__construct()

__construct() : void

Constructor

send()

send(  $tb_data) : boolean

Send Trackback

Parameters

$tb_data

Returns

boolean

receive()

receive() : boolean

Receive Trackback Data

This function simply validates the incoming TB data. It returns FALSE on failure and TRUE on success. If the data is valid it is set to the $this->data array so that it can be inserted into a database.

Returns

boolean

send_error()

send_error(  $message = 'Incomplete Information') : void

Send Trackback Error Message

Allows custom errors to be set. By default it sends the "incomplete information" error, as that's the most common one.

Parameters

$message

send_success()

send_success() : void

Send Trackback Success Message

This should be called when a trackback has been successfully received and inserted.

data()

data(  $item) : string

Fetch a particular item

Parameters

$item

Returns

string

process()

process(  $url,   $data) : boolean

Process Trackback

Opens a socket connection and passes the data to the server. Returns TRUE on success, FALSE on failure

Parameters

$url
$data

Returns

boolean

extract_urls()

extract_urls(  $urls) : string

Extract Trackback URLs

This function lets multiple trackbacks be sent. It takes a string of URLs (separated by comma or space) and puts each URL into an array

Parameters

$urls

Returns

string

validate_url()

validate_url(  $url) : void

Validate URL

Simply adds "http://" if missing

Parameters

$url

get_id()

get_id(  $url) : string

Find the Trackback URL's ID

Parameters

$url

Returns

string

convert_xml()

convert_xml(  $str) : string

Convert Reserved XML characters to Entities

Parameters

$str

Returns

string

limit_characters()

limit_characters(  $str,   $n = 500,   $end_char = '&#8230;') : string

Character limiter

Limits the string based on the character count. Will preserve complete words.

Parameters

$str
$n
$end_char

Returns

string

convert_ascii()

convert_ascii(  $str) : string

High ASCII to Entities

Converts Hight ascii text and MS Word special chars to character entities

Parameters

$str

Returns

string

set_error()

set_error(  $msg) : void

Set error message

Parameters

$msg

display_errors()

display_errors(  $open = '<p>',   $close = '</p>') : string

Show error messages

Parameters

$open
$close

Returns

string