Referer Class Reference
[Lib]

Referer extends URL and adds some search engine recognition routines. More...

Inheritance diagram for Referer:

List of all members.

Public Member Functions
	__construct ($referer_url= '')
	Constructor.
	build ($mode=Url::ABSOLUTE, $encoding=Url::ENCODE_PARAMS)
	Returns this query as a string.
	get_original_referer_url ()
	Returns original referer URL.
	is_external ()
	Returns true if referer is external.
	is_internal ()
	Returns true if referer is internal.
	search_engine_info ()
	Returns search engine information if referer is a search engine, else false.
Static Public Member Functions
static	create ($s_url)
	Create new Referer instancwe.
static	current ()
	Constructor.

---

Detailed Description

Referer extends URL and adds some search engine recognition routines.

Author:

Gerd Riesselmann

Definition at line 8 of file referer.cls.php.

---

Constructor & Destructor Documentation

Referer::__construct

(

$

referer_url = ''

)

Constructor.

Definition at line 35 of file referer.cls.php.

                                                       {
                $this->original = $referer_url;
                parent::__construct($referer_url);              
        }

---

Member Function Documentation

Referer::build	(	$	mode = Url::ABSOLUTE,
		$	encoding = Url::ENCODE_PARAMS
	)

Returns this query as a string.

The URL is not ready for outputting it on an HTML page, it must be HTMLescaped before! It is however URL escaped.

Returns:

string This Url as a string.

Exceptions:

Throws

an exception if hostname is empty

Reimplemented from Url.

Definition at line 49 of file referer.cls.php.

                                                                                 {
                if ($this->is_valid()) {
                        return parent::build($mode, $encoding);
                }
                return '';
        }

static Referer::create

(

$

s_url

)

[static]

Create new Referer instancwe.

Parameters:

string

$s_url

Returns:

Referer

Reimplemented from Url.

Definition at line 28 of file referer.cls.php.

                                              {
                return new Referer($s_url);
        }

static Referer::current

(

)

[static]

Constructor.

Returns:

Referer

Reimplemented from Url.

Definition at line 17 of file referer.cls.php.

                                         {
                $referer = Arr::get_item($_SERVER, 'HTTP_REFERER', '');
                return new Referer($referer);
        }

Referer::get_original_referer_url

(

)

Returns original referer URL.

Returns:

string

Definition at line 62 of file referer.cls.php.

                                                   {
                return $this->original;
        }

Referer::is_external

(

)

Returns true if referer is external.

Definition at line 77 of file referer.cls.php.

                                      {
                return (!$this->is_empty() && !$this->is_internal());
        }

Referer::is_internal

(

)

Returns true if referer is internal.

Definition at line 69 of file referer.cls.php.

                                      {
                $url = Url::current();
                return ($this->get_host() == $url->get_host());
        }

Referer::search_engine_info

(

)

Returns search engine information if referer is a search engine, else false.

Computation may be expensive, so handle with care.

Routine checks, if keywords are provided with referer, if not, referer is not recognized as a search engine!

Returns:

mixed False if referer is no searchengine, an associateive array with fields 'domain', 'host', and 'keywords' otherwise

Definition at line 90 of file referer.cls.php.

                                             {
                if (!$this->is_external()) {
                        return false;
                }
                $query_params = $this->get_query_params();
                if (count($query_params) == 0) {
                        return false; // No params, no keywords...
                }

                $arr_se = $this->get_search_engines();
                $host = false; 
                // We are interested in search engines that provide a query only
                foreach($query_params as $query_param => $query_value) {
                        $possible_searchengine_sld = Arr::get_item($arr_se, $query_param, false);
                        if ($possible_searchengine_sld !== false) {
                                // We have a query param that *may* contain keywords
                                // depending on referer domain ('q' are keywords for google, but not for a Drupal page)
                                if (empty($host)) { 
                                        // Only parse host (expensive!) if needed
                                        $host = $this->parse_host(); 
                                }
                                if (in_array($host['sld'], $possible_searchengine_sld)) {               
                                        // We have a query parameter and a domain that belong to a search engine. Return
                                        return array(
                                                'domain' => $host['domain'],
                                                'searchengine' => $host['sld'],
                                                'host' => $this->get_host(),
                                                'keywords' => $query_value
                                        );
                                }
                        } 
                }
                        
                return false;
        }

---

The documentation for this class was generated from the following file:

• gyro/core/lib/components/referer.cls.php