Extending XmlFormat? #59

GaryJones · 2012-07-03T23:50:53Z

For a method in a class, for which I want the XML root name and list of values that should be attributes to be changed, I know I can do:

<?php
/**
 * @class XmlFormat(root_name=foobar&attribute_names=xmlns,id)
 */

...before the method. However, I'm potentially going to have hundreds of methods across various classes, and this duplication seems somewhat redundant as I'll want the same root name across all of them, and same attribute sets across most of them.

What I'd like to do (but I couldn't get working), is to create my own format, that extends XmlFormat, but sets new default values for properties. Something like:

<?php
require 'restler/xmlformat.php';

class MyXmlFormat extends XmlFormat {
    public static $root_name = 'foobar';
    public static $attribute_names = array('xmlns', 'id');
}

or

<?php
require 'restler/xmlformat.php';

class MyXmlFormat extends XmlFormat {
    public __construct() {
        self::$root_name = 'foobar';
        self::$attribute_names = array('xmlns', 'id');
    }
}

...with

<?php
$r->setSupportedFormats('JsonFormat', 'MyXmlFormat');

in the index.php.

Is such a thing possible / am I heading along the right lines? Some use of var_dump() showed that a MyXmlFormat object was being used, but the static properties being returned via self::$... were not picking up the new values.

The text was updated successfully, but these errors were encountered:

Luracast · 2012-07-04T09:37:06Z

There is a much simpler way to achieve that. :)

You can use the following in index.php or a config php file that you will include in index.php

<?php
XmlFormat::$root_name = 'result';
XmlFormat::$attribute_names = array (
        'bmi',
        'message',
        'height',
        'weight' 
);

which will result with the following xml for the Multi-fomat example

<result bmi="31.77" message="Obesity">
    <metric height="162.6 centimeter" weight="84 kilograms"/>
    <imperial height="5 feet 4 inches" weight="185.19 pounds"/>
</result>

If you still prefer creating your own subclass you can write it as shown below

<?php
class MyXmlFormat extends XmlFormat {

    public function __construct() {
        parent::$root_name = 'result';
        parent::$attribute_names = array (
                'bmi',
                'message',
                'height',
                'weight' 
        );
    }
}

We found a bug with the auto-loader that comes with restler.php that will make it difficult to create a subclass of a format class (you need to manually include the class at the moment). We will release an update to fix this and then close this issue :)

…allowing us to subclass format classes with out manually including them

GaryJones · 2012-07-04T12:21:13Z

There is a much simpler way to achieve that. :)

Thought there should be - thanks for the pointers, and for Restler in general - it fits in exactly with the project I'm doing at the moment :-)

ghost assigned Luracast Jul 4, 2012

Luracast pushed a commit that referenced this issue Jul 4, 2012

Fixes the bug with autoloading format classes and thus fixes issue #59 …

9ddd9f2

…allowing us to subclass format classes with out manually including them

Luracast closed this as completed Jul 4, 2012

GaryJones unassigned Luracast Oct 11, 2019

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

Extending XmlFormat? #59

Extending XmlFormat? #59

Uh oh!

Uh oh!

Uh oh!

Extending XmlFormat? #59

Extending XmlFormat? #59

Comments

Uh oh!

Uh oh!