Class: HTMLlinks

Source Location: /HTMLlinks.php

Class Overview

Strings
   |
   --HTML
      |
      --HTMLlinks

This class manages HTMLlinks objects.

Author(s):

Pierre-Dominique Vienne <pvienne@me.com>

Version:

Inherited Variables

Class: HTML

HTML::$class
HTML::$elementtype
HTML::$elementvalue
HTML::$formaction
HTML::$formenctype
HTML::$formmethod
HTML::$forvalue
HTML::$html_needclose
HTML::$html_output
HTML::$html_tag
HTML::$style
HTML::$tag_opened

Class: Strings

Strings::$api_render
Strings::$charset
Strings::$colors
Strings::$directoutput
Strings::$error
Strings::$msgtypes
Strings::$value

Inherited Methods

Class: HTML

HTML::HTMLCloseTag(): HTML closing tag function
HTML::HTMLOpenTag(): HTML opening tag function

Class: Strings

Strings::__construct(): Construction function
Strings::console(): Console function
Strings::IsUTF8(): UTF8 detection function
Strings::QuoteStrip(): Quotes stripping function
Strings::RemoveAccent(): Accents removal function
Strings::RemoveSpaces(): Spaces removal function
Strings::stringHasNumbers(): Numbers detection function
Strings::ToUTF8(): UTF8 conversion function
Strings::ucwordsw(): Special uppercase function

Class Details

[line 35]
This class manages HTMLlinks objects.

Created on 05 jan 07

Changes: 1.1 -> 1.2: 28 jul 09 updated: file is PEAR compatible class has been renamed from Links() to HTMLlinks() 1.0 -> 1.1: 21 jul 09 updated: Relative2Absolute() function no more warning when running PHP in paranoid level

Tags:

author:	Pierre-Dominique Vienne <pvienne@me.com>
version:	1.2
license:	GNU Public License

[ Top ]

Class Variables

$charset_attr =

[line 72]

Variable that contains charset attribute

Tags:

access:

public

Type:

string

[ Top ]

$hreflang_attr =

[line 52]

Variable that contains hreflang attribute

Tags:

access:

public

Type:

string

[ Top ]

$href_attr =

[line 47]

Variable that contains href attribute

Tags:

access:

public

Type:

string

[ Top ]

$rel_attr =

[line 62]

Variable that contains rel attribute

Tags:

access:

public

Type:

string

[ Top ]

$rev_attr =

[line 67]

Variable that contains rev attribute

Tags:

access:

public

Type:

string

[ Top ]

$sLink =

[line 41]

Variable that contains link to be handled

Tags:

access:

public

Type:

string

[ Top ]

$type_attr =

[line 57]

Variable that contains type attribute

Tags:

access:

public

Type:

string

[ Top ]

Class Methods

method AHrefLocator [line 341]

array AHrefLocator(
string
$this->value)

AHref detection function

This function is used to return Href content from 'a' tags. It does not checks if href content is wellformed or not or if it is valid URL. Result is returned

<?php
$oHTMLlinks = new HTMLlinks();
$oHTMLlinks->value = $textcontaininglinks;
print_r($oHTMLlinks->AHrefLocator());
// listoflinks
?>

Tags:

return:	list of links in $this->value
since:	version 1.0

Parameters:

string

$this->value

text containing links (required)

[ Top ]

method FormatEmail [line 395]

string FormatEmail(
[bool
$checkemail = false], string
$this->value)

Email format function

This function is used to format an email to a mailto link. It can check if value is a right email. Result is stored in $this->value and returned

<?php
$oHTMLlinks = new HTMLlinks();
$oHTMLlinks->value = pvienne@me.com;
$oHTMLlinks->FormatEmail(true);
// mailto:pvienne@me.com
?>

Tags:

return:	email link
since:	version 1.0

Parameters:

string	$this->value	email to be converted into link (required)
bool	$checkemail	switch defining if function needs to check if email is valid.

[ Top ]

method IsAbsolute [line 98]

bool IsAbsolute(
string
$this->value)

Abslute link detection function

This function is used to check if a link is absolute or not. Result is returned

<?php
$oHTMLlinks = new HTMLlinks();
$oHTMLlinks->value = "http://www.foo.com";
echo $oHTMLlinks->IsAbsolute();
// 1
?>

Tags:

return:	true if link is absolute
since:	Version 1.0

Parameters:

string

$this->value

text to be processed (required)

[ Top ]

method IsMailto [line 299]

bool IsMailto(
string
$this->value)

Mailto detection function

This function is used to determine if the link is a mailto link. Result is returned

<?php
$oHTMLlinks = new HTMLlinks();
$oHTMLlinks->value = "mailto:pvienne@me.com";
echo $oHTMLlinks->IsMailto();
// 1
?>

Tags:

return:	true if link is a mailto
since:	version 1.0

Parameters:

string

$this->value

link to be checked (required)

[ Top ]

method Protocol [line 254]

string Protocol(
string
$this->value)

Protocol determination function

This function is used to determine the protocole of a link by its declaration. Result is returned

<?php
$oHTMLlinks = new HTMLlinks();
$oHTMLlinks->value = "http://www.foo.com/bar.php";
echo $oHTMLlinks->Protocol();
// http
?>

Tags:

return:	protocol of the link
since:	version 1.0

Parameters:

string

$this->value

url to be checked (required)

[ Top ]

method Relative2Absolute [line 131]

string Relative2Absolute(
string
$relative, [string
$location = ""])

Relative to absolute transformation function

This function is used to transform a relative link to an absolute. Result is stored in $this->value and returned

<?php
$oHTMLlinks = new HTMLlinks();
$relative = "/bar.php";
$location = "http://www.foo.com/dir1/index.php";
echo $oHTMLlinks->Relative2Absolute($relative,$location);
// http://www.foo.com/bar.php
?>

Tags:

return:	absolute link
since:	version 1.0

Parameters:

string	$relative	relative link (required)
string	$location	location from which the link is from

[ Top ]

Documentation generated on Wed, 26 Aug 2009 12:30:21 +0200 by phpDocumentor 1.4.1