API16

JRegistryFormatPHP/objectToString: Difference between revisions

From Joomla! Documentation

m clean up
m preparing for archive only
 
Line 6: Line 6:




{{subst:Description:JRegistryFormatPHP/objectToString}}
 


===Syntax===
===Syntax===
Line 62: Line 62:




{{subst:SeeAlso:JRegistryFormatPHP/objectToString}}
 


===Examples===
===Examples===
<CodeExamplesForm />
=== Code Examples ===
<dpl>
<dpl>
  noresultsheader=\n
  noresultsheader=\n
  category=objectToString
  category=objectToString
  category=JRegistryFormatPHP
  category=JRegistryFormatPHP
  category=CodeExample
  namespace=CodeExample
  category=MethodExample
  category=MethodExample
  include=*
  include=*
  format= ,,,
  format= ,,,
</dpl>
</dpl>

Latest revision as of 02:00, 25 March 2017

Description

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




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;
}



Examples

Code Examples