sspmod_metarefresh_ARP Class Reference

Collaboration diagram for sspmod_metarefresh_ARP:

Public Member Functions
	__construct ($metadata, $attributemap, $prefix, $suffix)
	Constructor. More...
	getXML ()

Private Member Functions
	loadAttributeMap ($attributemap)
	surround ($name)
	getAttributeID ($name)
	getEntryXML ($entry)
	getEntryXMLcontent ($entry)

Private Attributes
	$metadata
	$attributes
	$prefix
	$suffix

Detailed Description

Definition at line 7 of file ARP.php.

Constructor & Destructor Documentation

__construct()

sspmod_metarefresh_ARP::__construct	(		$metadata,
			$attributemap,
			$prefix,
			$suffix
	)

Constructor.

Parameters

array	$metadata
string	$attributemap
string	$prefix
string	$suffix

Definition at line 37 of file ARP.php.

References $attributemap, $metadata, $prefix, $suffix, and loadAttributeMap().

    {
        $this->metadata = $metadata;
        $this->prefix = $prefix;
        $this->suffix = $suffix;

        if (isset($attributemap)) {
            $this->loadAttributeMap($attributemap);
        }
    }

Here is the call graph for this function:

Member Function Documentation

getAttributeID()

sspmod_metarefresh_ARP::getAttributeID (   $name )

private

Parameters

string

$name

Returns

string

Definition at line 84 of file ARP.php.

References $name, and surround().

Referenced by getEntryXMLcontent().

    {
        if (empty($this->attributes)) {
            return $this->surround($name);
        }
        if (array_key_exists($name, $this->attributes)) {
            return $this->surround($this->attributes[$name]);
        }
        return $this->surround($name);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getEntryXML()

sspmod_metarefresh_ARP::getEntryXML (   $entry )

private

Parameters

array

$entry

Returns

string

Definition at line 123 of file ARP.php.

References getEntryXMLcontent().

Referenced by getXML().

    {
        $entityid = $entry['entityid'];
        return '    <AttributeFilterPolicy id="' . $entityid .
            '"><PolicyRequirementRule xsi:type="basic:AttributeRequesterString" value="' . $entityid .
            '" />' . $this->getEntryXMLcontent($entry) . '</AttributeFilterPolicy>';
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getEntryXMLcontent()

sspmod_metarefresh_ARP::getEntryXMLcontent (   $entry )

private

Parameters

array

$entry

Returns

string

Definition at line 136 of file ARP.php.

References $ret, and getAttributeID().

Referenced by getEntryXML().

    {
        if (!array_key_exists('attributes', $entry)) {
            return '';
        }

        $ret = '';
        foreach ($entry['attributes'] as $a) {
            $ret .= '            <AttributeRule attributeID="' . $this->getAttributeID($a) .
                '"><PermitValueRule xsi:type="basic:ANY" /></AttributeRule>';
        }
        return $ret;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getXML()

sspmod_metarefresh_ARP::getXML

(

)

Returns

string

Definition at line 98 of file ARP.php.

References $metadata, $xml, and getEntryXML().

    {
        $xml = <<<MSG
        <?xml version="1.0" encoding="UTF-8"?>
        <AttributeFilterPolicyGroup id="urn:mace:funet.fi:haka:kalmar" xmlns="urn:mace:shibboleth:2.0:afp"
    xmlns:basic="urn:mace:shibboleth:2.0:afp:mf:basic" xmlns:saml="urn:mace:shibboleth:2.0:afp:mf:saml"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="urn:mace:shibboleth:2.0:afp classpath:/schema/shibboleth-2.0-afp.xsd
                        urn:mace:shibboleth:2.0:afp:mf:basic classpath:/schema/shibboleth-2.0-afp-mf-basic.xsd
                        urn:mace:shibboleth:2.0:afp:mf:saml classpath:/schema/shibboleth-2.0-afp-mf-saml.xsd">
MSG;

        foreach ($this->metadata as $metadata) {
            $xml .= $this->getEntryXML($metadata['metadata']);
        }

        $xml .= '</AttributeFilterPolicyGroup>';
        return $xml;
    }

Here is the call graph for this function:

loadAttributeMap()

sspmod_metarefresh_ARP::loadAttributeMap (   $attributemap )

private

Parameters

string

$attributemap

Returns

void

Definition at line 53 of file ARP.php.

References $attributemap, $config, and SimpleSAML_Configuration\getInstance().

Referenced by __construct().

    {
        $config = SimpleSAML_Configuration::getInstance();
        include($config->getPathValue('attributemap', 'attributemap/') . $attributemap . '.php');
        // Note that $attributemap was a string before the call to include() and is now an array!
        $this->attributes = $attributemap;
        }

Here is the call graph for this function:

Here is the caller graph for this function:

surround()

sspmod_metarefresh_ARP::surround (   $name )

private

Parameters

string

$name

Returns

string

Definition at line 66 of file ARP.php.

References $name, $prefix, $ret, and $suffix.

Referenced by getAttributeID().

    {
        $ret = '';
        if (!empty($this->prefix)) {
            $ret .= $this->prefix;
        }
        $ret .= $name;
        if (!empty($this->suffix)) {
            $ret .= $this->suffix;
        }
        return $ret;
    }

Here is the caller graph for this function:

Field Documentation

$attributes

sspmod_metarefresh_ARP::$attributes

private

Definition at line 17 of file ARP.php.

$metadata

sspmod_metarefresh_ARP::$metadata

private

Definition at line 12 of file ARP.php.

Referenced by __construct(), and getXML().

$prefix

sspmod_metarefresh_ARP::$prefix

private

Definition at line 22 of file ARP.php.

Referenced by __construct(), and surround().

$suffix

sspmod_metarefresh_ARP::$suffix

private

Definition at line 27 of file ARP.php.

Referenced by __construct(), and surround().

---

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

• libs/composer/vendor/simplesamlphp/simplesamlphp/modules/metarefresh/lib/ARP.php