API16

API16:JRegistryFormatPHP/objectToString

From Joomla! Documentation

Revision as of 22:54, 22 March 2010 by Doxiki (talk | contribs) (New page: ===Description=== Converts an object into a php class string. NOTE: Only one depth level is supported. <span class="editsection" style="font-size:76%;"> <nowiki>[</nowiki>[[Descripti...)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

Description

Converts an object into a php class string. NOTE: Only one depth level is supported.


[Edit Descripton]

Template:Description:JRegistryFormatPHP/objectToString

Syntax

objectToString($object, $params)
Parameter Name Default Value Description
$object Data Source Object
$params Parameters used by the formatter

Returns

string Config class formatted string

Defined in

libraries/joomla/registry/format/php.php

Importing

jimport( 'joomla.registry.format.php' );

Source Body

public function objectToString($object, $params)
{
        // Build the object variables string
        $vars = '';
        foreach (get_object_vars($object) as $k => $v) {
                if (is_scalar($v)) {
                        $vars .= "\tpublic $". $k . " = '" . addcslashes($v, '\\\'') . "';\n";
                } else if (is_array($v)) {
                        $vars .= "\tpublic $". $k . " = " . $this->_getArrayString($v) . ";\n";
                }
        }

        $str = "<?php\nclass ".$params['class']." {\n";
        $str .= $vars;
        $str .= "}";

        // Use the closing tag if it not set to false in parameters.
        if (!isset($params['closingtag']) || $params['closingtag'] !== false) {
                $str .= "\n?>";
        }

        return $str;
}

[Edit See Also] Template:SeeAlso:JRegistryFormatPHP/objectToString

Examples

<CodeExamplesForm />