Issues

ZF2-10: iterating over a Zend_Config

Issue Type: Bug Created: 2009-03-23T11:57:59.000+0000 Last Updated: 2012-10-08T20:15:38.000+0000 Status: Closed Fix version(s): Reporter: meugen (meugen) Assignee: Ben Scholzen (dasprid) Tags: - Zend\Config

  • zf-crteam-padraic
  • zf-crteam-priority

Related issues: - ZF-7772

Attachments:

Description

There are two xml-files.

<pre class="highlight">
<?xml version="1.0" encoding="utf-8" ?>

and

<pre class="highlight">
<?xml version="1.0" encoding="utf-8" ?>

and the sample code:

<pre class="highlight">
<?php
    require_once 'Zend/Config.php';
    require_once 'Zend/Config/Xml.php';
    
    $config = new Zend_config_xml('/path/to/config.xml');
    foreach ($config->files->file as $value)
        echo 'id: '.$value->id.'<br></br>location: '.
            htmlspecialchars($value->location).'';
?>

If the /path/to/config.xml to substitute config1.xml, then everything works correctly. But if you substitute config2.xml error

<pre class="highlight">
Notice: Trying to get property of non-object in D:\www\index.php on line 7

How can I iterate all items file, if their number is not known in advance (one or more than one)?

Comments

Posted by Rob Allen (rob) on 2009-04-05T12:04:41.000+0000

Can't fix at Zend_Config level. Workaround is to use UTF8 files without a BOM marker.

Posted by Rob Allen (rob) on 2009-04-05T12:12:32.000+0000

(Closed wrong issue!)

Posted by Rob Allen (rob) on 2009-04-05T12:19:40.000+0000

I'm not sure there's any way to resolve this issue due to the other than creating a dummy key to force an array:

<pre class="highlight">
<?xml version="1.0" encoding="utf-8" ?>

might work, but don't forget to test for id being null.

Posted by Patrick van Dissel (tdm) on 2009-09-03T00:56:22.000+0000

This issue also exists when using the toArray() method of Zend_Config. The problem is that you just want the array to ALWAYS have the same layout. Config files tent to grow and be extended, just like XML files.

In my opinion the Zend_Config API should work the same as the of SimpleXml, here two extended examples and their output: h2. Using SimpleXML

<pre class="highlight">
<?php
// Files with single file element
$xmlString1 = <<indexindex.html
XML;

// Files with multiple file elements
$xmlString2 = <<indexindex.htmlindex2index2.html
XML;

echo "Files with single file element, looping files->file:\n";
$xml1 = new SimpleXMLElement($xmlString1);
foreach ($xml1->files->file as $file) {
    var_dump($file);
    printf("%s: %s\n", 'id', $file->id);
    printf("%s: %s\n", 'localtion', $file->location);
}
echo "Files with single file element, looping files->file->id:\n";
foreach ($xml1->files->file->id as $id) {
    var_dump($id);
    printf("%s: %s\n", 'id', $id);
}

echo "Files with multiple file elements, looping files->file:\n";
$xml2 = new SimpleXMLElement($xmlString2);
foreach ($xml2->files->file as $file) {
    var_dump($file);
    printf("%s: %s\n", 'id', $file->id);
    printf("%s: %s\n", 'localtion', $file->location);
}
echo "Files with multiple file elements, looping files->file->id:\n";
foreach ($xml2->files->file->id as $id) {
    var_dump($id);
    printf("%s: %s\n", 'id', $id);
}



<pre class="literal">
Files with single file element, looping files->file:
object(SimpleXMLElement)#3 (2) {
  ["id"]=>
  string(5) "index"
  ["location"]=>
  string(10) "index.html"
}
id: index
localtion: index.html
Files with single file element, looping files->file->id:
object(SimpleXMLElement)#2 (1) {
  [0]=>
  string(5) "index"
}
id: index
Files with multiple file elements, looping files->file:
object(SimpleXMLElement)#6 (2) {
  ["id"]=>
  string(5) "index"
  ["location"]=>
  string(10) "index.html"
}
id: index
localtion: index.html
object(SimpleXMLElement)#3 (2) {
  ["id"]=>
  string(6) "index2"
  ["location"]=>
  string(11) "index2.html"
}
id: index2
localtion: index2.html
Files with multiple file elements, looping files->file->id:
object(SimpleXMLElement)#4 (1) {
  [0]=>
  string(5) "index"
}
id: index

h2. Using Zend_Config_Xml possibly a global Zend_Config or other Zend_Config* types issue, I have not tested that_

<pre class="highlight">
<?php
set_include_path(
    get_include_path()
    . PATH_SEPARATOR . 'library/'
);

require_once 'Zend/Loader/Autoloader.php';
Zend_Loader_Autoloader::getInstance()->setFallbackAutoloader(true);

// Files with single file element
$xmlString1 = <<indexindex.html
XML;

// Files with multiple file elements
$xmlString2 = <<indexindex.htmlindex2index2.html
XML;

echo "Files with single file element, looping files->file:\n";
$xml1 = new Zend_Config_Xml($xmlString1);
foreach ($xml1->files->file as $file) {
    var_dump($file);
    printf("%s: %s\n", 'id', $file->id);
    printf("%s: %s\n", 'localtion', $file->location);
}
echo "Files with single file element, looping files->file->id:\n";
foreach ($xml1->files->file->id as $id) {
    var_dump($id);
    printf("%s: %s\n", 'id', $id);
}

