InstanceReferenceRoute Class Reference

A route that contains a reference to an instance. More...

Inheritance diagram for InstanceReferenceRoute:

List of all members.

Protected Member Functions
	build_unknown_type_regexp ($type, $params)
	Can be overloaded to support further types.
	build_url_path ($params)
	Build the URL (except base part).
	replace_path_variable ($path, $key, $value)
	Replace a variable in the path with a given value.

---

Detailed Description

A route that contains a reference to an instance.

The route adds the type "inst" to the parameterized route. However, it must be the last element and requires to declare it using "%".

Example: https://voting/vote/{instance:inst}%

Definition at line 10 of file instancereferenceroute.cls.php.

---

Member Function Documentation

InstanceReferenceRoute::build_unknown_type_regexp	(	$	type,
		$	params
	)			[protected]

Can be overloaded to support further types.

Parameters:

	string	$type The type of an expression
	string	$params Optional params

Returns:

string A regular expression

Reimplemented from ParameterizedRoute.

Definition at line 18 of file instancereferenceroute.cls.php.

                                                                     {
                $ret = '';
                if ($type == 'inst') {
                        $ret = '.*?'; // Any string
                }
                else {
                        $ret = parent::build_unknown_type_regexp($type, $params);
                }
                return $ret;
        }

InstanceReferenceRoute::build_url_path

(

$

params

)

[protected]

Build the URL (except base part).

Parameters:

mixed

$params Further parameters to use to build URL

Returns:

string

Reimplemented from ParameterizedRoute.

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

                                                   {
                $arr = $params;
                if ($params instanceof IDataObject) {
                        // Try to find the inst type
                        $regexp = '|\{([^:]*):inst\}|';
                        $matches = array();
                        $result = preg_match($regexp, $this->path, $matches);
                        if ($result) {
                                $var_name = $matches[1];
                                $arr = array($var_name => $params); 
                        }                       
                }
                return parent::build_url_path($arr);
        }

InstanceReferenceRoute::replace_path_variable	(	$	path,
		$	key,
		$	value
	)			[protected]

Replace a variable in the path with a given value.

Parameters:

	string	$path
	string	$key
	mixed	$value

Returns:

string

Reimplemented from ParameterizedRoute.

Definition at line 58 of file instancereferenceroute.cls.php.

                                                                      {
                if ($value instanceof IDataObject) {
                        return parent::replace_path_variable($path, $key, InstanceReferenceSerializier::instance_to_string($value));
                }
                return parent::replace_path_variable($path, $key, $value);
        }

---

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

• contributions/instancereference/controller/base/routes/instancereferenceroute.cls.php