energine
[ class tree: energine ] [ index: energine ] [ all elements ]

Class: URI

Source Location: /framework/URI.class.php

Class Overview

Object
   |
   --URI

URI (Unified Resource Identifier).


Author(s):

  • 1m

Variables

Methods


Inherited Constants

Inherited Variables

Inherited Methods

Class: Object

Object::__construct()
Пустой конструктор
Object::getConfigValue()
Нестатический метод-обёртка над Object::_getConfigValue - для удобства использования внутри производных классов.
Object::getTimer()
Возвращает значение счетчика времени выполнения.
Object::resetTimer()
Сбрасывает счетчик времени, возвращает предыдущее значение счетчика
Object::startTimer()
Запускает счетчик времени выполнения.
Object::stopTimer()
Останавливает счетчик времени выполнения.
Object::_getConfigValue()
Возвращает значение указанного параметра конфигурации.

Class Details

[line 23]
URI (Unified Resource Identifier).



Tags:

author:   1m
final:  


[ Top ]


Class Variables

$fragment =

[line 53]



Tags:

var:   идентификатор фрагмента документа
access:   private

Type:   string


[ Top ]

$host =

[line 35]



Tags:

var:   сервер (имя хоста)
access:   private

Type:   string


[ Top ]

$path =

[line 41]



Tags:

var:   путь
access:   private

Type:   array


[ Top ]

$query =

[line 47]



Tags:

var:   строка параметров
access:   private

Type:   string


[ Top ]

$scheme =

[line 29]



Tags:

var:   схема (протокол) запроса
access:   private

Type:   string


[ Top ]



Class Methods


static method validate [line 83]

static mixed validate( $uri $uri)

Проверяет является ли переданная строка URLом



Tags:

return:   array($scheme, $host, $path, $query) || false
access:   public


Parameters:

$uri   $uri   УРЛ

[ Top ]

constructor __construct [line 62]

void __construct( string $uri)

Конструктор класса.



Tags:

access:   public


Overrides Object::__construct() (Пустой конструктор)

Parameters:

string   $uri  

[ Top ]

method getFragment [line 244]

string getFragment( )

Возвращает идентификатор фрагмента документа.



Tags:

access:   public


[ Top ]

method getHost [line 130]

string getHost( )

Возвращает имя хоста.



Tags:

access:   public


[ Top ]

method getPath [line 179]

string getPath( [boolean $asString = true])

Возвращает путь в виде массива сегментов или в виде строки, если установлен флаг $asString.



Tags:

access:   public


Parameters:

boolean   $asString  

[ Top ]

method getPathSegment [line 199]

string getPathSegment( int $pos)

Возвращает сегмент пути с индексом $pos.



Tags:

access:   public


Parameters:

int   $pos  

[ Top ]

method getPort [line 153]

int getPort( )

Возвращает идентификатор порта



Tags:

access:   public


[ Top ]

method getQuery [line 223]

string getQuery( )

Возвращает строку параметров.



Tags:

access:   public


[ Top ]

method getScheme [line 109]

string getScheme( )

Возвращает схему (протокол) URI.



Tags:

access:   public


[ Top ]

method setFragment [line 234]

void setFragment( string $fragment)

Устанавливает идентификатор фрагмента документа.



Tags:

access:   public


Parameters:

string   $fragment  

[ Top ]

method setHost [line 120]

void setHost( string $host)

Устанавливает имя хоста.



Tags:

access:   public


Parameters:

string   $host  

[ Top ]

method setPath [line 164]

void setPath( $path $path)

Устанавливает путь.



Tags:

access:   public


Parameters:

$path   $path  

[ Top ]

method setPort [line 140]

void setPort( $port)

Устанавливает порт



Tags:

access:   public


Parameters:

   $port  

[ Top ]

method setQuery [line 213]

void setQuery( string $query)

Устанавливает строку параметров.



Tags:

access:   public


Parameters:

string   $query  

[ Top ]

method setScheme [line 99]

void setScheme( string $scheme)

Устанавливает схему (протокол) URI.



Tags:

access:   public


Parameters:

string   $scheme  

[ Top ]

method __toString [line 254]

string __toString( )

Возвращает строковое представление URI.



Tags:

access:   public


[ Top ]

В создании документации нам помог: phpDocumentor