Last updated: Fri, 14 Aug 2009

XSLTProcessor::setParameter

(PHP 5)

XSLTProcessor::setParameter — Définit la valeur d'un paramètre

Description

XSLTProcessor

bool setParameter ( string $namespace , string $name , string $value )

XSLTProcessor

bool setParameter ( string $namespace , array $options )

Spécifie la valeur d'un ou plusieurs paramètres pour être utilisés dans une sous-séquence de transformation avec XSLTProcessor. Si le paramètre n'existe pas dans la feuille de style, il sera ignoré.

Liste de paramètres

namespace: L'URI de l'espace de noms du paramètre XSLT.
name: Le nom local du paramètre XSLT.
value: La nouvelle valeur du paramètre XSLT.
options: Un tableau de paire nom => valeur. Cette syntaxe est disponible depuis PHP 5.1.0.

Valeurs de retour

Cette fonction retourne TRUE en cas de succès, FALSE en cas d'échec.

Exemples

Exemple #1 Modification du propriétaire avant la transformation


<?php

$collections = array(
    'Marc Rutkowski' => 'marc',
    'Olivier Parmentier' => 'olivier'
);

$xsl = new DOMDocument;
$xsl->load('collection.xsl');

// Configure le transformateur
$proc = new XSLTProcessor;
$proc->importStyleSheet($xsl); // attachement des règles xsl

foreach ($collections as $name => $file) {
    // Chargement de la source XML
    $xml = new DOMDocument;
    $xml->load('collection_' . $file . '.xml');

    $proc->setParameter('', 'owner', $name);
    $proc->transformToURI($xml, 'file:///tmp/' . $file . '.html');
}

?>

Voir aussi

XSLTProcessor::getParameter() - Récupère la valeur d'un paramètre
XSLTProcessor::removeParameter() - Efface un paramètre

XSLTProcessor::setProfiling

XSLTProcessor::removeParameter

Last updated: Fri, 14 Aug 2009

add a note User Contributed Notes
XSLTProcessor::setParameter

richard at aggmedia dot net
05-Mar-2009 03:47


Note that there is no way to remove a parameter from an XSLTProcessor unless you know its name, and there is no way (that I can find) to get a list of the current parameters.



This means that you cannot reuse an XSLTProcessor with different parameters unless you call XSLTProcessor->removeParameter() on every parameter, and to do that you need to know the names of all the currently set parameters.



I bumped into this because we were caching XSLTProcessors for reuse, and they were spitting out content based on phantom parameters (they were still there from previous uses).

Lennaert van der Linden
13-Feb-2008 02:28


The parameter will not be set if the value contains both single and double quotes. Instead a warning will be shown when transforming the document:



PHP Warning:  XSLTProcessor::transformToXml(): Cannot create XPath expression (string contains both quote and double-quotes)

brettz9
09-May-2007 03:27


It seems heinemann's usage is not correct and does not achieve the intended result.



This method's purpose is to change a global <xsl:param> value in the XSL stylesheet--not to change an attribute of any other element.  <xsl:param> basically lets you set up a stylesheet which can be customized (as from PHP) externally (without needing to tamper with the original XSL file).



Here's an example of usage (that will work):



Stylesheet:



<?xml version="1.0"?>

<xsl:stylesheet version="1.0" xmlns:xsl="http://www.w3.org/1999/XSL/Transform">

    <xsl:param name="print_something" select="defaultstring"/>

    <xsl:template match="/mydoc">

        <p style="color:red;">Printed parameter: <xsl:value-of select="$print_something"/></p>

    </xsl:template>

</xsl:stylesheet>



Script: 



<?php

$dom = new DOMDocument();

$xsl = new XSLTProcessor;

$xsl->setParameter( '', 'print_something', "Now I've overridden the default!");

$style = realpath( "./my_stylesheet.xslt" );

$dom->load($style);

$xsl->importStyleSheet($dom);

$dom->loadXML('<mydoc></mydoc>');



$out = $xsl->transformToXML( $dom );



var_dump( '<pre>',

    htmlentities( $out, ENT_QUOTES, 'utf-8' ),

    $xsl->getParameter('', 'print_something'),

'</pre>' );

?>



gives:



string(5) "



"

string(143) "<?xml version="1.0"?>

<p style="color:red;">Printed parameter: Now I've overridden the default!</p>

"

string(32) "Now I've overridden the default!"

string(6) "



" 



Notice that at present adding a namespace will not work. The only option at present is to set the first parameter for namespace to an empty string (though you can add the prefix with colon to the second argument for name in order to set the parameter for a namespace-prefixed parameter name).



See http://bugs.php.net/bug.php?id=30622

OrionI
01-May-2007 02:19


After looking at this a little further (see http://bugs.php.net/bug.php?id=41248), it appears that it's a shortcoming of libxslt, not PHP, that prevents passing in DOMDocuments or DOMNodes as parameters.

Orion I
01-May-2007 03:46


I've been trying to pass in a DOMDocument object as a parameter so I can stuff a bunch of data into XML nodes, but it appears that this function is not capable of it. I was hoping to get it to work like it does in the .NET 2.0 framework. (See http://msdn2.microsoft.com/en-us/library/

system.xml.xsl.xsltargumentlist.addparam.aspx)

But after looking at the PHP 5.2.1 source code, /php-5.2.1/ext/xsl/xsltprocessor.c line 604-650, it appears that it's not possible to do so in PHP even though it appears that libxslt supports it (see http://xmlsoft.org/XSLT/html/libxslt-variables.html

#xsltParseGlobalParam)



In fact, if the parameters aren't exactly what's expected, you'll always get a warning like this:



Wrong parameter count for XSLTProcessor::setParameter()

heinemann dot juergen at hjcms dot de
07-Mar-2006 11:39


Example for how it works.



<?xml version = '1.0' encoding = 'utf-8' ?>

<xsl:stylesheet version="1.0" xmlns:xsl="http://www.w3.org/1999/XSL/Transform">

<xsl:output method="xml" 

    indent="yes"

    encoding="ISO-8859-15"

    doctype-system = "-//W3C//DTD XHTML 1.0 Transitional//EN" 

    doctype-public = "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"

/>

<xsl:template match="docs">

<html>

<head>

    <title>

        <xsl:text>Example</xsl:text>

    </title>

</head>

<body>

    <xsl:for-each select="block">

        <div>

            <xsl:value-of select="." />

        </div>

    </xsl:for-each>

</body>

</html>

</xsl:template>

</xsl:stylesheet>



------------------



<?php

$dom = new DomDocument( '1.0', 'utf-8' );

$xsl = new XSLTProcessor;

$xsl->setParameter( 'block', 'xmlns', 'http://www.w3.org/1999/xhtml' );



$style = realpath( "./my_stylesheet.xslt" );

$dom->load( $style );

$xsl->importStyleSheet( $dom );



$dom->loadXML( '<docs>

    <block>Howto set xhtml Transitional Namespaces width php</block>

    <block>see http://www.php.net</block>

</docs>' );



$out = $xsl->transformToXML( $dom );



var_dump( '<pre>', 

    htmlentities( $out, ENT_QUOTES, 'utf-8' ),

    $xsl->getParameter( 'block', 'xmlns' ),

    $xsl->getParameter( 'docs', 'xmlns' ),

'</pre>' );



?>

Stoke A
11-Aug-2005 10:40


XSLTProcessor::removeParameter() won't work on parameters set via XSLTProcessor::setParameter(string namespace, array options) in 5.1+ -- they need to be set and removed one by one.

add a note

XSLTProcessor::setProfiling

XSLTProcessor::removeParameter

Last updated: Fri, 14 Aug 2009