Skip to content
Permalink
Browse files

MDL-31789: Allowing context object to be passed to JS using json_enco…

…de()

Classes with magic properties such as context do not pass through json_encode().
The solution is to implement iterator in such classes and convert what we
feed to json_encode to array using 'foreach' before we pass it to json_encode():
- class context implements IteratorAggregate
- added function convert_to_array() that converts anything to array
- before calling json_encode we convert the argument to array
  • Loading branch information...
marinaglancy committed Mar 28, 2012
1 parent a81e8c4 commit 67ace38c8267cb3a5effb4cbe08045a0bd396c1b
Showing with 58 additions and 5 deletions.
  1. +20 −1 lib/accesslib.php
  2. +34 −0 lib/moodlelib.php
  3. +3 −3 lib/outputcomponents.php
  4. +1 −1 lib/outputrequirementslib.php
@@ -4487,7 +4487,7 @@ function role_change_permission($roleid, $context, $capname, $permission) {
* @property-read string $path path to context, starts with system context
* @property-read dept $depth
*/
abstract class context extends stdClass {
abstract class context extends stdClass implements IteratorAggregate {
/*
* Google confirms that no other important framework is using "context" class,
@@ -4695,6 +4695,25 @@ public function __unset($name) {
debugging('Can not unset context instance properties!');
}
// ====== implementing method from interface IteratorAggregate ======
/**
* Create an iterator because magic vars can't be seen by 'foreach'.
*
* Now we can convert context object to array using convert_to_array(),
* and feed it properly to json_encode().
*/
public function getIterator() {
$ret = array(
'id' => $this->id,
'contextlevel' => $this->contextlevel,
'instanceid' => $this->instanceid,
'path' => $this->path,
'depth' => $this->depth
);
return new ArrayIterator($ret);
}
// ====== general context methods ======
/**
@@ -10071,6 +10071,40 @@ function object_property_exists( $obj, $property ) {
return array_key_exists( $property, $properties );
}
/**
* Converts an object into an associative array
*
* This function converts an object into an associative array by iterating
* over its public properties. Because this function uses the foreach
* construct, Iterators are respected. It works recursively on arrays of objects.
* Arrays and simple values are returned as is.
*
* If class has magic properties, it can implement IteratorAggregate
* and return all available properties in getIterator()
*
* @param mixed $var
* @return array
*/
function convert_to_array($var) {
$result = array();
$references = array();
// loop over elements/properties
foreach ($var as $key => $value) {
// recursively convert objects
if (is_object($value) || is_array($value)) {
// but prevent cycles
if (!in_array($value, $references)) {
$result[$key] = convert_to_array($value);
$references[] = $value;
}
} else {
// simple values are untouched
$result[$key] = $value;
}
}
return $result;
}
/**
* Detect a custom script replacement in the data directory that will
@@ -1589,7 +1589,7 @@ class js_writer {
*/
public static function function_call($function, array $arguments = null, $delay=0) {
if ($arguments) {
$arguments = array_map('json_encode', $arguments);
$arguments = array_map('json_encode', convert_to_array($arguments));
$arguments = implode(', ', $arguments);
} else {
$arguments = '';
@@ -1611,7 +1611,7 @@ public static function function_call($function, array $arguments = null, $delay=
*/
public static function function_call_with_Y($function, array $extraarguments = null) {
if ($extraarguments) {
$extraarguments = array_map('json_encode', $extraarguments);
$extraarguments = array_map('json_encode', convert_to_array($extraarguments));
$arguments = 'Y, ' . implode(', ', $extraarguments);
} else {
$arguments = 'Y';
@@ -1630,7 +1630,7 @@ public static function function_call_with_Y($function, array $extraarguments = n
*/
public static function object_init($var, $class, array $arguments = null, array $requirements = null, $delay=0) {
if (is_array($arguments)) {
$arguments = array_map('json_encode', $arguments);
$arguments = array_map('json_encode', convert_to_array($arguments));
$arguments = implode(', ', $arguments);
}
@@ -715,7 +715,7 @@ public function yui_module($modules, $function, array $arguments = null, $galler
// Set Y's config.gallery to the version
$jscode = 'Y.config.gallery='.json_encode($galleryversion).';';
}
$jscode .= 'Y.use('.join(',', array_map('json_encode', $modules)).',function() {'.js_writer::function_call($function, $arguments).'});';
$jscode .= 'Y.use('.join(',', array_map('json_encode', convert_to_array($modules))).',function() {'.js_writer::function_call($function, $arguments).'});';
if ($ondomready) {
$jscode = "Y.on('domready', function() { $jscode });";
}

0 comments on commit 67ace38

Please sign in to comment.
You can’t perform that action at this time.