echo "Files with multiple file elements, looping files->file:\n";
$xml2 = new Zend_Config_Xml($xmlString2);
foreach ($xml2->files->file as $file) {
    var_dump($file);
    printf("%s: %s\n", 'id', $file->id);
    printf("%s: %s\n", 'localtion', $file->location);
}
echo "Files with multiple file elements, looping files->file->id:\n";
foreach ($xml2->files->file->id as $id) {
    var_dump($id);
    printf("%s: %s\n", 'id', $id);
}



<pre class="literal">
Files with single file element, looping files->file:
string(5) "index"
<br></br><b>Notice</b>:  Trying to get property of non-object in <b>D:\www\htdocs\dev\config\config.php</b> on line <b>44</b><br></br>
id: 
<br></br><b>Notice</b>:  Trying to get property of non-object in <b>D:\www\htdocs\dev\config\config.php</b> on line <b>45</b><br></br>

localtion: 
string(10) "index.html"
<br></br><b>Notice</b>:  Trying to get property of non-object in <b>D:\www\htdocs\dev\config\config.php</b> on line <b>44</b><br></br>
id: 
<br></br><b>Notice</b>:  Trying to get property of non-object in <b>D:\www\htdocs\dev\config\config.php</b> on line <b>45</b><br></br>

localtion: 
Files with single file element, looping files->file->id:
<br></br><b>Warning</b>:  Invalid argument supplied for foreach() in <b>D:\www\htdocs\dev\config\config.php</b> on line <b>48</b><br></br>
Files with multiple file elements, looping files->file:
object(Zend_Config)#9 (8) {
  ["_allowModifications:protected"]=>
  bool(false)
  ["_index:protected"]=>
  int(0)
  ["_count:protected"]=>
  int(2)
  ["_data:protected"]=>
  array(2) {
    ["id"]=>
    string(5) "index"
    ["location"]=>
    string(10) "index.html"
  }
  ["_skipNextIteration:protected"]=>
  NULL
  ["_loadedSection:protected"]=>
  NULL
  ["_extends:protected"]=>
  array(0) {
  }
  ["_loadFileErrorStr:protected"]=>
  NULL
}
id: index
localtion: index.html
object(Zend_Config)#11 (8) {
  ["_allowModifications:protected"]=>
  bool(false)
  ["_index:protected"]=>
  int(0)
  ["_count:protected"]=>
  int(2)
  ["_data:protected"]=>
  array(2) {
    ["id"]=>
    string(6) "index2"
    ["location"]=>
    string(11) "index2.html"
  }
  ["_skipNextIteration:protected"]=>
  NULL
  ["_loadedSection:protected"]=>
  NULL
  ["_extends:protected"]=>
  array(0) {
  }
  ["_loadFileErrorStr:protected"]=>
  NULL
}
id: index2
localtion: index2.html
Files with multiple file elements, looping files->file->id:
<br></br><b>Warning</b>:  Invalid argument supplied for foreach() in <b>D:\www\htdocs\dev\config\config.php</b> on line <b>61</b><br></br>

{color:red}note:{color} Output rendered with PHP in error_reporting mode = E_ALL | E_STRICT

Posted by Rob Allen (rob) on 2009-09-04T09:31:17.000+0000

I'm open to ideas on how to solve this without breaking backwards compatibility.

Posted by Ben Scholzen (dasprid) on 2009-09-04T10:48:51.000+0000

You could just do:

<pre class="highlight">
$files = (isset($files->file[0]) ? $files->file : array($files->file));

And then just work with the $files variable as array. That works pretty well.

Posted by Wim Godden (wimg) on 2011-04-28T14:25:29.000+0000

Although this is fixable, fixing it will always break backwards compatibility. When a developer knows there's only 1 item, code such as this will be broken :

<pre class="highlight">
echo $config->files->file['id'];

Because it will in fact have to become :

<pre class="highlight">
$file = $config->files->file->toArray();
echo $file[0]['id'];

I would advise against modifying this for ZF 1.x - not sure how this will be handled in ZF 2, but introducing this backwards incompatibility is not a good idea in any case...

The only other option is to modify just the magic/fluent notation, but that will make things complicated and will cause inconsistency between fluent notation and array notation, which should be avoided.

Posted by Rob Allen (rob) on 2011-04-28T14:47:51.000+0000

One idea I have had is to introduce a children() method that always returns an iterator/array regardless of whether there is is one or many children:

<pre class="highlight">
$files = $config->files->children();
foreach ($files as $file) {
    echo $file->id;
}

Thoughts on this approach?

Posted by Rob Allen (rob) on 2011-05-27T02:30:37.000+0000

Moved to ZF2 as likely to involve a BC break.

Posted by Evan Coury (evan.pro) on 2012-07-21T00:46:22.000+0000

Approaching RC1, we need to decide if anything is going to be done about this.

Posted by Ralph Schindler (ralph) on 2012-10-08T20:15:38.000+0000

This issue has been closed on Jira and moved to GitHub for issue tracking. To continue following the resolution of this issues, please visit: https://github.com/zendframework/zf2/issues/2443

Have you found an issue?

See the Overview section for more details.

Copyright

© 2006-2016 by Zend, a Rogue Wave Company. Made with by awesome contributors.

This website is built using zend-expressive and it runs on PHP 7.

Contacts