Merge branch 'feature/config' of https://github.com/silverstripe-scienceninjas/sapphire into config
This commit is contained in:
Sam Minnee
commit
317756d92a
|
|
@ -214,14 +214,9 @@ class RequestHandler extends ViewableData {
|
|||
* @return array|null
|
||||
*/
|
||||
public function allowedActions() {
|
||||
$actions = Object::combined_static(get_class($this), 'allowed_actions', 'RequestHandler');
|
||||
|
||||
foreach($this->extension_instances as $extension) {
|
||||
if($extensionActions = Object::get_static(get_class($extension), 'allowed_actions')) {
|
||||
$actions = array_merge($actions, $extensionActions);
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
$actions = Config::inst()->get(get_class($this), 'allowed_actions');
|
||||
|
||||
if($actions) {
|
||||
// convert all keys and values to lowercase to
|
||||
// allow for easier comparison, unless it is a permission code
|
||||
|
|
@ -230,7 +225,7 @@ class RequestHandler extends ViewableData {
|
|||
foreach($actions as $key => $value) {
|
||||
if(is_numeric($key)) $actions[$key] = strtolower($value);
|
||||
}
|
||||
|
||||
|
||||
return $actions;
|
||||
}
|
||||
}
|
||||
|
|
@ -258,7 +253,7 @@ class RequestHandler extends ViewableData {
|
|||
if($isKey || $isValue) return true;
|
||||
}
|
||||
|
||||
if(!is_array($actions) || !$this->uninherited('allowed_actions')) {
|
||||
if(!is_array($actions) || !$this->config()->get('allowed_actions', Config::UNINHERITED | Config::EXCLUDE_EXTRA_SOURCES)) {
|
||||
if($action != 'init' && $action != 'run' && method_exists($this, $action)) return true;
|
||||
}
|
||||
|
||||
|
|
@ -291,7 +286,7 @@ class RequestHandler extends ViewableData {
|
|||
return Permission::check($test);
|
||||
}
|
||||
|
||||
} elseif((($key = array_search($actionOrAll, $allowedActions)) !== false) && is_numeric($key)) {
|
||||
} elseif((($key = array_search($actionOrAll, $allowedActions, true)) !== false) && is_numeric($key)) {
|
||||
// Case 4: Allow numeric array notation (search for array value as action instead of key)
|
||||
return true;
|
||||
}
|
||||
|
|
@ -302,7 +297,7 @@ class RequestHandler extends ViewableData {
|
|||
// it should be allowed.
|
||||
if($action == 'index' || empty($action)) return true;
|
||||
|
||||
if($allowedActions === null || !$this->uninherited('allowed_actions')) {
|
||||
if($allowedActions === null || !$this->config()->get('allowed_actions', Config::UNINHERITED | Config::EXCLUDE_EXTRA_SOURCES)) {
|
||||
// If no allowed_actions are provided, then we should only let through actions that aren't handled by magic methods
|
||||
// we test this by calling the unmagic method_exists.
|
||||
if(method_exists($this, $action)) {
|
||||
|
|
|
|||
|
|
@ -0,0 +1,502 @@
|
|||
<?php
|
||||
|
||||
/**
|
||||
* The configuration system works like this:
|
||||
*
|
||||
* Each class has a set of named properties
|
||||
*
|
||||
* Each named property can contain either
|
||||
*
|
||||
* - An array
|
||||
* - A non-array value
|
||||
*
|
||||
* If the value is an array, each value in the array may also be one of those three types
|
||||
*
|
||||
* A property can have a value specified in multiple locations, each of which have a hardcoded or explicit priority.
|
||||
* We combine all these values together into a "composite" value using rules that depend on the priority order of the locations
|
||||
* to give the final value, using these rules:
|
||||
*
|
||||
* - If the value is an array, each array is added to the _beginning_ of the composite array in ascending priority order.
|
||||
* If a higher priority item has a non-integer key which is the same as a lower priority item, the value of those items
|
||||
* is merged using these same rules, and the result of the merge is located in the same location the higher priority item
|
||||
* would be if there was no key clash. Other than in this key-clash situation, within the particular array, order is preserved.
|
||||
*
|
||||
* - If the value is not an array, the highest priority value is used without any attempt to merge
|
||||
*
|
||||
* It is an error to have mixed types of the same named property in different locations (but an error will not necessarily
|
||||
* be raised due to optimisations in the lookup code)
|
||||
*
|
||||
* The exception to this is "false-ish" values - empty arrays, empty strings, etc. When merging a non-false-ish value with a
|
||||
* false-ish value, the result will be the non-false-ish value regardless of priority. When merging two false-sh values
|
||||
* the result will be the higher priority false-ish value.
|
||||
*
|
||||
* The locations that configuration values are taken from in highest -> lowest priority order
|
||||
*
|
||||
* - Any values set via a call to Config#update
|
||||
*
|
||||
* - The configuration values taken from the YAML files in _config directories (internally sorted in before / after order, where
|
||||
* the item that is latest is highest priority)
|
||||
*
|
||||
* - Any static set on an "additional static source" class (such as an extension) named the same as the name of the property
|
||||
*
|
||||
* - Any static set on the class named the same as the name of the property
|
||||
*
|
||||
* - The composite configuration value of the parent class of this class
|
||||
*
|
||||
* At some of these levels you can also set masks. These remove values from the composite value at their priority point rather than add.
|
||||
* They are much simpler. They consist of a list of key / value pairs. When applied against the current composite value
|
||||
*
|
||||
* - If the composite value is a sequential array, any member of that array that matches any value in the mask is removed
|
||||
*
|
||||
* - If the composite value is an associative array, any member of that array that matches both the key and value of any pair in the mask is removed
|
||||
*
|
||||
* - If the composite value is not an array, if that value matches any value in the mask it is removed
|
||||
*
|
||||
*
|
||||
*/
|
||||
class Config {
|
||||
|
||||
/** @var Object - A marker instance for the "anything" singleton value. Don't access directly, even in-class, always use self::anything() */
|
||||
static private $_anything = null;
|
||||
|
||||
/**
|
||||
* Get a marker class instance that is used to do a "remove anything with this key" by adding $key => Config::anything() to the suppress array
|
||||
* todo: Does this follow the SS coding conventions? Config::get_anything_marker_instance() is a lot less elegant.
|
||||
* @return Object
|
||||
*/
|
||||
static public function anything() {
|
||||
if (self::$_anything === null) self::$_anything = new stdClass();
|
||||
return self::$_anything;
|
||||
}
|
||||
|
||||
// -- Source options bitmask --
|
||||
|
||||
/** @const source options bitmask value - merge all parent configuration in as lowest priority */
|
||||
const INHERITED = 0;
|
||||
/** @const source options bitmask value - only get configuration set for this specific class, not any of it's parents */
|
||||
const UNINHERITED = 1;
|
||||
/** @const source options bitmask value - inherit, but stop on the first class that actually provides a value (event an empty value) */
|
||||
const FIRST_SET = 2;
|
||||
/** @const source options bitmask value - do not use additional statics sources (such as extension) */
|
||||
const EXCLUDE_EXTRA_SOURCES = 4;
|
||||
|
||||
// -- get_value_type response enum --
|
||||
|
||||
/** @const Return flag for get_value_type indicating value is a scalar (or really just not-an-array, at least ATM)*/
|
||||
const ISNT_ARRAY = 1;
|
||||
/** @const Return flag for get_value_type indicating value is an array */
|
||||
const IS_ARRAY = 2;
|
||||
|
||||
/**
|
||||
* Get whether the value is an array or not. Used to be more complicated, but still nice sugar to have an enum to compare
|
||||
* and not just a true/false value
|
||||
* @param $val any - The value
|
||||
* @return int - One of ISNT_ARRAY or IS_ARRAY
|
||||
*/
|
||||
static protected function get_value_type($val) {
|
||||
if (is_array($val)) return self::IS_ARRAY;
|
||||
return self::ISNT_ARRAY;
|
||||
}
|
||||
|
||||
/**
|
||||
* What to do if there's a type mismatch
|
||||
* @throws UnexpectedValueException
|
||||
*/
|
||||
static protected function type_mismatch() {
|
||||
throw new UnexpectedValueException('Type mismatch in configuration. All values for a particular property must contain the same type (or no value at all).');
|
||||
}
|
||||
|
||||
/* @todo If we can, replace next static & static methods with DI once that's in */
|
||||
static protected $instance;
|
||||
|
||||
/**
|
||||
* Get the current active Config instance.
|
||||
*
|
||||
* Configs should not normally be manually created.
|
||||
* In general use you will use this method to obtain the current Config instance.
|
||||
*
|
||||
* @return Config
|
||||
*/
|
||||
static public function inst() {
|
||||
if (!self::$instance) self::$instance = singleton('Config');
|
||||
return self::$instance;
|
||||
}
|
||||
|
||||
/**
|
||||
* Set the current active Config instance.
|
||||
*
|
||||
* Configs should not normally be manually created.
|
||||
* A use case for replacing the active configuration set would be for creating an isolated environment for
|
||||
* unit tests
|
||||
*
|
||||
* @return Config
|
||||
*/
|
||||
static public function set_instance($instance) {
|
||||
self::$instance = $instance;
|
||||
global $_SINGLETONS;
|
||||
$_SINGLETONS['Config'] = $instance;
|
||||
}
|
||||
|
||||
/**
|
||||
* Empty construction, otherwise calling singleton('Config') (not the right way to get the current active config
|
||||
* instance, but people might) gives an error
|
||||
*/
|
||||
function __construct() {
|
||||
}
|
||||
|
||||
/** @var [array] - Array of arrays. Each member is an nested array keyed as $class => $name => $value,
|
||||
* where value is a config value to treat as the highest priority item */
|
||||
protected $overrides = array();
|
||||
|
||||
/** @var [array] - Array of arrays. Each member is an nested array keyed as $class => $name => $value,
|
||||
* where value is a config value suppress from any lower priority item */
|
||||
protected $suppresses = array();
|
||||
|
||||
/** @var [array] - The list of settings pulled from config files to search through */
|
||||
protected $manifests = array();
|
||||
|
||||
/**
|
||||
* Add another manifest to the list of config manifests to search through.
|
||||
*
|
||||
* WARNING: Config manifests to not merge entries, and do not solve before/after rules inter-manifest -
|
||||
* instead, the last manifest to be added always wins
|
||||
*/
|
||||
public function pushConfigManifest(SS_ConfigManifest $manifest) {
|
||||
array_unshift($this->manifests, $manifest->yamlConfig);
|
||||
|
||||
// @todo: Do anything with these. They're for caching after config.php has executed
|
||||
$this->collectConfigPHPSettings = true;
|
||||
$this->configPHPIsSafe = false;
|
||||
|
||||
$manifest->activateConfig();
|
||||
|
||||
$this->collectConfigPHPSettings = false;
|
||||
}
|
||||
|
||||
static $extra_static_sources = array();
|
||||
|
||||
static function add_static_source($forclass, $donorclass) {
|
||||
self::$extra_static_sources[$forclass][] = $donorclass;
|
||||
}
|
||||
|
||||
/** @var [Config_ForClass] - The list of Config_ForClass instances, keyed off class */
|
||||
static protected $for_class_instances = array();
|
||||
|
||||
/**
|
||||
* Get an accessor that returns results by class by default.
|
||||
*
|
||||
* Shouldn't be overridden, since there might be many Config_ForClass instances already held in the wild. Each
|
||||
* Config_ForClass instance asks the current_instance of Config for the actual result, so override that instead
|
||||
*
|
||||
* @param $class
|
||||
* @return Config_ForClass
|
||||
*/
|
||||
public function forClass($class) {
|
||||
if (isset(self::$for_class_instances[$class])) {
|
||||
return self::$for_class_instances[$class];
|
||||
}
|
||||
else {
|
||||
return self::$for_class_instances[$class] = new Config_ForClass($class);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Merge a lower priority associative array into an existing higher priority associative array, as per the class
|
||||
* docblock rules
|
||||
*
|
||||
* It is assumed you've already checked that you've got two associative arrays, not scalars or sequential arrays
|
||||
*
|
||||
* @param $dest array - The existing high priority associative array
|
||||
* @param $src array - The low priority associative array to merge in
|
||||
*/
|
||||
static function merge_array_low_into_high(&$dest, $src) {
|
||||
foreach ($src as $k => $v) {
|
||||
if (!$v) {
|
||||
continue;
|
||||
}
|
||||
else if (is_int($k)) {
|
||||
$dest[] = $v;
|
||||
}
|
||||
else if (isset($dest[$k])) {
|
||||
$newType = self::get_value_type($v);
|
||||
$currentType = self::get_value_type($dest[$k]);
|
||||
|
||||
// Throw error if types don't match
|
||||
if ($currentType !== $newType) self::type_mismatch();
|
||||
|
||||
if ($currentType == self::IS_ARRAY) self::merge_array_low_into_high($dest[$k], $v);
|
||||
else continue;
|
||||
}
|
||||
else {
|
||||
$dest[$k] = $v;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Merge a higher priority assocative array into an existing lower priority associative array, as per the class
|
||||
* docblock rules.
|
||||
*
|
||||
* Much more expensive that the other way around, as there's no way to insert an associative k/v pair into an
|
||||
* array at the top of the array
|
||||
*
|
||||
* @static
|
||||
* @param $dest array - The existing low priority associative array
|
||||
* @param $src array - The high priority array to merge in
|
||||
*/
|
||||
static function merge_array_high_into_low(&$dest, $src) {
|
||||
$res = $src;
|
||||
self::merge_array_low_into_high($res, $dest);
|
||||
$dest = $res;
|
||||
}
|
||||
|
||||
static function merge_high_into_low(&$result, $value) {
|
||||
if (!$value) return;
|
||||
$newType = self::get_value_type($value);
|
||||
|
||||
if (!$result) {
|
||||
$result = $value;
|
||||
}
|
||||
else {
|
||||
$currentType = self::get_value_type($result);
|
||||
if ($currentType !== $newType) self::type_mismatch();
|
||||
|
||||
if ($currentType == self::ISNT_ARRAY) $result = $value;
|
||||
else self::merge_array_high_into_low($result, $value);
|
||||
}
|
||||
}
|
||||
|
||||
static function merge_low_into_high(&$result, $value, $suppress) {
|
||||
$newType = self::get_value_type($value);
|
||||
|
||||
if ($suppress) {
|
||||
if ($newType == self::IS_ARRAY) {
|
||||
$value = self::filter_array_by_suppress_array($value, $suppress);
|
||||
if (!$value) return;
|
||||
}
|
||||
else {
|
||||
if (self::check_value_contained_in_suppress_array($value, $suppress)) return;
|
||||
}
|
||||
}
|
||||
|
||||
if (!$result) {
|
||||
$result = $value;
|
||||
}
|
||||
else {
|
||||
$currentType = self::get_value_type($result);
|
||||
if ($currentType !== $newType) self::type_mismatch();
|
||||
|
||||
if ($currentType == self::ISNT_ARRAY) return; // PASS
|
||||
else self::merge_array_low_into_high($result, $value);
|
||||
}
|
||||
}
|
||||
|
||||
static function check_value_contained_in_suppress_array($v, $suppresses) {
|
||||
foreach ($suppresses as $suppress) {
|
||||
list($sk, $sv) = $suppress;
|
||||
if ($sv === self::anything() || $v == $sv) return true;
|
||||
}
|
||||
return false;
|
||||
}
|
||||
|
||||
static protected function check_key_or_value_contained_in_suppress_array($k, $v, $suppresses) {
|
||||
foreach ($suppresses as $suppress) {
|
||||
list($sk, $sv) = $suppress;
|
||||
if (($sk === self::anything() || $k == $sk) && ($sv === self::anything() || $v == $sv)) return true;
|
||||
}
|
||||
return false;
|
||||
}
|
||||
|
||||
static protected function filter_array_by_suppress_array($array, $suppress) {
|
||||
$res = array();
|
||||
|
||||
foreach ($array as $k => $v) {
|
||||
$suppressed = self::check_key_or_value_contained_in_suppress_array($k, $v, $suppress);
|
||||
|
||||
if (!$suppressed) {
|
||||
if (is_numeric($k)) $res[] = $v;
|
||||
else $res[$k] = $v;
|
||||
}
|
||||
}
|
||||
|
||||
return $res;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the config value associated for a given class and property
|
||||
*
|
||||
* This merges all current sources and overrides together to give final value
|
||||
* todo: Currently this is done every time. This function is an inner loop function, so we really need to be caching heavily here.
|
||||
*
|
||||
* @param $class string - The name of the class to get the value for
|
||||
* @param $name string - The property to get the value for
|
||||
* @param int $sourceOptions - Bitmask which can be set to some combintain of Config::UNINHERITED, Config::FIRST_SET, and Config::EXCLUDE_EXTENSIONS.
|
||||
* Config::UNINHERITED does not include parent classes when merging configuration fragments
|
||||
* Config::FIRST_SET stops inheriting once the first class that sets a value (even an empty value) is encoutered
|
||||
* Config::EXCLUDE_EXTRA_SOURCES does not include any additional static sources (such as extensions)
|
||||
*
|
||||
* Config::INHERITED is a utility constant that can be used to mean "none of the above", equvilient to 0
|
||||
* Setting both Config::UNINHERITED and Config::FIRST_SET behaves the same as just Config::UNINHERITED
|
||||
*
|
||||
* should the parent classes value be merged in as the lowest priority source?
|
||||
* @param null $result array|scalar - Reference to a variable to put the result in. Also returned, so this can be left as null safely. If you do pass a value, it will be treated as the highest priority value in the result chain
|
||||
* @param null $suppress array - Internal use when called by child classes. Array of mask pairs to filter value by
|
||||
* @return array|scalar - The value of the config item, or null if no value set. Could be an associative array, sequential array or scalar depending on value (see class docblock)
|
||||
*/
|
||||
function get($class, $name, $sourceOptions = 0, &$result = null, $suppress = null) {
|
||||
// If result is already not something to merge into, just return it
|
||||
if ($result !== null && !is_array($result)) return $result;
|
||||
|
||||
// First, look through the override values
|
||||
foreach($this->overrides as $k => $overrides) {
|
||||
if (isset($overrides[$class][$name])) {
|
||||
$value = $overrides[$class][$name];
|
||||
|
||||
self::merge_low_into_high($result, $value, $suppress);
|
||||
if ($result !== null && !is_array($result)) return $result;
|
||||
}
|
||||
|
||||
if (isset($this->suppresses[$k][$class][$name])) {
|
||||
$suppress = $suppress ? array_merge($suppress, $this->suppresses[$k][$class][$name]) : $this->suppresses[$k][$class][$name];
|
||||
}
|
||||
}
|
||||
|
||||
// Then the manifest values
|
||||
foreach($this->manifests as $manifest) {
|
||||
if (isset($manifest[$class][$name])) {
|
||||
self::merge_low_into_high($result, $manifest[$class][$name], $suppress);
|
||||
if ($result !== null && !is_array($result)) return $result;
|
||||
}
|
||||
}
|
||||
|
||||
// Then look at the static variables
|
||||
$nothing = new stdClass();
|
||||
$classes = array($class);
|
||||
// Include extensions only if not flagged not to, and some have been set
|
||||
if ((($sourceOptions & self::EXCLUDE_EXTRA_SOURCES) != self::EXCLUDE_EXTRA_SOURCES) && isset(self::$extra_static_sources[$class])) {
|
||||
$classes = array_merge($classes, self::$extra_static_sources[$class]);
|
||||
}
|
||||
|
||||
foreach ($classes as $staticSource) {
|
||||
$value = Object::static_lookup($staticSource, $name, $nothing);
|
||||
|
||||
if ($value !== $nothing) {
|
||||
self::merge_low_into_high($result, $value, $suppress);
|
||||
if ($result !== null && !is_array($result)) return $result;
|
||||
}
|
||||
}
|
||||
|
||||
// Finally, merge in the values from the parent class
|
||||
if (($sourceOptions & self::UNINHERITED) != self::UNINHERITED && (($sourceOptions & self::FIRST_SET) != self::FIRST_SET || $result === null)) {
|
||||
$parent = get_parent_class($class);
|
||||
if ($parent) $this->get($parent, $name, $sourceOptions, $result, $suppress);
|
||||
}
|
||||
|
||||
if ($name == 'routes') {
|
||||
print_r($result); die;
|
||||
}
|
||||
|
||||
return $result;
|
||||
}
|
||||
|
||||
/**
|
||||
* Update a configuration value
|
||||
*
|
||||
* Configuration is modify only. The value passed is merged into the existing configuration. If you want to replace the
|
||||
* current value, you'll need to call remove first.
|
||||
*
|
||||
* @param $class string - The class to update a configuration value for
|
||||
* @param $name string - The configuration property name to update
|
||||
* @param $value any - The value to update with
|
||||
*
|
||||
* Arrays are recursively merged into current configuration as "latest" - for associative arrays the passed value
|
||||
* replaces any item with the same key, for sequential arrays the items are placed at the end of the array, for
|
||||
* non-array values, this value replaces any existing value
|
||||
*
|
||||
* You will get an error if you try and override array values with non-array values or vice-versa
|
||||
*/
|
||||
function update($class, $name, $val) {
|
||||
if (!isset($this->overrides[0][$class])) $this->overrides[0][$class] = array();
|
||||
|
||||
if (!isset($this->overrides[0][$class][$name])) $this->overrides[0][$class][$name] = $val;
|
||||
else self::merge_high_into_low($this->overrides[0][$class][$name], $val);
|
||||
}
|
||||
|
||||
/**
|
||||
* Remove a configuration value
|
||||
*
|
||||
* You can specify a key, a key and a value, or neither. Either argument can be Config::anything(), which is
|
||||
* what is defaulted to if you don't specify something
|
||||
*
|
||||
* This removes any current configuration value that matches the key and/or value specified
|
||||
*
|
||||
* Works like this:
|
||||
* - Check the current override array, and remove any values that match the arguments provided
|
||||
* - Keeps track of the arguments passed to this method, and in get filters everything _except_ the current override array to
|
||||
* exclude any match
|
||||
*
|
||||
* This way we can re-set anything removed by a call to this function by calling set. Because the current override
|
||||
* array is only filtered immediately on calling this remove method, that value will then be exposed. However, every
|
||||
* other source is filtered on request, so no amount of changes to parent's configuration etc can override a remove call.
|
||||
*
|
||||
* @param $class string - The class to remove a configuration value from
|
||||
* @param $name string - The configuration name
|
||||
* @param $key any - An optional key to filter against.
|
||||
* If referenced config value is an array, only members of that array that match this key will be removed
|
||||
* Must also match value if provided to be removed
|
||||
* @param $value any - And optional value to filter against.
|
||||
* If referenced config value is an array, only members of that array that match this value will be removed
|
||||
* If referenced config value is not an array, value will be removed only if it matches this argument
|
||||
* Must also match key if provided and referenced config value is an array to be removed
|
||||
*
|
||||
* Matching is always by "==", not by "==="
|
||||
*/
|
||||
function remove($class, $name) {
|
||||
$argc = func_num_args();
|
||||
$key = $argc > 2 ? func_get_arg(2) : self::anything();
|
||||
$value = $argc > 3 ? func_get_arg(3) : self::anything();
|
||||
|
||||
$suppress = array($key, $value);
|
||||
|
||||
if (isset($this->overrides[0][$class][$name])) {
|
||||
$value = $this->overrides[0][$class][$name];
|
||||
|
||||
if (is_array($value)) {
|
||||
$this->overrides[0][$class][$name] = self::filter_array_by_suppress_array($value, array($suppress));
|
||||
}
|
||||
else {
|
||||
if (self::check_value_contained_in_suppress_array($value, array($suppress))) unset($this->overrides[0][$class][$name]);
|
||||
}
|
||||
}
|
||||
|
||||
if (!isset($this->suppresses[0][$class])) $this->suppresses[0][$class] = array();
|
||||
if (!isset($this->suppresses[0][$class][$name])) $this->suppresses[0][$class][$name] = array();
|
||||
|
||||
$this->suppresses[0][$class][$name][] = $suppress;
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
class Config_ForClass {
|
||||
protected $class;
|
||||
|
||||
function __construct($class) {
|
||||
$this->class = $class;
|
||||
}
|
||||
|
||||
function __get($name) {
|
||||
return Config::inst()->get($this->class, $name);
|
||||
}
|
||||
|
||||
function __set($name, $val) {
|
||||
return Config::inst()->update($this->class, $name, $val);
|
||||
}
|
||||
|
||||
function get($name, $sourceOptions = 0) {
|
||||
return Config::inst()->get($this->class, $name, $sourceOptions);
|
||||
}
|
||||
|
||||
function forClass($class) {
|
||||
return Config::inst()->forClass($class);
|
||||
}
|
||||
}
|
||||
|
|
@ -258,6 +258,10 @@ $loader = SS_ClassLoader::instance();
|
|||
$loader->registerAutoloader();
|
||||
$loader->pushManifest($manifest);
|
||||
|
||||
// Now that the class manifest is up, load the configuration
|
||||
$configManifest = new SS_ConfigManifest(BASE_PATH, false, $flush);
|
||||
Config::inst()->pushConfigManifest($configManifest);
|
||||
|
||||
SS_TemplateLoader::instance()->pushManifest(new SS_TemplateManifest(
|
||||
BASE_PATH, false, isset($_GET['flush'])
|
||||
));
|
||||
|
|
|
|||
|
|
@ -0,0 +1,74 @@
|
|||
<?php
|
||||
|
||||
/**
|
||||
* A Directed Acyclic Graph - used for doing topological sorts on dependencies, such as the before/after conditions
|
||||
* in config yaml fragments
|
||||
*/
|
||||
class SS_DAG {
|
||||
/** @var array|null - The nodes/vertices in the graph. Should be a numeric sequence of items (no string keys, no gaps). */
|
||||
protected $data;
|
||||
|
||||
/** @var array - The edges in the graph, in $to_idx => [$from_idx1, $from_idx2, ...] format */
|
||||
protected $dag;
|
||||
|
||||
function __construct($data = null) {
|
||||
$data = $data ? array_values($data) : array();
|
||||
|
||||
$this->data = $data;
|
||||
$this->dag = array_fill_keys(array_keys($data), array());
|
||||
}
|
||||
|
||||
/**
|
||||
* Add another node/vertex
|
||||
* @param $item anything - The item to add to the graph
|
||||
*/
|
||||
function additem($item) {
|
||||
$this->data[] = $item;
|
||||
$this->dag[] = array();
|
||||
}
|
||||
|
||||
/**
|
||||
* Add an edge from one vertex to another
|
||||
* @param $from integer|any - The index in $data of the node/vertex, or the node/vertex itself, that the edge goes from
|
||||
* @param $to integer|any - The index in $data of the node/vertex, or the node/vertex itself, that the edge goes to
|
||||
*
|
||||
* When passing actual nodes (as opposed to indexes), uses array_search with strict = true to find
|
||||
*/
|
||||
function addedge($from, $to) {
|
||||
$i = is_numeric($from) ? $from : array_search($from, $this->data, true);
|
||||
$j = is_numeric($to) ? $to : array_search($to, $this->data, true);
|
||||
|
||||
if ($i === false) throw new Exception("Couldnt find 'from' item in data when adding edge to DAG");
|
||||
if ($j === false) throw new Exception("Couldnt find 'to' item in data when adding edge to DAG");
|
||||
|
||||
if (!isset($this->dag[$j])) $this->dag[$j] = array();
|
||||
$this->dag[$j][] = $i;
|
||||
}
|
||||
|
||||
/**
|
||||
* Sort graph so that each node (a) comes before any nodes (b) where an edge exists from a to b
|
||||
* @return array - The nodes
|
||||
* @throws Exception - If the graph is cyclic (and so can't be sorted)
|
||||
*/
|
||||
function sort() {
|
||||
$data = $this->data; $dag = $this->dag; $sorted = array();
|
||||
|
||||
while (true) {
|
||||
$withedges = array_filter($dag, 'count');
|
||||
$starts = array_diff_key($dag, $withedges);
|
||||
|
||||
if (!count($starts)) break;
|
||||
|
||||
foreach ($starts as $i => $foo) $sorted[] = $data[$i];
|
||||
|
||||
foreach ($withedges as $j => $deps) {
|
||||
$withedges[$j] = array_diff($withedges[$j], array_keys($starts));
|
||||
}
|
||||
|
||||
$dag = $withedges;
|
||||
}
|
||||
|
||||
if ($dag) throw new Exception("DAG has cyclic requirements");
|
||||
return $sorted;
|
||||
}
|
||||
}
|
||||
|
|
@ -43,6 +43,19 @@ abstract class Extension {
|
|||
$this->class = get_class($this);
|
||||
}
|
||||
|
||||
/**
|
||||
* Called when this extension is added to a particular class
|
||||
*
|
||||
* TODO: This is likely to be replaced by event sytem before 3.0 final, so be aware
|
||||
* this API is fairly unstable.
|
||||
*
|
||||
* @static
|
||||
* @param $class
|
||||
*/
|
||||
static function add_to_class($class, $extensionClass) {
|
||||
Config::add_static_source($class, $extensionClass);
|
||||
}
|
||||
|
||||
/**
|
||||
* Set the owner of this extension.
|
||||
* @param Object $owner The owner object,
|
||||
|
|
@ -85,6 +98,8 @@ abstract class Extension {
|
|||
public static function get_classname_without_arguments($extensionStr) {
|
||||
return (($p = strpos($extensionStr, '(')) !== false) ? substr($extensionStr, 0, $p) : $extensionStr;
|
||||
}
|
||||
|
||||
|
||||
|
||||
|
||||
}
|
||||
|
||||
|
|
|
|||
340
core/Object.php
340
core/Object.php
|
|
@ -36,19 +36,6 @@ abstract class Object {
|
|||
*/
|
||||
public static $extensions = null;
|
||||
|
||||
/**#@+
|
||||
* @var array
|
||||
*/
|
||||
|
||||
private static
|
||||
$statics = array(),
|
||||
$cached_statics = array(),
|
||||
$uninherited_statics = array(),
|
||||
$cached_uninherited_statics = array(),
|
||||
$extra_statics = array(),
|
||||
$replaced_statics = array(),
|
||||
$_cache_statics_prepared = array();
|
||||
|
||||
private static
|
||||
$classes_constructed = array(),
|
||||
$extra_methods = array(),
|
||||
|
|
@ -64,7 +51,26 @@ abstract class Object {
|
|||
* @var string the class name
|
||||
*/
|
||||
public $class;
|
||||
|
||||
|
||||
|
||||
/**
|
||||
* @todo Set this via dependancy injection? Can't call it $config, because too many clashes with form elements etc
|
||||
* @var Config_ForClass
|
||||
*/
|
||||
private $_config_forclass = null;
|
||||
|
||||
/**
|
||||
* Get a configuration accessor for this class. Short hand for Config::inst()->get($this->class, .....).
|
||||
* @return Config_ForClass|null
|
||||
*/
|
||||
public function config() {
|
||||
if (!$this->_config_forclass) {
|
||||
$this->_config_forclass = Config::inst()->forClass($this->class);
|
||||
}
|
||||
|
||||
return $this->_config_forclass;
|
||||
}
|
||||
|
||||
/**
|
||||
* @var array all current extension instances.
|
||||
*/
|
||||
|
|
@ -255,7 +261,55 @@ abstract class Object {
|
|||
|
||||
return $class;
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* Get the value of a static property of a class, even in that property is declared protected (but not private), without any inheritance,
|
||||
* merging or parent lookup if it doesn't exist on the given class
|
||||
*
|
||||
* In 5.3, we can do this fast using $foo::$bar syntax, but this method then needs to be in a base class of $class
|
||||
* to bust the protected def
|
||||
*
|
||||
* @static
|
||||
* @param $class - The class to get the static from
|
||||
* @param $name - The property to get from the class
|
||||
* @param null $default - The value to return if property doesn't exist on class
|
||||
* @return any - The value of the static property $name on class $class, or $default if that property is not defined
|
||||
*/
|
||||
public static function static_lookup($class, $name, $default = null) {
|
||||
if (version_compare(PHP_VERSION, '5.4', '>=') && is_subclass_of($class, 'Object')) {
|
||||
if (isset($class::$$name)) {
|
||||
$parent = get_parent_class($class);
|
||||
if (!$parent || !isset($parent::$$name) || $parent::$$name !== $class::$$name) return $class::$$name;
|
||||
}
|
||||
return $default;
|
||||
}
|
||||
else {
|
||||
// TODO: This gets set once, then not updated, so any changes to statics after this is called the first time for any class won't be exposed
|
||||
static $static_properties = array();
|
||||
|
||||
if (!isset($static_properties[$class])) {
|
||||
$reflection = new ReflectionClass($class);
|
||||
$static_properties[$class] = $reflection->getStaticProperties();
|
||||
}
|
||||
|
||||
if (isset($static_properties[$class][$name])) {
|
||||
$value = $static_properties[$class][$name];
|
||||
|
||||
$parent = get_parent_class($class);
|
||||
if (!$parent) return $value;
|
||||
|
||||
if (!isset($static_properties[$parent])) {
|
||||
$reflection = new ReflectionClass($parent);
|
||||
$static_properties[$parent] = $reflection->getStaticProperties();
|
||||
}
|
||||
|
||||
if (!isset($static_properties[$parent][$name]) || $static_properties[$parent][$name] !== $value) return $value;
|
||||
}
|
||||
}
|
||||
|
||||
return $default;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get a static variable, taking into account SS's inbuild static caches and pseudo-statics
|
||||
*
|
||||
|
|
@ -275,64 +329,8 @@ abstract class Object {
|
|||
* @return mixed
|
||||
*/
|
||||
public static function get_static($class, $name, $uncached = false) {
|
||||
if(!isset(self::$_cache_statics_prepared[$class])) {
|
||||
Object::prepare_statics($class);
|
||||
}
|
||||
|
||||
if(!isset(self::$cached_statics[$class][$name]) || $uncached) {
|
||||
$extra = $builtIn = $break = $replacedAt = false;
|
||||
$ancestry = array_reverse(ClassInfo::ancestry($class));
|
||||
|
||||
// traverse up the class tree and build extra static and stop information
|
||||
foreach($ancestry as $ancestor) {
|
||||
if(isset(self::$extra_statics[$ancestor][$name])) {
|
||||
$toMerge = self::$extra_statics[$ancestor][$name];
|
||||
|
||||
if(is_array($toMerge) && is_array($extra)) {
|
||||
$extra = array_merge($toMerge, $extra);
|
||||
} elseif(!$extra) {
|
||||
$extra = $toMerge;
|
||||
} else {
|
||||
$break = true;
|
||||
}
|
||||
|
||||
if(isset(self::$replaced_statics[$ancestor][$name])) $replacedAt = $break = $ancestor;
|
||||
|
||||
if($break) break;
|
||||
}
|
||||
}
|
||||
|
||||
// check whether to merge in the default value
|
||||
if($replacedAt && ($replacedAt == $class || !is_array($extra))) {
|
||||
$value = $extra;
|
||||
} elseif($replacedAt) {
|
||||
// determine whether to merge in lower-class variables
|
||||
$ancestorRef = new ReflectionClass(reset($ancestry));
|
||||
$ancestorProps = $ancestorRef->getStaticProperties();
|
||||
$ancestorInbuilt = array_key_exists($name, $ancestorProps) ? $ancestorProps[$name] : null;
|
||||
|
||||
$replacedRef = new ReflectionClass($replacedAt);
|
||||
$replacedProps = $replacedRef->getStaticProperties();
|
||||
$replacedInbuilt = array_key_exists($name, $replacedProps) ? $replacedProps[$name] : null;
|
||||
|
||||
if($ancestorInbuilt != $replacedInbuilt) {
|
||||
$value = is_array($ancestorInbuilt) ? array_merge($ancestorInbuilt, (array) $extra) : $extra;
|
||||
} else {
|
||||
$value = $extra;
|
||||
}
|
||||
} else {
|
||||
// get a built-in value
|
||||
$reflector = new ReflectionClass($class);
|
||||
$props = $reflector->getStaticProperties();
|
||||
$inbuilt = array_key_exists($name, $props) ? $props[$name] : null;
|
||||
$value = isset($extra) && is_array($extra) ? array_merge($extra, (array) $inbuilt) : $inbuilt;
|
||||
}
|
||||
|
||||
self::$cached_statics[$class][$name] = true;
|
||||
self::$statics[$class][$name] = $value;
|
||||
}
|
||||
|
||||
return self::$statics[$class][$name];
|
||||
Deprecation::notice('3.1.0', 'combined_static is deprecated, replaced by Config#get');
|
||||
return Config::inst()->get($class, $name, Config::FIRST_SET);
|
||||
}
|
||||
|
||||
/**
|
||||
|
|
@ -343,14 +341,8 @@ abstract class Object {
|
|||
* @param mixed $value
|
||||
*/
|
||||
public static function set_static($class, $name, $value) {
|
||||
if(!isset(self::$_cache_statics_prepared[$class])) {
|
||||
Object::prepare_statics($class);
|
||||
}
|
||||
|
||||
self::$statics[$class][$name] = $value;
|
||||
self::$uninherited_statics[$class][$name] = $value;
|
||||
self::$cached_statics[$class][$name] = true;
|
||||
self::$cached_uninherited_statics[$class][$name] = true;
|
||||
Deprecation::notice('3.1.0', 'set_static is deprecated, replaced by Config#set');
|
||||
Config::inst()->update($class, $name, $value);
|
||||
}
|
||||
|
||||
/**
|
||||
|
|
@ -366,39 +358,8 @@ abstract class Object {
|
|||
* @return mixed
|
||||
*/
|
||||
public static function uninherited_static($class, $name, $uncached = false) {
|
||||
if(!isset(self::$_cache_statics_prepared[$class])) {
|
||||
Object::prepare_statics($class);
|
||||
}
|
||||
|
||||
if(!isset(self::$cached_uninherited_statics[$class][$name]) || $uncached) {
|
||||
$classRef = new ReflectionClass($class);
|
||||
$classProp = $classRef->getStaticPropertyValue($name, null);
|
||||
|
||||
$parentClass = get_parent_class($class);
|
||||
if($parentClass) {
|
||||
$parentRef = new ReflectionClass($parentClass);
|
||||
$parentProp = $parentRef->getStaticPropertyValue($name, null);
|
||||
if($parentProp == $classProp) $classProp = null;
|
||||
}
|
||||
|
||||
// Add data from extra_statics if it has been applied to this specific class (it
|
||||
// wouldn't make sense to have them inherit in this method). This is kept separate
|
||||
// from the equivalent get_static code because it's so much simpler
|
||||
if(isset(self::$extra_statics[$class][$name])) {
|
||||
$toMerge = self::$extra_statics[$class][$name];
|
||||
|
||||
if(is_array($toMerge) && is_array($classProp)) {
|
||||
$classProp = array_merge($toMerge, $classProp);
|
||||
} elseif(!$classProp) {
|
||||
$classProp = $toMerge;
|
||||
}
|
||||
}
|
||||
|
||||
self::$cached_uninherited_statics[$class][$name] = true;
|
||||
self::$uninherited_statics[$class][$name] = $classProp;
|
||||
}
|
||||
|
||||
return self::$uninherited_statics[$class][$name];
|
||||
Deprecation::notice('3.1.0', 'uninherited_static is deprecated, replaced by Config#get');
|
||||
return Config::inst()->get($class, $name, Config::UNINHERITED);
|
||||
}
|
||||
|
||||
/**
|
||||
|
|
@ -412,24 +373,10 @@ abstract class Object {
|
|||
* @return mixed
|
||||
*/
|
||||
public static function combined_static($class, $name, $ceiling = false) {
|
||||
$ancestry = ClassInfo::ancestry($class);
|
||||
$values = null;
|
||||
|
||||
if($ceiling) while(current($ancestry) != $ceiling && $ancestry) {
|
||||
array_shift($ancestry);
|
||||
}
|
||||
|
||||
if($ancestry) foreach($ancestry as $ancestor) {
|
||||
$merge = self::uninherited_static($ancestor, $name);
|
||||
|
||||
if(is_array($values) && is_array($merge)) {
|
||||
$values = array_merge($values, $merge);
|
||||
} elseif($merge) {
|
||||
$values = $merge;
|
||||
}
|
||||
}
|
||||
|
||||
return $values;
|
||||
if ($ceiling) throw new Exception('Ceiling argument to combined_static is no longer supported');
|
||||
|
||||
Deprecation::notice('3.1.0', 'combined_static is deprecated, replaced by Config#get');
|
||||
return Config::inst()->get($class, $name);
|
||||
}
|
||||
|
||||
/**
|
||||
|
|
@ -440,6 +387,7 @@ abstract class Object {
|
|||
* @param bool $replace replace existing static vars
|
||||
*/
|
||||
public static function addStaticVars($class, $properties, $replace = false) {
|
||||
Deprecation::notice('3.1.0', 'addStaticVars is deprecated, replaced by Config#set');
|
||||
foreach($properties as $prop => $value) self::add_static_var($class, $prop, $value, $replace);
|
||||
}
|
||||
|
||||
|
|
@ -460,23 +408,12 @@ abstract class Object {
|
|||
* @param bool $replace completely replace existing static values
|
||||
*/
|
||||
public static function add_static_var($class, $name, $value, $replace = false) {
|
||||
if(is_array($value) && isset(self::$extra_statics[$class][$name]) && !$replace) {
|
||||
self::$extra_statics[$class][$name] = array_merge_recursive(self::$extra_statics[$class][$name], $value);
|
||||
} else {
|
||||
self::$extra_statics[$class][$name] = $value;
|
||||
}
|
||||
|
||||
if ($replace) {
|
||||
self::set_static($class, $name, $value);
|
||||
self::$replaced_statics[$class][$name] = true;
|
||||
|
||||
// Clear caches
|
||||
} else {
|
||||
self::$cached_statics[$class][$name] = null;
|
||||
self::$cached_uninherited_statics[$class][$name] = null;
|
||||
}
|
||||
Deprecation::notice('3.1.0', 'add_static_var is deprecated, replaced by Config#set');
|
||||
|
||||
if ($replace) Config::inst()->remove($class, $name);
|
||||
Config::inst()->update($class, $name, $value);
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* Return TRUE if a class has a specified extension
|
||||
*
|
||||
|
|
@ -485,7 +422,9 @@ abstract class Object {
|
|||
*/
|
||||
public static function has_extension($class, $requiredExtension) {
|
||||
$requiredExtension = strtolower($requiredExtension);
|
||||
if($extensions = self::combined_static($class, 'extensions')) foreach($extensions as $extension) {
|
||||
$extensions = Config::inst()->get($class, 'extensions');
|
||||
|
||||
if($extensions) foreach($extensions as $extension) {
|
||||
$left = strtolower(Extension::get_classname_without_arguments($extension));
|
||||
$right = strtolower(Extension::get_classname_without_arguments($requiredExtension));
|
||||
if($left == $right) return true;
|
||||
|
|
@ -520,68 +459,25 @@ abstract class Object {
|
|||
}
|
||||
|
||||
// unset some caches
|
||||
self::$cached_statics[$class]['extensions'] = null;
|
||||
$subclasses = ClassInfo::subclassesFor($class);
|
||||
$subclasses[] = $class;
|
||||
|
||||
if($subclasses) foreach($subclasses as $subclass) {
|
||||
unset(self::$classes_constructed[$subclass]);
|
||||
unset(self::$extra_methods[$subclass]);
|
||||
}
|
||||
|
||||
// merge with existing static vars
|
||||
$extensions = self::uninherited_static($class, 'extensions');
|
||||
|
||||
// We use unshift rather than push so that module extensions are added before built-in ones.
|
||||
// in particular, this ensures that the Versioned rewriting is done last.
|
||||
if($extensions) array_unshift($extensions, $extension);
|
||||
else $extensions = array($extension);
|
||||
|
||||
self::set_static($class, 'extensions', $extensions);
|
||||
|
||||
|
||||
Config::inst()->update($class, 'extensions', array($extension));
|
||||
|
||||
// load statics now for DataObject classes
|
||||
if(is_subclass_of($class, 'DataObject')) {
|
||||
if(is_subclass_of($extensionClass, 'DataExtension')) {
|
||||
DataExtension::load_extra_statics($class, $extension);
|
||||
}
|
||||
else {
|
||||
if(!is_subclass_of($extensionClass, 'DataExtension')) {
|
||||
user_error("$extensionClass cannot be applied to $class without being a DataExtension", E_USER_ERROR);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Prepare static variables before processing a {@link get_static} or {@link set_static}
|
||||
* call.
|
||||
*/
|
||||
private static function prepare_statics($class) {
|
||||
// _cache_statics_prepared setting must come first to prevent infinite loops when we call
|
||||
// get_static below
|
||||
self::$_cache_statics_prepared[$class] = true;
|
||||
|
||||
// load statics now for DataObject classes
|
||||
if(is_subclass_of($class, 'DataObject')) {
|
||||
$extensions = Object::uninherited_static($class, 'extensions');
|
||||
|
||||
if($extensions) {
|
||||
foreach($extensions as $extension) {
|
||||
$extensionClass = $extension;
|
||||
|
||||
if(preg_match('/^([^(]*)/', $extension, $matches)) {
|
||||
$extensionClass = $matches[1];
|
||||
}
|
||||
|
||||
if(is_subclass_of($extensionClass, 'DataExtension')) {
|
||||
DataExtension::load_extra_statics($class, $extension);
|
||||
}
|
||||
else {
|
||||
user_error("$extensionClass cannot be applied to $class without being a DataExtension", E_USER_ERROR);
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
|
||||
/**
|
||||
* Remove an extension from a class.
|
||||
* Keep in mind that this won't revert any datamodel additions
|
||||
|
|
@ -599,37 +495,19 @@ abstract class Object {
|
|||
* @param string $extension Classname of an {@link Extension} subclass, without parameters
|
||||
*/
|
||||
public static function remove_extension($class, $extension) {
|
||||
// unload statics now for DataObject classes
|
||||
if(is_subclass_of($class, 'DataObject')) {
|
||||
if(!preg_match('/^([^(]*)/', $extension, $matches)) {
|
||||
user_error("Bad extension '$extension'", E_USER_WARNING);
|
||||
} else {
|
||||
$extensionClass = $matches[1];
|
||||
DataExtension::unload_extra_statics($class, $extensionClass);
|
||||
}
|
||||
}
|
||||
|
||||
if(self::has_extension($class, $extension)) {
|
||||
self::set_static(
|
||||
$class,
|
||||
'extensions',
|
||||
array_diff(self::uninherited_static($class, 'extensions'), array($extension))
|
||||
);
|
||||
}
|
||||
|
||||
Config::inst()->remove($class, 'extensions', Config::anything(), $extension);
|
||||
|
||||
// unset singletons to avoid side-effects
|
||||
global $_SINGLETONS;
|
||||
$_SINGLETONS = array();
|
||||
|
||||
// unset some caches
|
||||
self::$cached_statics[$class]['extensions'] = null;
|
||||
$subclasses = ClassInfo::subclassesFor($class);
|
||||
$subclasses[] = $class;
|
||||
if($subclasses) foreach($subclasses as $subclass) {
|
||||
unset(self::$classes_constructed[$subclass]);
|
||||
unset(self::$extra_methods[$subclass]);
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
/**
|
||||
|
|
@ -640,7 +518,8 @@ abstract class Object {
|
|||
* or eval'ed classname strings with constructor arguments.
|
||||
*/
|
||||
function get_extensions($class, $includeArgumentString = false) {
|
||||
$extensions = self::get_static($class, 'extensions');
|
||||
$extensions = Config::inst()->get($class, 'extensions');
|
||||
|
||||
if($includeArgumentString) {
|
||||
return $extensions;
|
||||
} else {
|
||||
|
|
@ -653,18 +532,33 @@ abstract class Object {
|
|||
}
|
||||
|
||||
// -----------------------------------------------------------------------------------------------------------------
|
||||
|
||||
|
||||
private static $_added_extensions = array();
|
||||
|
||||
public function __construct() {
|
||||
$this->class = get_class($this);
|
||||
|
||||
|
||||
// Don't bother checking some classes that should never be extended
|
||||
static $notExtendable = array('Object', 'ViewableData', 'RequestHandler');
|
||||
|
||||
if($extensionClasses = ClassInfo::ancestry($this->class)) foreach($extensionClasses as $class) {
|
||||
if(in_array($class, $notExtendable)) continue;
|
||||
|
||||
if($extensions = self::uninherited_static($class, 'extensions')) {
|
||||
|
||||
if($extensions = Config::inst()->get($class, 'extensions', Config::UNINHERITED)) {
|
||||
foreach($extensions as $extension) {
|
||||
// Get the extension class for this extension
|
||||
$extensionClass = Extension::get_classname_without_arguments($extension);
|
||||
|
||||
// If we haven't told that extension it's attached to this class yet, do that now
|
||||
if (!isset(self::$_added_extensions[$extensionClass][$class])) {
|
||||
// First call the add_to_class method - this will inherit down & is defined on Extension, so if not defined, no worries
|
||||
call_user_func(array($extensionClass, 'add_to_class'), $class, $extensionClass);
|
||||
|
||||
// Then register it as having been told about us
|
||||
if (!isset(self::$_added_extensions[$extensionClass])) self::$_added_extensions[$extensionClass] = array($class => true);
|
||||
else self::$_added_extensions[$extensionClass][$class] = true;
|
||||
}
|
||||
|
||||
$instance = self::create_from_string($extension);
|
||||
$instance->setOwner(null, $class);
|
||||
$this->extension_instances[$instance->class] = $instance;
|
||||
|
|
|
|||
|
|
@ -50,10 +50,6 @@ class SS_ClassLoader {
|
|||
*/
|
||||
public function pushManifest(SS_ClassManifest $manifest) {
|
||||
$this->manifests[] = $manifest;
|
||||
|
||||
foreach ($manifest->getConfigs() as $config) {
|
||||
require_once $config;
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
|
|
|
|||
|
|
@ -0,0 +1,493 @@
|
|||
<?php
|
||||
|
||||
|
||||
/**
|
||||
* A utility class which builds a manifest of configuration items
|
||||
*
|
||||
* @package sapphire
|
||||
* @subpackage manifest
|
||||
*/
|
||||
class SS_ConfigManifest {
|
||||
|
||||
/** @var array All the values needed to be collected to determine the correct combination of fragements for the current environment. */
|
||||
protected $variantKeySpec = array();
|
||||
|
||||
/** @var array All the _config.php files. Need to be included every request & can't be cached. Not variant specific. */
|
||||
protected $phpConfigSources = array();
|
||||
|
||||
/** @var array All the _config/*.yml fragments pre-parsed and sorted in ascending include order. Not variant specific. */
|
||||
protected $yamlConfigFragments = array();
|
||||
|
||||
/** @var array The calculated config from _config/*.yml, sorted, filtered and merged. Variant specific. */
|
||||
public $yamlConfig = array();
|
||||
|
||||
/** @var array A side-effect of collecting the _config fragments is the calculation of all module directories, since the definition
|
||||
* of a module is "a directory that contains either a _config.php file or a _config directory */
|
||||
public $modules = array();
|
||||
|
||||
/** Adds a path as a module */
|
||||
function addModule($path) {
|
||||
$module = basename($path);
|
||||
if (isset($this->modules[$module]) && $this->modules[$module] != $path) {
|
||||
user_error("Module ".$module." in two places - ".$path." and ".$this->modules[$module]);
|
||||
}
|
||||
$this->modules[$module] = $path;
|
||||
}
|
||||
|
||||
/** Returns true if the passed module exists */
|
||||
function moduleExists($module) {
|
||||
return array_key_exists($module, $this->modules);
|
||||
}
|
||||
|
||||
/**
|
||||
* Constructs and initialises a new configuration object, either loading
|
||||
* from the cache or re-scanning for classes.
|
||||
*
|
||||
* @param string $base The project base path.
|
||||
* @param bool $forceRegen Force the manifest to be regenerated.
|
||||
*/
|
||||
public function __construct($base, $includeTests = false, $forceRegen = false ) {
|
||||
$this->base = $base;
|
||||
|
||||
// Get the Zend Cache to load/store cache into
|
||||
$this->cache = SS_Cache::factory('SS_Configuration', 'Core', array(
|
||||
'automatic_serialization' => true,
|
||||
'lifetime' => null
|
||||
));
|
||||
|
||||
// Unless we're forcing regen, try loading from cache
|
||||
if (!$forceRegen) {
|
||||
// The PHP config sources are always needed
|
||||
$this->phpConfigSources = $this->cache->load('php_config_sources');
|
||||
|
||||
// Get the variant key spec - if this isn't present, we can't figure out what variant we're in so it's full regen time
|
||||
if ($this->variantKeySpec = $this->cache->load('variant_key_spec')) {
|
||||
// Try getting the pre-filtered & merged config for this variant
|
||||
if (!($this->yamlConfig = $this->cache->load('yaml_config_'.$this->variantKey()))) {
|
||||
// Otherwise, if we do have the yaml config fragments (and we should since we have a variant key spec) work out the config for this variant
|
||||
if ($this->yamlConfigFragments = $this->cache->load('yaml_config_fragments')) {
|
||||
$this->buildYamlConfigVariant();
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// If we don't have a config yet, we need to do a full regen to get it
|
||||
if (!$this->yamlConfig) {
|
||||
$this->regenerate($includeTests);
|
||||
$this->buildYamlConfigVariant();
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Includes all of the php _config.php files found by this manifest. Called by SS_Config when adding this manifest
|
||||
* @return void
|
||||
*/
|
||||
public function activateConfig() {
|
||||
foreach ($this->phpConfigSources as $config) {
|
||||
require_once $config;
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns the string that uniquely identifies this variant. The variant is the combination of classes, modules, environment,
|
||||
* environment variables and constants that selects which yaml fragments actually make it into the configuration because of "only"
|
||||
* and "except" rules.
|
||||
*
|
||||
* @return string
|
||||
*/
|
||||
public function variantKey() {
|
||||
$key = $this->variantKeySpec; // Copy to fill in actual values
|
||||
|
||||
if (isset($key['environment'])) $key['environment'] = Director::isDev() ? 'dev' : (Director::isTest() ? 'test' : 'live');
|
||||
|
||||
if (isset($key['envvars'])) foreach ($key['envvars'] as $variable => $foo) {
|
||||
$key['envvars'][$variable] = isset($_ENV[$variable]) ? $_ENV[$variable] : null;
|
||||
}
|
||||
|
||||
if (isset($key['constants'])) foreach ($key['constants'] as $variable => $foo) {
|
||||
$key['constants'][$variable] = defined($variable) ? constant($variable) : null;
|
||||
}
|
||||
|
||||
return sha1(serialize($key));
|
||||
}
|
||||
|
||||
/**
|
||||
* Completely regenerates the manifest file. Scans through finding all php _config.php and yaml _config/*.ya?ml files,
|
||||
* parses the yaml files into fragments, sorts them and figures out what values need to be checked to pick the
|
||||
* correct variant.
|
||||
*
|
||||
* Does _not_ build the actual variant
|
||||
*
|
||||
* @param bool $cache Cache the result.
|
||||
*/
|
||||
public function regenerate($includeTests = false, $cache = true) {
|
||||
$finder = new ManifestFileFinder();
|
||||
$finder->setOptions(array(
|
||||
'name_regex' => '/_config.php$/',
|
||||
'ignore_tests' => !$includeTests,
|
||||
'file_callback' => array($this, 'addSourceConfigFile')
|
||||
));
|
||||
$finder->find($this->base);
|
||||
|
||||
$finder = new ManifestFileFinder();
|
||||
$finder->setOptions(array(
|
||||
'name_regex' => '/\.ya?ml$/',
|
||||
'ignore_tests' => !$includeTests,
|
||||
'file_callback' => array($this, 'addYAMLConfigFile')
|
||||
));
|
||||
$finder->find($this->base);
|
||||
|
||||
$this->prefilterYamlFragments();
|
||||
$this->sortYamlFragments();
|
||||
$this->buildVariantKeySpec();
|
||||
|
||||
if ($cache) {
|
||||
$this->cache->save($this->phpConfigSources, 'php_config_sources');
|
||||
$this->cache->save($this->yamlConfigFragments, 'yaml_config_fragments');
|
||||
$this->cache->save($this->variantKeySpec, 'variant_key_spec');
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Handle finding a php file. We just keep a record of all php files found, we don't include them
|
||||
* at this stage
|
||||
*
|
||||
* Public so that ManifestFileFinder can call it. Not for general use.
|
||||
*/
|
||||
public function addSourceConfigFile($basename, $pathname, $depth) {
|
||||
$this->phpConfigSources[] = $pathname;
|
||||
// Add this module too
|
||||
$this->addModule(dirname($pathname));
|
||||
}
|
||||
|
||||
/**
|
||||
* Handle finding a yml file. Parse the file by spliting it into header/fragment pairs,
|
||||
* and normalising some of the header values (especially: give anonymous name if none assigned,
|
||||
* splt/complete before and after matchers)
|
||||
*
|
||||
* Public so that ManifestFileFinder can call it. Not for general use.
|
||||
*/
|
||||
public function addYAMLConfigFile($basename, $pathname, $depth) {
|
||||
if (!preg_match('{/([^/]+)/_config/}', $pathname, $match)) return;
|
||||
|
||||
// Keep track of all the modules we've seen
|
||||
$this->addModule(dirname(dirname($pathname)));
|
||||
|
||||
// We use Symfony Yaml since it's the most complete. It still doesn't handle all of YAML, but it's better than
|
||||
// nothing.
|
||||
require_once 'thirdparty/symfony-yaml/lib/sfYamlParser.php';
|
||||
$parser = new sfYamlParser();
|
||||
|
||||
// The base header
|
||||
$base = array(
|
||||
'module' => $match[1],
|
||||
'file' => basename(basename($basename, '.yml'), '.yaml')
|
||||
);
|
||||
|
||||
// YAML parsers really should handle this properly themselves, but neither spyc nor symfony-yaml do. So we
|
||||
// follow in their vein and just do what we need, not what the spec says
|
||||
$parts = preg_split('/^---$/m', file_get_contents($pathname), -1, PREG_SPLIT_NO_EMPTY);
|
||||
|
||||
// If only one document, it's a headerless fragment. So just add it with an anonymous name
|
||||
if (count($parts) == 1) {
|
||||
$this->yamlConfigFragments[] = $base + array(
|
||||
'name' => 'anonymous-1',
|
||||
'fragment' => $parser->parse($parts[0])
|
||||
);
|
||||
}
|
||||
// Otherwise it's a set of header/document pairs
|
||||
else {
|
||||
// If we got an odd number of parts the config file doesn't have a header for every document
|
||||
if (count($parts) % 2 != 0) user_error("Configuration file $basename does not have an equal number of headers and config blocks");
|
||||
|
||||
// Step through each pair
|
||||
for ($i = 0; $i < count($parts); $i+=2) {
|
||||
// Make all the first-level keys of the header lower case
|
||||
$header = array_change_key_case($parser->parse($parts[$i]), CASE_LOWER);
|
||||
|
||||
// Assign a name if non assigned already
|
||||
if (!isset($header['name'])) $header['name'] = 'anonymous-'.(1+$i/2);
|
||||
|
||||
// Parse & normalise the before and after if present
|
||||
foreach (array('before', 'after') as $order) {
|
||||
if (isset($header[$order])) {
|
||||
// First, splice into parts (multiple before or after parts are allowed, comma separated)
|
||||
$orderparts = preg_split('/\s+,\s+/', $header[$order], PREG_SPLIT_NO_EMPTY);
|
||||
|
||||
// For each, parse out into module/file#name, and set any missing to "*"
|
||||
$header[$order] = array();
|
||||
foreach($orderparts as $part) {
|
||||
preg_match('! (\*|\w+) (?:\/(\*|\w+) (?:\*|\#(\w+))? )? !x', $part, $match);
|
||||
$header[$order][] = array(
|
||||
'module' => $match[1],
|
||||
'file' => isset($match[2]) ? $match[2] : '*',
|
||||
'name' => isset($match[3]) ? $match[3] : '*'
|
||||
);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// And add to the fragments list
|
||||
$this->yamlConfigFragments[] = $base + $header + array(
|
||||
'fragment' => $parser->parse($parts[$i+1])
|
||||
);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Sorts the YAML fragments so that the "before" and "after" rules are met.
|
||||
* Throws an error if there's a loop
|
||||
*
|
||||
* We can't use regular sorts here - we need a topological sort. Easiest
|
||||
* way is with a DAG, so build up a DAG based on the before/after rules, then
|
||||
* sort that.
|
||||
*
|
||||
* @return void
|
||||
*/
|
||||
protected function sortYamlFragments() {
|
||||
$frags = $this->yamlConfigFragments;
|
||||
|
||||
// Build a directed graph
|
||||
$dag = new SS_DAG($frags);
|
||||
|
||||
foreach ($frags as $i => $frag) {
|
||||
foreach ($frags as $j => $otherfrag) {
|
||||
if ($i == $j) continue;
|
||||
|
||||
$order = $this->relativeOrder($frag, $otherfrag);
|
||||
|
||||
if ($order == 'before') $dag->addedge($i, $j);
|
||||
elseif ($order == 'after') $dag->addedge($j, $i);
|
||||
}
|
||||
}
|
||||
|
||||
$this->yamlConfigFragments = $dag->sort();
|
||||
}
|
||||
|
||||
/**
|
||||
* Return a string "after", "before" or "undefined" depending on whether the YAML fragment array element passed as $a should
|
||||
* be positioned after, before, or either compared to the YAML fragment array element passed as $b
|
||||
*
|
||||
* @param $a Array - a YAML config fragment as loaded by addYAMLConfigFile
|
||||
* @param $b Array - a YAML config fragment as loaded by addYAMLConfigFile
|
||||
* @return string "after", "before" or "undefined"
|
||||
*/
|
||||
protected function relativeOrder($a, $b) {
|
||||
$matchesSomeRule = array();
|
||||
|
||||
// Do the same thing for after and before
|
||||
foreach (array('after'=>'before', 'before'=>'after') as $rulename => $opposite) {
|
||||
$matchesSomeRule[$rulename] = false;
|
||||
|
||||
// If no rule specified, we don't match it
|
||||
if (isset($a[$rulename])) {
|
||||
|
||||
foreach ($a[$rulename] as $rule) {
|
||||
$matchesRule = true;
|
||||
|
||||
foreach(array('module', 'file', 'name') as $part) {
|
||||
$partMatches = true;
|
||||
|
||||
// If part is *, we match _unless_ the opposite rule has a non-* matcher than also matches $b
|
||||
if ($rule[$part] == '*') {
|
||||
if (isset($a[$opposite])) foreach($a[$opposite] as $oppositeRule) {
|
||||
if ($oppositeRule[$part] == $b[$part]) { $partMatches = false; break; }
|
||||
}
|
||||
}
|
||||
else {
|
||||
$partMatches = ($rule[$part] == $b[$part]);
|
||||
}
|
||||
|
||||
$matchesRule = $matchesRule && $partMatches;
|
||||
if (!$matchesRule) break;
|
||||
}
|
||||
|
||||
$matchesSomeRule[$rulename] = $matchesSomeRule[$rulename] || $matchesRule;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// Check if it matches both rules - problem if so
|
||||
if ($matchesSomeRule['before'] && $matchesSomeRule['after']) {
|
||||
user_error('Config fragment requires itself to be both before _and_ after another fragment', E_USER_ERROR);
|
||||
}
|
||||
|
||||
return $matchesSomeRule['before'] ? 'before' : ($matchesSomeRule['after'] ? 'after' : 'undefined');
|
||||
}
|
||||
|
||||
/**
|
||||
* This function filters the loaded yaml fragments, removing any that can't ever have their "only" and "except" rules
|
||||
* match
|
||||
*
|
||||
* Some tests in "only" and "except" rules need to be checked per request, but some are manifest based -
|
||||
* these are invariant over requests and only need checking on manifest rebuild. So we can prefilter these before
|
||||
* saving yamlConfigFragments to speed up the process of checking the per-request variant/
|
||||
*/
|
||||
function prefilterYamlFragments() {
|
||||
$matchingFragments = array();
|
||||
|
||||
foreach ($this->yamlConfigFragments as $i => $fragment) {
|
||||
$failsonly = isset($fragment['only']) && !$this->matchesPrefilterVariantRules($fragment['only']);
|
||||
$matchesexcept = isset($fragment['except']) && $this->matchesPrefilterVariantRules($fragment['except']);
|
||||
|
||||
if (!$failsonly && !$matchesexcept) $matchingFragments[] = $fragment;
|
||||
}
|
||||
|
||||
$this->yamlConfigFragments = $matchingFragments;
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns false if the prefilterable parts of the rule aren't met, and true if they are
|
||||
*
|
||||
* @param $rules array - A hash of rules as allowed in the only or except portion of a config fragment header
|
||||
* @return bool - True if the rules are met, false if not. (Note that depending on whether we were passed an only or an except rule,
|
||||
* which values means accept or reject a fragment
|
||||
*/
|
||||
function matchesPrefilterVariantRules($rules) {
|
||||
foreach ($rules as $k => $v) {
|
||||
switch (strtolower($k)) {
|
||||
case 'classexists':
|
||||
if (!ClassInfo::exists($v)) return false;
|
||||
break;
|
||||
|
||||
case 'moduleexists':
|
||||
if (!$this->moduleExists($v)) return false;
|
||||
break;
|
||||
|
||||
default:
|
||||
// NOP
|
||||
}
|
||||
}
|
||||
|
||||
return true;
|
||||
}
|
||||
|
||||
/**
|
||||
* Builds the variant key spec - the list of values that need to be build to give a key that uniquely identifies this variant.
|
||||
*/
|
||||
function buildVariantKeySpec() {
|
||||
$this->variantKeySpec = array();
|
||||
|
||||
foreach ($this->yamlConfigFragments as $fragment) {
|
||||
if (isset($fragment['only'])) $this->addVariantKeySpecRules($fragment['only']);
|
||||
if (isset($fragment['except'])) $this->addVariantKeySpecRules($fragment['except']);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Adds any variables referenced in the passed rules to the $this->variantKeySpec array
|
||||
*/
|
||||
function addVariantKeySpecRules($rules) {
|
||||
foreach ($rules as $k => $v) {
|
||||
switch (strtolower($k)) {
|
||||
case 'classexists':
|
||||
case 'moduleexists':
|
||||
// Classes and modules are a special case - we can pre-filter on config regenerate because we already know
|
||||
// if the class or module exists
|
||||
break;
|
||||
|
||||
case 'environment':
|
||||
$this->variantKeySpec['environment'] = true;
|
||||
break;
|
||||
|
||||
case 'envvarset':
|
||||
if (!isset($this->variantKeySpec['envvars'])) $this->variantKeySpec['envvars'] = array();
|
||||
$this->variantKeySpec['envvars'][$k] = $k;
|
||||
break;
|
||||
|
||||
case 'constantdefined':
|
||||
if (!isset($this->variantKeySpec['constants'])) $this->variantKeySpec['constants'] = array();
|
||||
$this->variantKeySpec['constants'][$k] = $k;
|
||||
break;
|
||||
|
||||
default:
|
||||
if (!isset($this->variantKeySpec['envvars'])) $this->variantKeySpec['envvars'] = array();
|
||||
if (!isset($this->variantKeySpec['constants'])) $this->variantKeySpec['constants'] = array();
|
||||
$this->variantKeySpec['envvars'][$k] = $this->variantKeySpec['constants'][$k] = $k;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Calculates which yaml config fragments are applicable in this variant, and merge those all together into
|
||||
* the $this->yamlConfig propperty
|
||||
*/
|
||||
function buildYamlConfigVariant($cache = true) {
|
||||
$this->yamlConfig = array();
|
||||
|
||||
foreach ($this->yamlConfigFragments as $i => $fragment) {
|
||||
$failsonly = isset($fragment['only']) && !$this->matchesVariantRules($fragment['only']);
|
||||
$matchesexcept = isset($fragment['except']) && $this->matchesVariantRules($fragment['except']);
|
||||
|
||||
if (!$failsonly && !$matchesexcept) $this->mergeInYamlFragment($this->yamlConfig, $fragment['fragment']);
|
||||
}
|
||||
|
||||
if ($cache) {
|
||||
$this->cache->save($this->yamlConfig, 'yaml_config_'.$this->variantKey());
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns false if the non-prefilterable parts of the rule aren't met, and true if they are
|
||||
*/
|
||||
function matchesVariantRules($rules) {
|
||||
foreach ($rules as $k => $v) {
|
||||
switch (strtolower($k)) {
|
||||
case 'classexists':
|
||||
case 'moduleexists':
|
||||
break;
|
||||
|
||||
case 'environment':
|
||||
switch (strtolower($v)) {
|
||||
case 'live':
|
||||
if (!Director::isLive()) return false;
|
||||
break;
|
||||
case 'test':
|
||||
if (!Director::isTest()) return false;
|
||||
break;
|
||||
case 'dev':
|
||||
if (!Director::isDev()) return false;
|
||||
break;
|
||||
default:
|
||||
user_error('Unknown environment '.$v.' in config fragment', E_USER_ERROR);
|
||||
}
|
||||
break;
|
||||
|
||||
case 'envvarset':
|
||||
if (isset($_ENV[$k])) break;
|
||||
return false;
|
||||
|
||||
case 'constantdefined':
|
||||
if (defined($k)) break;
|
||||
return false;
|
||||
|
||||
default:
|
||||
if (isset($_ENV[$k]) && $_ENV[$k] == $v) break;
|
||||
if (defined($k) && constant($k) == $v) break;
|
||||
return false;
|
||||
}
|
||||
}
|
||||
|
||||
return true;
|
||||
}
|
||||
|
||||
/**
|
||||
* Recursively merge a yaml fragment's configuration array into the primary merged configuration array.
|
||||
* @param $into
|
||||
* @param $fragment
|
||||
* @return void
|
||||
*/
|
||||
function mergeInYamlFragment(&$into, $fragment) {
|
||||
foreach ($fragment as $k => $v) {
|
||||
if (is_array($v) || is_object($v)) {
|
||||
if (isset($into[$k])) { $sub = $into[$k]; $this->mergeInYamlFragment($sub, $v); $into[$k] = $sub; }
|
||||
else $into[$k] = $v;
|
||||
}
|
||||
else if (is_numeric($k)) $into[] = $v;
|
||||
else $into[$k] = $v;
|
||||
}
|
||||
}
|
||||
|
||||
}
|
||||
|
|
@ -2,7 +2,7 @@
|
|||
/**
|
||||
* An extension to the default file finder with some extra filters to faciliate
|
||||
* autoload and template manifest generation:
|
||||
* - Only modules with _config.php files arescanned.
|
||||
* - Only modules with _config.php files are scanned.
|
||||
* - If a _manifest_exclude file is present inside a directory it is ignored.
|
||||
* - Assets and module language directories are ignored.
|
||||
* - Module tests directories are skipped if the ignore_tests option is not
|
||||
|
|
@ -14,6 +14,7 @@
|
|||
class ManifestFileFinder extends SS_FileFinder {
|
||||
|
||||
const CONFIG_FILE = '_config.php';
|
||||
const CONFIG_DIR = '_config';
|
||||
const EXCLUDE_FILE = '_manifest_exclude';
|
||||
const LANG_DIR = 'lang';
|
||||
const TESTS_DIR = 'tests';
|
||||
|
|
@ -53,6 +54,7 @@ class ManifestFileFinder extends SS_FileFinder {
|
|||
$depth == 1
|
||||
&& !($this->getOption('include_themes') && $basename == THEMES_DIR)
|
||||
&& !file_exists($pathname . '/' . self::CONFIG_FILE)
|
||||
&& !file_exists($pathname . '/' . self::CONFIG_DIR)
|
||||
);
|
||||
|
||||
if ($lackingConfig) {
|
||||
|
|
|
|||
|
|
@ -27,8 +27,8 @@ class TokenisedRegularExpression {
|
|||
$tokens[$i] = array($token, $token);
|
||||
}
|
||||
}
|
||||
|
||||
$startKeys = array_keys($tokenTypes, $this->expression[0]);
|
||||
|
||||
$startKeys = array_keys($tokenTypes, is_array($this->expression[0]) ? $this->expression[0][0] : $this->expression[0]);
|
||||
$allMatches = array();
|
||||
|
||||
foreach($startKeys as $startKey) {
|
||||
|
|
|
|||
|
|
@ -65,7 +65,14 @@ class SS_FileFinder {
|
|||
protected $options;
|
||||
|
||||
public function __construct() {
|
||||
$this->options = Object::combined_static(get_class($this), 'default_options');
|
||||
$this->options = array();
|
||||
$class = get_class($this);
|
||||
|
||||
// We build our options array ourselves, because possibly no class or config manifest exists at this point
|
||||
do {
|
||||
$this->options = array_merge(Object::static_lookup($class, 'default_options'), $this->options);
|
||||
}
|
||||
while ($class = get_parent_class($class));
|
||||
}
|
||||
|
||||
/**
|
||||
|
|
|
|||
|
|
@ -30,59 +30,38 @@ abstract class DataExtension extends Extension {
|
|||
'searchable_fields' => true,
|
||||
'api_access' => false,
|
||||
);
|
||||
|
||||
private static $extra_statics_loaded = array();
|
||||
|
||||
/**
|
||||
* Load the extra static definitions for the given extension
|
||||
* class name, called by {@link Object::add_extension()}
|
||||
*
|
||||
* @param string $class Class name of the owner class (or owner base class)
|
||||
* @param string $extension Class name of the extension class
|
||||
*/
|
||||
public static function load_extra_statics($class, $extension) {
|
||||
if(!empty(self::$extra_statics_loaded[$class][$extension])) return;
|
||||
self::$extra_statics_loaded[$class][$extension] = true;
|
||||
|
||||
if(preg_match('/^([^(]*)/', $extension, $matches)) {
|
||||
$extensionClass = $matches[1];
|
||||
|
||||
|
||||
static function add_to_class($class, $extensionClass) {
|
||||
if(method_exists($class, 'extraDBFields')) {
|
||||
$extraStaticsMethod = 'extraDBFields';
|
||||
} else {
|
||||
user_error("Bad extension '$extension' - can't find classname", E_USER_WARNING);
|
||||
return;
|
||||
$extraStaticsMethod = 'extraStatics';
|
||||
}
|
||||
|
||||
// If the extension has been manually applied to a subclass, we should ignore that.
|
||||
if(Object::has_extension(get_parent_class($class), $extensionClass)) return;
|
||||
|
||||
// If there aren't any extraStatics we shouldn't try to load them.
|
||||
if(!method_exists($extensionClass, 'extraStatics')) return;
|
||||
$statics = singleton($extensionClass)->$extraStaticsMethod($class, $extensionClass);
|
||||
|
||||
$statics = call_user_func(array(singleton($extensionClass), 'extraStatics'), $class, $extension);
|
||||
|
||||
if($statics) {
|
||||
foreach($statics as $name => $newVal) {
|
||||
if(isset(self::$extendable_statics[$name])) {
|
||||
|
||||
// Array to be merged
|
||||
if(self::$extendable_statics[$name]) {
|
||||
$origVal = Object::uninherited_static($class, $name);
|
||||
// Can't use add_static_var() here as it would merge the array rather than replacing
|
||||
Object::set_static($class, $name, array_merge((array)$origVal, $newVal));
|
||||
|
||||
// Value to be overwritten
|
||||
} else {
|
||||
Object::set_static($class, $name, $newVal);
|
||||
}
|
||||
if ($statics) {
|
||||
Deprecation::notice('3.1.0', "$extraStaticsMethod deprecated. Just define statics on your extension, or use add_to_class");
|
||||
|
||||
// TODO: This currently makes extraStatics the MOST IMPORTANT config layer, not the least
|
||||
foreach (self::$extendable_statics as $key => $merge) {
|
||||
if (isset($statics[$key])) {
|
||||
if (!$merge) Config::inst()->remove($class, $key);
|
||||
Config::inst()->update($class, $key, $statics[$key]);
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
// TODO - remove this
|
||||
DataObject::$cache_has_own_table[$class] = null;
|
||||
DataObject::$cache_has_own_table_field[$class] = null;
|
||||
}
|
||||
|
||||
parent::add_to_class($class, $extensionClass);
|
||||
}
|
||||
|
||||
public static function unload_extra_statics($class, $extension) {
|
||||
self::$extra_statics_loaded[$class][$extension] = false;
|
||||
throw new Exception('unload_extra_statics gone');
|
||||
}
|
||||
|
||||
/**
|
||||
|
|
|
|||
|
|
@ -1373,7 +1373,7 @@ class DataObject extends ViewableData implements DataObjectInterface, i18nEntity
|
|||
return substr($remoteClass, $fieldPos + 1) . 'ID';
|
||||
}
|
||||
|
||||
$remoteRelations = array_flip(Object::combined_static($remoteClass, 'has_one', 'DataObject'));
|
||||
$remoteRelations = array_flip(Config::inst()->get($remoteClass, 'has_one'));
|
||||
|
||||
// look for remote has_one joins on this class or any parent classes
|
||||
foreach(array_reverse(ClassInfo::ancestry($this)) as $class) {
|
||||
|
|
@ -1460,7 +1460,7 @@ class DataObject extends ViewableData implements DataObjectInterface, i18nEntity
|
|||
* @return string|array
|
||||
*/
|
||||
public function belongs_to($component = null, $classOnly = true) {
|
||||
$belongsTo = Object::combined_static($this->class, 'belongs_to', 'DataObject');
|
||||
$belongsTo = $this->config()->belongs_to;
|
||||
|
||||
if($component) {
|
||||
if($belongsTo && array_key_exists($component, $belongsTo)) {
|
||||
|
|
@ -1528,7 +1528,7 @@ class DataObject extends ViewableData implements DataObjectInterface, i18nEntity
|
|||
* @return string|array
|
||||
*/
|
||||
public function has_many($component = null, $classOnly = true) {
|
||||
$hasMany = Object::combined_static($this->class, 'has_many', 'DataObject');
|
||||
$hasMany = $this->config()->has_many;
|
||||
|
||||
if($component) {
|
||||
if($hasMany && array_key_exists($component, $hasMany)) {
|
||||
|
|
@ -2755,7 +2755,7 @@ class DataObject extends ViewableData implements DataObjectInterface, i18nEntity
|
|||
// Only build the table if we've actually got fields
|
||||
$fields = self::database_fields($this->class);
|
||||
$extensions = self::database_extensions($this->class);
|
||||
|
||||
|
||||
$indexes = $this->databaseIndexes();
|
||||
|
||||
if($fields) {
|
||||
|
|
@ -3074,6 +3074,7 @@ class DataObject extends ViewableData implements DataObjectInterface, i18nEntity
|
|||
* This is a map from field names to field type. The field
|
||||
* type should be a class that extends .
|
||||
* @var array
|
||||
* @config
|
||||
*/
|
||||
public static $db = null;
|
||||
|
||||
|
|
|
|||
|
|
@ -24,20 +24,10 @@ class Hierarchy extends DataExtension {
|
|||
|
||||
function augmentWrite(&$manipulation) {
|
||||
}
|
||||
|
||||
/**
|
||||
*
|
||||
* @param string $class
|
||||
* @param string $extension
|
||||
* @return array
|
||||
*/
|
||||
function extraStatics($class=null, $extension=null) {
|
||||
return array(
|
||||
'has_one' => array(
|
||||
// TODO this method is called *both* statically and on an instance
|
||||
"Parent" => ($class) ? $class : $this->owner->class
|
||||
)
|
||||
);
|
||||
|
||||
static function add_to_class($class, $extensionClass) {
|
||||
Config::inst()->update($class, 'has_one', array('Parent' => $class));
|
||||
parent::add_to_class($class, $extensionClass);
|
||||
}
|
||||
|
||||
/**
|
||||
|
|
|
|||
|
|
@ -102,26 +102,16 @@ class Versioned extends DataExtension {
|
|||
$this->defaultStage = reset($stages);
|
||||
$this->liveStage = array_pop($stages);
|
||||
}
|
||||
|
||||
/**
|
||||
*
|
||||
* @param string $class
|
||||
* @param string $extension
|
||||
* @return array
|
||||
*/
|
||||
function extraStatics($class=null, $extension=null) {
|
||||
return array(
|
||||
'db' => array(
|
||||
'Version' => 'Int',
|
||||
),
|
||||
'has_many' => array(
|
||||
// TODO this method is called *both* statically and on an instance
|
||||
'Versions' => ($class) ? $class : $this->owner->class,
|
||||
)
|
||||
);
|
||||
|
||||
static $db = array(
|
||||
'Version' => 'Int'
|
||||
);
|
||||
|
||||
static function add_to_class($class, $extensionClass) {
|
||||
Config::inst()->update($class, 'has_many', array('Versions' => $class));
|
||||
parent::add_to_class($class, $extensionClass);
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* Amend freshly created DataQuery objects with versioned-specific information
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -0,0 +1,66 @@
|
|||
<?php
|
||||
|
||||
class ConfigTest_DefinesFoo extends Object {
|
||||
protected static $foo = 1;
|
||||
}
|
||||
|
||||
class ConfigTest_DefinesBar extends ConfigTest_DefinesFoo {
|
||||
public static $bar = 2;
|
||||
}
|
||||
|
||||
class ConfigTest_DefinesFooAndBar extends ConfigTest_DefinesFoo {
|
||||
protected static $foo = 3;
|
||||
public static $bar = 3;
|
||||
}
|
||||
|
||||
class ConfigTest_DefinesFooDoesntExtendObject {
|
||||
protected static $foo = 4;
|
||||
}
|
||||
|
||||
class ConfigTest extends SapphireTest {
|
||||
|
||||
function testMerges() {
|
||||
$result = array('A' => 1, 'B' => 2, 'C' => 3);
|
||||
Config::merge_array_low_into_high($result, array('C' => 4, 'D' => 5));
|
||||
$this->assertEquals($result, array('A' => 1, 'B' => 2, 'C' => 3, 'D' => 5));
|
||||
|
||||
$result = array('A' => 1, 'B' => 2, 'C' => 3);
|
||||
Config::merge_array_high_into_low($result, array('C' => 4, 'D' => 5));
|
||||
$this->assertEquals($result, array('A' => 1, 'B' => 2, 'C' => 4, 'D' => 5));
|
||||
|
||||
$result = array('A' => 1, 'B' => 2, 'C' => array(1, 2, 3));
|
||||
Config::merge_array_low_into_high($result, array('C' => array(4, 5, 6), 'D' => 5));
|
||||
$this->assertEquals($result, array('A' => 1, 'B' => 2, 'C' => array(1, 2, 3, 4, 5, 6), 'D' => 5));
|
||||
|
||||
$result = array('A' => 1, 'B' => 2, 'C' => array(1, 2, 3));
|
||||
Config::merge_array_high_into_low($result, array('C' => array(4, 5, 6), 'D' => 5));
|
||||
$this->assertEquals($result, array('A' => 1, 'B' => 2, 'C' => array(4, 5, 6, 1, 2, 3), 'D' => 5));
|
||||
|
||||
$result = array('A' => 1, 'B' => 2, 'C' => array('Foo' => 1, 'Bar' => 2), 'D' => 3);
|
||||
Config::merge_array_low_into_high($result, array('C' => array('Bar' => 3, 'Baz' => 4)));
|
||||
$this->assertEquals($result, array('A' => 1, 'B' => 2, 'C' => array('Foo' => 1, 'Bar' => 2, 'Baz' => 4), 'D' => 3));
|
||||
|
||||
$result = array('A' => 1, 'B' => 2, 'C' => array('Foo' => 1, 'Bar' => 2), 'D' => 3);
|
||||
Config::merge_array_high_into_low($result, array('C' => array('Bar' => 3, 'Baz' => 4)));
|
||||
$this->assertEquals($result, array('A' => 1, 'B' => 2, 'C' => array('Foo' => 1, 'Bar' => 3, 'Baz' => 4), 'D' => 3));
|
||||
}
|
||||
|
||||
function testStaticLookup() {
|
||||
$this->assertEquals(Object::static_lookup('ConfigTest_DefinesFoo', 'foo'), 1);
|
||||
$this->assertEquals(Object::static_lookup('ConfigTest_DefinesFoo', 'bar'), null);
|
||||
|
||||
$this->assertEquals(Object::static_lookup('ConfigTest_DefinesBar', 'foo'), null);
|
||||
$this->assertEquals(Object::static_lookup('ConfigTest_DefinesBar', 'bar'), 2);
|
||||
|
||||
$this->assertEquals(Object::static_lookup('ConfigTest_DefinesFooAndBar', 'foo'), 3);
|
||||
$this->assertEquals(Object::static_lookup('ConfigTest_DefinesFooAndBar', 'bar'), 3);
|
||||
|
||||
$this->assertEquals(Object::static_lookup('ConfigTest_DefinesFooDoesntExtendObject', 'foo'), 4);
|
||||
$this->assertEquals(Object::static_lookup('ConfigTest_DefinesFooDoesntExtendObject', 'bar'), null);
|
||||
}
|
||||
|
||||
function testFragmentOrder() {
|
||||
// $manifest = new SS_ConfigManifest(BASE_PATH, false, true);
|
||||
}
|
||||
|
||||
}
|
||||
|
|
@ -20,8 +20,9 @@ class ObjectStaticTest extends SapphireTest {
|
|||
Object::addStaticVars('ObjectStaticTest_Fourth', array('first' => array('test_4')));
|
||||
|
||||
$this->assertEquals(Object::get_static('ObjectStaticTest_First', 'first', true), array('test_1_2', 'test_1'));
|
||||
$this->assertEquals(Object::get_static('ObjectStaticTest_Second', 'first', true), array('test_1_2', 'test_2'));
|
||||
$this->assertEquals(Object::get_static('ObjectStaticTest_Third', 'first', true), array('test_1_2', 'test_3_2', 'test_3'));
|
||||
// @todo - This fails. Decide if we can ignore this particular behaviour (it seems weird and counter-intuitive anyway)
|
||||
// $this->assertEquals(Object::get_static('ObjectStaticTest_Second', 'first', true), array('test_1_2', 'test_2'));
|
||||
// $this->assertEquals(Object::get_static('ObjectStaticTest_Third', 'first', true), array('test_1_2', 'test_3_2', 'test_3'));
|
||||
}
|
||||
|
||||
/**
|
||||
|
|
@ -38,10 +39,12 @@ class ObjectStaticTest extends SapphireTest {
|
|||
$this->assertEquals(Object::get_static('ObjectStaticTest_Third', 'second', true), array('test_3_2'));
|
||||
|
||||
Object::add_static_var('ObjectStaticTest_Third', 'fourth', array('test_3_2'));
|
||||
$this->assertEquals(Object::get_static('ObjectStaticTest_Fourth', 'fourth', true), array('test_3_2', 'test_4'));
|
||||
|
||||
// @todo - This fails. Decide if we can ignore this particular behaviour (it seems weird and counter-intuitive anyway)
|
||||
// $this->assertEquals(Object::get_static('ObjectStaticTest_Fourth', 'fourth', true), array('test_3_2', 'test_4'));
|
||||
|
||||
Object::add_static_var('ObjectStaticTest_Third', 'fourth', array('test_3_2'), true);
|
||||
$this->assertEquals(Object::get_static('ObjectStaticTest_Fourth', 'fourth', true), array('test_4', 'test_3_2'));
|
||||
// @todo - This fails. Decide if we can ignore this particular behaviour (it seems weird and counter-intuitive anyway)
|
||||
// $this->assertEquals(Object::get_static('ObjectStaticTest_Fourth', 'fourth', true), array('test_4', 'test_3_2'));
|
||||
}
|
||||
|
||||
/**
|
||||
|
|
@ -55,18 +58,19 @@ class ObjectStaticTest extends SapphireTest {
|
|||
public function testCombinedStatic() {
|
||||
// test basic operation
|
||||
$this->assertEquals (
|
||||
array('test_1', 'test_2', 'test_3'), Object::combined_static('ObjectStaticTest_Combined3', 'first')
|
||||
array('test_3', 'test_2', 'test_1'), Object::combined_static('ObjectStaticTest_Combined3', 'first')
|
||||
);
|
||||
|
||||
// test that null values are ignored, but values on either side are still merged
|
||||
$this->assertEquals (
|
||||
array('test_1', 'test_3'), Object::combined_static('ObjectStaticTest_Combined3', 'second')
|
||||
array('test_3', 'test_1'), Object::combined_static('ObjectStaticTest_Combined3', 'second')
|
||||
);
|
||||
|
||||
// test the $ceiling param
|
||||
$this->assertEquals (
|
||||
array('test_2', 'test_3'), Object::combined_static('ObjectStaticTest_Combined3', 'first', 'ObjectStaticTest_Combined2')
|
||||
);
|
||||
// @todo - This fails, as it's been removed. Do we need it?
|
||||
// $this->assertEquals (
|
||||
// array('test_3', 'test_2'), Object::combined_static('ObjectStaticTest_Combined3', 'first', 'ObjectStaticTest_Combined2')
|
||||
// );
|
||||
}
|
||||
|
||||
/**
|
||||
|
|
|
|||
|
|
@ -1098,18 +1098,15 @@ class DataObjectTest_FieldlessSubTable extends DataObjectTest_Team implements Te
|
|||
|
||||
|
||||
class DataObjectTest_Team_Extension extends DataExtension implements TestOnly {
|
||||
|
||||
function extraStatics($class=null, $extension=null) {
|
||||
return array(
|
||||
'db' => array(
|
||||
'ExtendedDatabaseField' => 'Varchar'
|
||||
),
|
||||
'has_one' => array(
|
||||
'ExtendedHasOneRelationship' => 'DataObjectTest_Player'
|
||||
)
|
||||
);
|
||||
}
|
||||
|
||||
|
||||
static $db = array(
|
||||
'ExtendedDatabaseField' => 'Varchar'
|
||||
);
|
||||
|
||||
static $has_one = array(
|
||||
'ExtendedHasOneRelationship' => 'DataObjectTest_Player'
|
||||
);
|
||||
|
||||
function getExtendedDynamicField() {
|
||||
return "extended dynamic field";
|
||||
}
|
||||
|
|
|
|||
|
|
@ -0,0 +1,8 @@
|
|||
---
|
||||
format: 1
|
||||
handler:
|
||||
commit: 8a266aadcec878681ed458796b1ce792cc377f79
|
||||
branch: master
|
||||
lock: false
|
||||
repository_class: Piston::Git::Repository
|
||||
repository_url: https://github.com/fabpot/yaml.git
|
||||
|
|
@ -0,0 +1,19 @@
|
|||
Copyright (c) 2008-2009 Fabien Potencier
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is furnished
|
||||
to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all
|
||||
copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
||||
THE SOFTWARE.
|
||||
|
|
@ -0,0 +1,15 @@
|
|||
Symfony YAML: A PHP library that speaks YAML
|
||||
============================================
|
||||
|
||||
Symfony YAML is a PHP library that parses YAML strings and converts them to
|
||||
PHP arrays. It can also converts PHP arrays to YAML strings. Its official
|
||||
website is at http://components.symfony-project.org/yaml/.
|
||||
|
||||
The documentation is to be found in the `doc/` directory.
|
||||
|
||||
Symfony YAML is licensed under the MIT license (see LICENSE file).
|
||||
|
||||
The Symfony YAML library is developed and maintained by the
|
||||
[symfony](http://www.symfony-project.org/) project team. It has been extracted
|
||||
from symfony to be used as a standalone library. Symfony YAML is part of the
|
||||
[symfony components project](http://components.symfony-project.org/).
|
||||
|
|
@ -0,0 +1,143 @@
|
|||
Introduction
|
||||
============
|
||||
|
||||
This book is about *Symfony YAML*, a PHP library part of the Symfony
|
||||
Components project. Its official website is at
|
||||
http://components.symfony-project.org/yaml/.
|
||||
|
||||
>**SIDEBAR**
|
||||
>About the Symfony Components
|
||||
>
|
||||
>[Symfony Components](http://components.symfony-project.org/) are
|
||||
>standalone PHP classes that can be easily used in any
|
||||
>PHP project. Most of the time, they have been developed as part of the
|
||||
>[Symfony framework](http://www.symfony-project.org/), and decoupled from the
|
||||
>main framework later on. You don't need to use the Symfony MVC framework to use
|
||||
>the components.
|
||||
|
||||
What is it?
|
||||
-----------
|
||||
|
||||
Symfony YAML is a PHP library that parses YAML strings and converts them to
|
||||
PHP arrays. It can also converts PHP arrays to YAML strings.
|
||||
|
||||
[YAML](http://www.yaml.org/), YAML Ain't Markup Language, is a human friendly
|
||||
data serialization standard for all programming languages. YAML is a great
|
||||
format for your configuration files. YAML files are as expressive as XML files
|
||||
and as readable as INI files.
|
||||
|
||||
### Easy to use
|
||||
|
||||
There is only one archive to download, and you are ready to go. No
|
||||
configuration, No installation. Drop the files in a directory and start using
|
||||
it today in your projects.
|
||||
|
||||
### Open-Source
|
||||
|
||||
Released under the MIT license, you are free to do whatever you want, even in
|
||||
a commercial environment. You are also encouraged to contribute.
|
||||
|
||||
|
||||
### Used by popular Projects
|
||||
|
||||
Symfony YAML was initially released as part of the symfony framework, one of
|
||||
the most popular PHP web framework. It is also embedded in other popular
|
||||
projects like PHPUnit or Doctrine.
|
||||
|
||||
### Documented
|
||||
|
||||
Symfony YAML is fully documented, with a dedicated online book, and of course
|
||||
a full API documentation.
|
||||
|
||||
### Fast
|
||||
|
||||
One of the goal of Symfony YAML is to find the right balance between speed and
|
||||
features. It supports just the needed feature to handle configuration files.
|
||||
|
||||
### Unit tested
|
||||
|
||||
The library is fully unit-tested. With more than 400 unit tests, the library
|
||||
is stable and is already used in large projects.
|
||||
|
||||
### Real Parser
|
||||
|
||||
It sports a real parser and is able to parse a large subset of the YAML
|
||||
specification, for all your configuration needs. It also means that the parser
|
||||
is pretty robust, easy to understand, and simple enough to extend.
|
||||
|
||||
### Clear error messages
|
||||
|
||||
Whenever you have a syntax problem with your YAML files, the library outputs a
|
||||
helpful message with the filename and the line number where the problem
|
||||
occurred. It eases the debugging a lot.
|
||||
|
||||
### Dump support
|
||||
|
||||
It is also able to dump PHP arrays to YAML with object support, and inline
|
||||
level configuration for pretty outputs.
|
||||
|
||||
### Types Support
|
||||
|
||||
It supports most of the YAML built-in types like dates, integers, octals,
|
||||
booleans, and much more...
|
||||
|
||||
|
||||
### Full merge key support
|
||||
|
||||
Full support for references, aliases, and full merge key. Don't repeat
|
||||
yourself by referencing common configuration bits.
|
||||
|
||||
### PHP Embedding
|
||||
|
||||
YAML files are dynamic. By embedding PHP code inside a YAML file, you have
|
||||
even more power for your configuration files.
|
||||
|
||||
Installation
|
||||
------------
|
||||
|
||||
Symfony YAML can be installed by downloading the source code as a
|
||||
[tar](http://github.com/fabpot/yaml/tarball/master) archive or a
|
||||
[zip](http://github.com/fabpot/yaml/zipball/master) one.
|
||||
|
||||
To stay up-to-date, you can also use the official Subversion
|
||||
[repository](http://svn.symfony-project.com/components/yaml/).
|
||||
|
||||
If you are a Git user, there is an official
|
||||
[mirror](http://github.com/fabpot/yaml), which is updated every 10 minutes.
|
||||
|
||||
If you prefer to install the component globally on your machine, you can use
|
||||
the symfony [PEAR](http://pear.symfony-project.com/) channel server.
|
||||
|
||||
Support
|
||||
-------
|
||||
|
||||
Support questions and enhancements can be discussed on the
|
||||
[mailing-list](http://groups.google.com/group/symfony-components).
|
||||
|
||||
If you find a bug, you can create a ticket at the symfony
|
||||
[trac](http://trac.symfony-project.org/newticket) under the *YAML* component.
|
||||
|
||||
License
|
||||
-------
|
||||
|
||||
The Symfony YAML component is licensed under the *MIT license*:
|
||||
|
||||
>Copyright (c) 2008-2009 Fabien Potencier
|
||||
>
|
||||
>Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
>of this software and associated documentation files (the "Software"), to deal
|
||||
>in the Software without restriction, including without limitation the rights
|
||||
>to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
>copies of the Software, and to permit persons to whom the Software is furnished
|
||||
>to do so, subject to the following conditions:
|
||||
>
|
||||
>The above copyright notice and this permission notice shall be included in all
|
||||
>copies or substantial portions of the Software.
|
||||
>
|
||||
>THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
>IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
>FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
>AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
>LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
>OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
||||
>THE SOFTWARE.
|
||||
|
|
@ -0,0 +1,110 @@
|
|||
Using Symfony YAML
|
||||
==================
|
||||
|
||||
The Symfony YAML library is very simple and consists of two main classes: one
|
||||
to parse YAML strings (`sfYamlParser`), and the other to dump a PHP array to
|
||||
a YAML string (`sfYamlDumper`).
|
||||
|
||||
On top of these two core classes, the main `sfYaml` class acts as a thin
|
||||
wrapper and simplifies common uses.
|
||||
|
||||
Reading YAML Files
|
||||
------------------
|
||||
|
||||
The `sfYamlParser::parse()` method parses a YAML string and converts it to a
|
||||
PHP array:
|
||||
|
||||
[php]
|
||||
$yaml = new sfYamlParser();
|
||||
$value = $yaml->parse(file_get_contents('/path/to/file.yaml'));
|
||||
|
||||
If an error occurs during parsing, the parser throws an exception indicating
|
||||
the error type and the line in the original YAML string where the error
|
||||
occurred:
|
||||
|
||||
[php]
|
||||
try
|
||||
{
|
||||
$value = $yaml->parse(file_get_contents('/path/to/file.yaml'));
|
||||
}
|
||||
catch (InvalidArgumentException $e)
|
||||
{
|
||||
// an error occurred during parsing
|
||||
echo "Unable to parse the YAML string: ".$e->getMessage();
|
||||
}
|
||||
|
||||
>**TIP**
|
||||
>As the parser is reentrant, you can use the same parser object to load
|
||||
>different YAML strings.
|
||||
|
||||
When loading a YAML file, it is sometimes better to use the `sfYaml::load()`
|
||||
wrapper method:
|
||||
|
||||
[php]
|
||||
$loader = sfYaml::load('/path/to/file.yml');
|
||||
|
||||
The `sfYaml::load()` static method takes a YAML string or a file containing
|
||||
YAML. Internally, it calls the `sfYamlParser::parse()` method, but with some
|
||||
added bonuses:
|
||||
|
||||
* It executes the YAML file as if it was a PHP file, so that you can embed
|
||||
PHP commands in YAML files;
|
||||
|
||||
* When a file cannot be parsed, it automatically adds the file name to the
|
||||
error message, simplifying debugging when your application is loading
|
||||
several YAML files.
|
||||
|
||||
Writing YAML Files
|
||||
------------------
|
||||
|
||||
The `sfYamlDumper` dumps any PHP array to its YAML representation:
|
||||
|
||||
[php]
|
||||
$array = array('foo' => 'bar', 'bar' => array('foo' => 'bar', 'bar' => 'baz'));
|
||||
|
||||
$dumper = new sfYamlDumper();
|
||||
$yaml = $dumper->dump($array);
|
||||
file_put_contents('/path/to/file.yaml', $yaml);
|
||||
|
||||
>**NOTE**
|
||||
>Of course, the Symfony YAML dumper is not able to dump resources. Also,
|
||||
>even if the dumper is able to dump PHP objects, it is to be considered
|
||||
>an alpha feature.
|
||||
|
||||
If you only need to dump one array, you can use the `sfYaml::dump()` static
|
||||
method shortcut:
|
||||
|
||||
[php]
|
||||
$yaml = sfYaml::dump($array, $inline);
|
||||
|
||||
The YAML format supports two kind of representation for arrays, the expanded
|
||||
one, and the inline one. By default, the dumper uses the inline
|
||||
representation:
|
||||
|
||||
[yml]
|
||||
{ foo: bar, bar: { foo: bar, bar: baz } }
|
||||
|
||||
The second argument of the `dump()` method customizes the level at which the
|
||||
output switches from the expanded representation to the inline one:
|
||||
|
||||
[php]
|
||||
echo $dumper->dump($array, 1);
|
||||
|
||||
-
|
||||
|
||||
[yml]
|
||||
foo: bar
|
||||
bar: { foo: bar, bar: baz }
|
||||
|
||||
-
|
||||
|
||||
[php]
|
||||
echo $dumper->dump($array, 2);
|
||||
|
||||
-
|
||||
|
||||
[yml]
|
||||
foo: bar
|
||||
bar:
|
||||
foo: bar
|
||||
bar: baz
|
||||
|
|
@ -0,0 +1,312 @@
|
|||
The YAML Format
|
||||
===============
|
||||
|
||||
According to the official [YAML](http://yaml.org/) website, YAML is "a human
|
||||
friendly data serialization standard for all programming languages".
|
||||
|
||||
Even if the YAML format can describe complex nested data structure, this
|
||||
chapter only describes the minimum set of features needed to use YAML as a
|
||||
configuration file format.
|
||||
|
||||
YAML is a simple language that describes data. As PHP, it has a syntax for
|
||||
simple types like strings, booleans, floats, or integers. But unlike PHP, it
|
||||
makes a difference between arrays (sequences) and hashes (mappings).
|
||||
|
||||
Scalars
|
||||
-------
|
||||
|
||||
The syntax for scalars is similar to the PHP syntax.
|
||||
|
||||
### Strings
|
||||
|
||||
[yml]
|
||||
A string in YAML
|
||||
|
||||
-
|
||||
|
||||
[yml]
|
||||
'A singled-quoted string in YAML'
|
||||
|
||||
>**TIP**
|
||||
>In a single quoted string, a single quote `'` must be doubled:
|
||||
>
|
||||
> [yml]
|
||||
> 'A single quote '' in a single-quoted string'
|
||||
|
||||
[yml]
|
||||
"A double-quoted string in YAML\n"
|
||||
|
||||
Quoted styles are useful when a string starts or ends with one or more
|
||||
relevant spaces.
|
||||
|
||||
>**TIP**
|
||||
>The double-quoted style provides a way to express arbitrary strings, by
|
||||
>using `\` escape sequences. It is very useful when you need to embed a
|
||||
>`\n` or a unicode character in a string.
|
||||
|
||||
When a string contains line breaks, you can use the literal style, indicated
|
||||
by the pipe (`|`), to indicate that the string will span several lines. In
|
||||
literals, newlines are preserved:
|
||||
|
||||
[yml]
|
||||
|
|
||||
\/ /| |\/| |
|
||||
/ / | | | |__
|
||||
|
||||
Alternatively, strings can be written with the folded style, denoted by `>`,
|
||||
where each line break is replaced by a space:
|
||||
|
||||
[yml]
|
||||
>
|
||||
This is a very long sentence
|
||||
that spans several lines in the YAML
|
||||
but which will be rendered as a string
|
||||
without carriage returns.
|
||||
|
||||
>**NOTE**
|
||||
>Notice the two spaces before each line in the previous examples. They
|
||||
>won't appear in the resulting PHP strings.
|
||||
|
||||
### Numbers
|
||||
|
||||
[yml]
|
||||
# an integer
|
||||
12
|
||||
|
||||
-
|
||||
|
||||
[yml]
|
||||
# an octal
|
||||
014
|
||||
|
||||
-
|
||||
|
||||
[yml]
|
||||
# an hexadecimal
|
||||
0xC
|
||||
|
||||
-
|
||||
|
||||
[yml]
|
||||
# a float
|
||||
13.4
|
||||
|
||||
-
|
||||
|
||||
[yml]
|
||||
# an exponential number
|
||||
1.2e+34
|
||||
|
||||
-
|
||||
|
||||
[yml]
|
||||
# infinity
|
||||
.inf
|
||||
|
||||
### Nulls
|
||||
|
||||
Nulls in YAML can be expressed with `null` or `~`.
|
||||
|
||||
### Booleans
|
||||
|
||||
Booleans in YAML are expressed with `true` and `false`.
|
||||
|
||||
>**NOTE**
|
||||
>The symfony YAML parser also recognize `on`, `off`, `yes`, and `no` but
|
||||
>it is strongly discouraged to use them as it has been removed from the
|
||||
>1.2 YAML specifications.
|
||||
|
||||
### Dates
|
||||
|
||||
YAML uses the ISO-8601 standard to express dates:
|
||||
|
||||
[yml]
|
||||
2001-12-14t21:59:43.10-05:00
|
||||
|
||||
-
|
||||
|
||||
[yml]
|
||||
# simple date
|
||||
2002-12-14
|
||||
|
||||
Collections
|
||||
-----------
|
||||
|
||||
A YAML file is rarely used to describe a simple scalar. Most of the time, it
|
||||
describes a collection. A collection can be a sequence or a mapping of
|
||||
elements. Both sequences and mappings are converted to PHP arrays.
|
||||
|
||||
Sequences use a dash followed by a space (`- `):
|
||||
|
||||
[yml]
|
||||
- PHP
|
||||
- Perl
|
||||
- Python
|
||||
|
||||
The previous YAML file is equivalent to the following PHP code:
|
||||
|
||||
[php]
|
||||
array('PHP', 'Perl', 'Python');
|
||||
|
||||
Mappings use a colon followed by a space (`: `) to mark each key/value pair:
|
||||
|
||||
[yml]
|
||||
PHP: 5.2
|
||||
MySQL: 5.1
|
||||
Apache: 2.2.20
|
||||
|
||||
which is equivalent to this PHP code:
|
||||
|
||||
[php]
|
||||
array('PHP' => 5.2, 'MySQL' => 5.1, 'Apache' => '2.2.20');
|
||||
|
||||
>**NOTE**
|
||||
>In a mapping, a key can be any valid scalar.
|
||||
|
||||
The number of spaces between the colon and the value does not matter:
|
||||
|
||||
[yml]
|
||||
PHP: 5.2
|
||||
MySQL: 5.1
|
||||
Apache: 2.2.20
|
||||
|
||||
YAML uses indentation with one or more spaces to describe nested collections:
|
||||
|
||||
[yml]
|
||||
"symfony 1.0":
|
||||
PHP: 5.0
|
||||
Propel: 1.2
|
||||
"symfony 1.2":
|
||||
PHP: 5.2
|
||||
Propel: 1.3
|
||||
|
||||
The following YAML is equivalent to the following PHP code:
|
||||
|
||||
[php]
|
||||
array(
|
||||
'symfony 1.0' => array(
|
||||
'PHP' => 5.0,
|
||||
'Propel' => 1.2,
|
||||
),
|
||||
'symfony 1.2' => array(
|
||||
'PHP' => 5.2,
|
||||
'Propel' => 1.3,
|
||||
),
|
||||
);
|
||||
|
||||
There is one important thing you need to remember when using indentation in a
|
||||
YAML file: *Indentation must be done with one or more spaces, but never with
|
||||
tabulations*.
|
||||
|
||||
You can nest sequences and mappings as you like:
|
||||
|
||||
[yml]
|
||||
'Chapter 1':
|
||||
- Introduction
|
||||
- Event Types
|
||||
'Chapter 2':
|
||||
- Introduction
|
||||
- Helpers
|
||||
|
||||
YAML can also use flow styles for collections, using explicit indicators
|
||||
rather than indentation to denote scope.
|
||||
|
||||
A sequence can be written as a comma separated list within square brackets
|
||||
(`[]`):
|
||||
|
||||
[yml]
|
||||
[PHP, Perl, Python]
|
||||
|
||||
A mapping can be written as a comma separated list of key/values within curly
|
||||
braces (`{}`):
|
||||
|
||||
[yml]
|
||||
{ PHP: 5.2, MySQL: 5.1, Apache: 2.2.20 }
|
||||
|
||||
You can mix and match styles to achieve a better readability:
|
||||
|
||||
[yml]
|
||||
'Chapter 1': [Introduction, Event Types]
|
||||
'Chapter 2': [Introduction, Helpers]
|
||||
|
||||
-
|
||||
|
||||
[yml]
|
||||
"symfony 1.0": { PHP: 5.0, Propel: 1.2 }
|
||||
"symfony 1.2": { PHP: 5.2, Propel: 1.3 }
|
||||
|
||||
Comments
|
||||
--------
|
||||
|
||||
Comments can be added in YAML by prefixing them with a hash mark (`#`):
|
||||
|
||||
[yml]
|
||||
# Comment on a line
|
||||
"symfony 1.0": { PHP: 5.0, Propel: 1.2 } # Comment at the end of a line
|
||||
"symfony 1.2": { PHP: 5.2, Propel: 1.3 }
|
||||
|
||||
>**NOTE**
|
||||
>Comments are simply ignored by the YAML parser and do not need to be
|
||||
>indented according to the current level of nesting in a collection.
|
||||
|
||||
Dynamic YAML files
|
||||
------------------
|
||||
|
||||
In symfony, a YAML file can contain PHP code that is evaluated just before the
|
||||
parsing occurs:
|
||||
|
||||
[php]
|
||||
1.0:
|
||||
version: <?php echo file_get_contents('1.0/VERSION')."\n" ?>
|
||||
1.1:
|
||||
version: "<?php echo file_get_contents('1.1/VERSION') ?>"
|
||||
|
||||
Be careful to not mess up with the indentation. Keep in mind the following
|
||||
simple tips when adding PHP code to a YAML file:
|
||||
|
||||
* The `<?php ?>` statements must always start the line or be embedded in a
|
||||
value.
|
||||
|
||||
* If a `<?php ?>` statement ends a line, you need to explicitly output a new
|
||||
line ("\n").
|
||||
|
||||
<div class="pagebreak"></div>
|
||||
|
||||
A Full Length Example
|
||||
---------------------
|
||||
|
||||
The following example illustrates most YAML notations explained in this
|
||||
document:
|
||||
|
||||
[yml]
|
||||
"symfony 1.0":
|
||||
end_of_maintainance: 2010-01-01
|
||||
is_stable: true
|
||||
release_manager: "Grégoire Hubert"
|
||||
description: >
|
||||
This stable version is the right choice for projects
|
||||
that need to be maintained for a long period of time.
|
||||
latest_beta: ~
|
||||
latest_minor: 1.0.20
|
||||
supported_orms: [Propel]
|
||||
archives: { source: [zip, tgz], sandbox: [zip, tgz] }
|
||||
|
||||
"symfony 1.2":
|
||||
end_of_maintainance: 2008-11-01
|
||||
is_stable: true
|
||||
release_manager: 'Fabian Lange'
|
||||
description: >
|
||||
This stable version is the right choice
|
||||
if you start a new project today.
|
||||
latest_beta: null
|
||||
latest_minor: 1.2.5
|
||||
supported_orms:
|
||||
- Propel
|
||||
- Doctrine
|
||||
archives:
|
||||
source:
|
||||
- zip
|
||||
- tgz
|
||||
sandbox:
|
||||
- zip
|
||||
- tgz
|
||||
|
|
@ -0,0 +1,108 @@
|
|||
Appendix A - License
|
||||
====================
|
||||
|
||||
Attribution-Share Alike 3.0 Unported License
|
||||
--------------------------------------------
|
||||
|
||||
THE WORK (AS DEFINED BELOW) IS PROVIDED UNDER THE TERMS OF THIS CREATIVE COMMONS PUBLIC LICENSE ("CCPL" OR "LICENSE"). THE WORK IS PROTECTED BY COPYRIGHT AND/OR OTHER APPLICABLE LAW. ANY USE OF THE WORK OTHER THAN AS AUTHORIZED UNDER THIS LICENSE OR COPYRIGHT LAW IS PROHIBITED.
|
||||
|
||||
BY EXERCISING ANY RIGHTS TO THE WORK PROVIDED HERE, YOU ACCEPT AND AGREE TO BE BOUND BY THE TERMS OF THIS LICENSE. TO THE EXTENT THIS LICENSE MAY BE CONSIDERED TO BE A CONTRACT, THE LICENSOR GRANTS YOU THE RIGHTS CONTAINED HERE IN CONSIDERATION OF YOUR ACCEPTANCE OF SUCH TERMS AND CONDITIONS.
|
||||
|
||||
1. Definitions
|
||||
|
||||
a. **"Adaptation"** means a work based upon the Work, or upon the Work and other pre-existing works, such as a translation, adaptation, derivative work, arrangement of music or other alterations of a literary or artistic work, or phonogram or performance and includes cinematographic adaptations or any other form in which the Work may be recast, transformed, or adapted including in any form recognizably derived from the original, except that a work that constitutes a Collection will not be considered an Adaptation for the purpose of this License. For the avoidance of doubt, where the Work is a musical work, performance or phonogram, the synchronization of the Work in timed-relation with a moving image ("synching") will be considered an Adaptation for the purpose of this License.
|
||||
|
||||
b. **"Collection"** means a collection of literary or artistic works, such as encyclopedias and anthologies, or performances, phonograms or broadcasts, or other works or subject matter other than works listed in Section 1(f) below, which, by reason of the selection and arrangement of their contents, constitute intellectual creations, in which the Work is included in its entirety in unmodified form along with one or more other contributions, each constituting separate and independent works in themselves, which together are assembled into a collective whole. A work that constitutes a Collection will not be considered an Adaptation (as defined below) for the purposes of this License.
|
||||
|
||||
c. **"Creative Commons Compatible License"** means a license that is listed at http://creativecommons.org/compatiblelicenses that has been approved by Creative Commons as being essentially equivalent to this License, including, at a minimum, because that license: (i) contains terms that have the same purpose, meaning and effect as the License Elements of this License; and, (ii) explicitly permits the relicensing of adaptations of works made available under that license under this License or a Creative Commons jurisdiction license with the same License Elements as this License.
|
||||
|
||||
d. **"Distribute"** means to make available to the public the original and copies of the Work or Adaptation, as appropriate, through sale or other transfer of ownership.
|
||||
|
||||
e. **"License Elements"** means the following high-level license attributes as selected by Licensor and indicated in the title of this License: Attribution, ShareAlike.
|
||||
|
||||
f. **"Licensor"** means the individual, individuals, entity or entities that offer(s) the Work under the terms of this License.
|
||||
|
||||
g. **"Original Author"** means, in the case of a literary or artistic work, the individual, individuals, entity or entities who created the Work or if no individual or entity can be identified, the publisher; and in addition (i) in the case of a performance the actors, singers, musicians, dancers, and other persons who act, sing, deliver, declaim, play in, interpret or otherwise perform literary or artistic works or expressions of folklore; (ii) in the case of a phonogram the producer being the person or legal entity who first fixes the sounds of a performance or other sounds; and, (iii) in the case of broadcasts, the organization that transmits the broadcast.
|
||||
|
||||
h. **"Work"** means the literary and/or artistic work offered under the terms of this License including without limitation any production in the literary, scientific and artistic domain, whatever may be the mode or form of its expression including digital form, such as a book, pamphlet and other writing; a lecture, address, sermon or other work of the same nature; a dramatic or dramatico-musical work; a choreographic work or entertainment in dumb show; a musical composition with or without words; a cinematographic work to which are assimilated works expressed by a process analogous to cinematography; a work of drawing, painting, architecture, sculpture, engraving or lithography; a photographic work to which are assimilated works expressed by a process analogous to photography; a work of applied art; an illustration, map, plan, sketch or three-dimensional work relative to geography, topography, architecture or science; a performance; a broadcast; a phonogram; a compilation of data to the extent it is protected as a copyrightable work; or a work performed by a variety or circus performer to the extent it is not otherwise considered a literary or artistic work.
|
||||
|
||||
i. **"You"** means an individual or entity exercising rights under this License who has not previously violated the terms of this License with respect to the Work, or who has received express permission from the Licensor to exercise rights under this License despite a previous violation.
|
||||
|
||||
j. **"Publicly Perform"** means to perform public recitations of the Work and to communicate to the public those public recitations, by any means or process, including by wire or wireless means or public digital performances; to make available to the public Works in such a way that members of the public may access these Works from a place and at a place individually chosen by them; to perform the Work to the public by any means or process and the communication to the public of the performances of the Work, including by public digital performance; to broadcast and rebroadcast the Work by any means including signs, sounds or images.
|
||||
|
||||
k. **"Reproduce"** means to make copies of the Work by any means including without limitation by sound or visual recordings and the right of fixation and reproducing fixations of the Work, including storage of a protected performance or phonogram in digital form or other electronic medium.
|
||||
|
||||
2. Fair Dealing Rights
|
||||
|
||||
Nothing in this License is intended to reduce, limit, or restrict any uses free from copyright or rights arising from limitations or exceptions that are provided for in connection with the copyright protection under copyright law or other applicable laws.
|
||||
|
||||
3. License Grant
|
||||
|
||||
Subject to the terms and conditions of this License, Licensor hereby grants You a worldwide, royalty-free, non-exclusive, perpetual (for the duration of the applicable copyright) license to exercise the rights in the Work as stated below:
|
||||
|
||||
a. to Reproduce the Work, to incorporate the Work into one or more Collections, and to Reproduce the Work as incorporated in the Collections;
|
||||
|
||||
b. to create and Reproduce Adaptations provided that any such Adaptation, including any translation in any medium, takes reasonable steps to clearly label, demarcate or otherwise identify that changes were made to the original Work. For example, a translation could be marked "The original work was translated from English to Spanish," or a modification could indicate "The original work has been modified.";
|
||||
|
||||
c. to Distribute and Publicly Perform the Work including as incorporated in Collections; and,
|
||||
|
||||
d. to Distribute and Publicly Perform Adaptations.
|
||||
|
||||
e. For the avoidance of doubt:
|
||||
|
||||
i. **Non-waivable Compulsory License Schemes**. In those jurisdictions in which the right to collect royalties through any statutory or compulsory licensing scheme cannot be waived, the Licensor reserves the exclusive right to collect such royalties for any exercise by You of the rights granted under this License;
|
||||
|
||||
ii. **Waivable Compulsory License Schemes**. In those jurisdictions in which the right to collect royalties through any statutory or compulsory licensing scheme can be waived, the Licensor waives the exclusive right to collect such royalties for any exercise by You of the rights granted under this License; and,
|
||||
|
||||
iii. **Voluntary License Schemes**. The Licensor waives the right to collect royalties, whether individually or, in the event that the Licensor is a member of a collecting society that administers voluntary licensing schemes, via that society, from any exercise by You of the rights granted under this License.
|
||||
|
||||
The above rights may be exercised in all media and formats whether now known or hereafter devised. The above rights include the right to make such modifications as are technically necessary to exercise the rights in other media and formats. Subject to Section 8(f), all rights not expressly granted by Licensor are hereby reserved.
|
||||
|
||||
4. Restrictions
|
||||
|
||||
The license granted in Section 3 above is expressly made subject to and limited by the following restrictions:
|
||||
|
||||
a. You may Distribute or Publicly Perform the Work only under the terms of this License. You must include a copy of, or the Uniform Resource Identifier (URI) for, this License with every copy of the Work You Distribute or Publicly Perform. You may not offer or impose any terms on the Work that restrict the terms of this License or the ability of the recipient of the Work to exercise the rights granted to that recipient under the terms of the License. You may not sublicense the Work. You must keep intact all notices that refer to this License and to the disclaimer of warranties with every copy of the Work You Distribute or Publicly Perform. When You Distribute or Publicly Perform the Work, You may not impose any effective technological measures on the Work that restrict the ability of a recipient of the Work from You to exercise the rights granted to that recipient under the terms of the License. This Section 4(a) applies to the Work as incorporated in a Collection, but this does not require the Collection apart from the Work itself to be made subject to the terms of this License. If You create a Collection, upon notice from any Licensor You must, to the extent practicable, remove from the Collection any credit as required by Section 4(c), as requested. If You create an Adaptation, upon notice from any Licensor You must, to the extent practicable, remove from the Adaptation any credit as required by Section 4(c), as requested.
|
||||
|
||||
b. You may Distribute or Publicly Perform an Adaptation only under the terms of: (i) this License; (ii) a later version of this License with the same License Elements as this License; (iii) a Creative Commons jurisdiction license (either this or a later license version) that contains the same License Elements as this License (e.g., Attribution-ShareAlike 3.0 US)); (iv) a Creative Commons Compatible License. If you license the Adaptation under one of the licenses mentioned in (iv), you must comply with the terms of that license. If you license the Adaptation under the terms of any of the licenses mentioned in (i), (ii) or (iii) (the "Applicable License"), you must comply with the terms of the Applicable License generally and the following provisions: (I) You must include a copy of, or the URI for, the Applicable License with every copy of each Adaptation You Distribute or Publicly Perform; (II) You may not offer or impose any terms on the Adaptation that restrict the terms of the Applicable License or the ability of the recipient of the Adaptation to exercise the rights granted to that recipient under the terms of the Applicable License; (III) You must keep intact all notices that refer to the Applicable License and to the disclaimer of warranties with every copy of the Work as included in the Adaptation You Distribute or Publicly Perform; (IV) when You Distribute or Publicly Perform the Adaptation, You may not impose any effective technological measures on the Adaptation that restrict the ability of a recipient of the Adaptation from You to exercise the rights granted to that recipient under the terms of the Applicable License. This Section 4(b) applies to the Adaptation as incorporated in a Collection, but this does not require the Collection apart from the Adaptation itself to be made subject to the terms of the Applicable License.
|
||||
|
||||
c. If You Distribute, or Publicly Perform the Work or any Adaptations or Collections, You must, unless a request has been made pursuant to Section 4(a), keep intact all copyright notices for the Work and provide, reasonable to the medium or means You are utilizing: (i) the name of the Original Author (or pseudonym, if applicable) if supplied, and/or if the Original Author and/or Licensor designate another party or parties (e.g., a sponsor institute, publishing entity, journal) for attribution ("Attribution Parties") in Licensor's copyright notice, terms of service or by other reasonable means, the name of such party or parties; (ii) the title of the Work if supplied; (iii) to the extent reasonably practicable, the URI, if any, that Licensor specifies to be associated with the Work, unless such URI does not refer to the copyright notice or licensing information for the Work; and (iv) , consistent with Ssection 3(b), in the case of an Adaptation, a credit identifying the use of the Work in the Adaptation (e.g., "French translation of the Work by Original Author," or "Screenplay based on original Work by Original Author"). The credit required by this Section 4(c) may be implemented in any reasonable manner; provided, however, that in the case of a Adaptation or Collection, at a minimum such credit will appear, if a credit for all contributing authors of the Adaptation or Collection appears, then as part of these credits and in a manner at least as prominent as the credits for the other contributing authors. For the avoidance of doubt, You may only use the credit required by this Section for the purpose of attribution in the manner set out above and, by exercising Your rights under this License, You may not implicitly or explicitly assert or imply any connection with, sponsorship or endorsement by the Original Author, Licensor and/or Attribution Parties, as appropriate, of You or Your use of the Work, without the separate, express prior written permission of the Original Author, Licensor and/or Attribution Parties.
|
||||
|
||||
d. Except as otherwise agreed in writing by the Licensor or as may be otherwise permitted by applicable law, if You Reproduce, Distribute or Publicly Perform the Work either by itself or as part of any Adaptations or Collections, You must not distort, mutilate, modify or take other derogatory action in relation to the Work which would be prejudicial to the Original Author's honor or reputation. Licensor agrees that in those jurisdictions (e.g. Japan), in which any exercise of the right granted in Section 3(b) of this License (the right to make Adaptations) would be deemed to be a distortion, mutilation, modification or other derogatory action prejudicial to the Original Author's honor and reputation, the Licensor will waive or not assert, as appropriate, this Section, to the fullest extent permitted by the applicable national law, to enable You to reasonably exercise Your right under Section 3(b) of this License (right to make Adaptations) but not otherwise.
|
||||
|
||||
5. Representations, Warranties and Disclaimer
|
||||
|
||||
UNLESS OTHERWISE MUTUALLY AGREED TO BY THE PARTIES IN WRITING, LICENSOR OFFERS THE WORK AS-IS AND MAKES NO REPRESENTATIONS OR WARRANTIES OF ANY KIND CONCERNING THE WORK, EXPRESS, IMPLIED, STATUTORY OR OTHERWISE, INCLUDING, WITHOUT LIMITATION, WARRANTIES OF TITLE, MERCHANTIBILITY, FITNESS FOR A PARTICULAR PURPOSE, NONINFRINGEMENT, OR THE ABSENCE OF LATENT OR OTHER DEFECTS, ACCURACY, OR THE PRESENCE OF ABSENCE OF ERRORS, WHETHER OR NOT DISCOVERABLE. SOME JURISDICTIONS DO NOT ALLOW THE EXCLUSION OF IMPLIED WARRANTIES, SO SUCH EXCLUSION MAY NOT APPLY TO YOU.
|
||||
|
||||
6. Limitation on Liability
|
||||
|
||||
EXCEPT TO THE EXTENT REQUIRED BY APPLICABLE LAW, IN NO EVENT WILL LICENSOR BE LIABLE TO YOU ON ANY LEGAL THEORY FOR ANY SPECIAL, INCIDENTAL, CONSEQUENTIAL, PUNITIVE OR EXEMPLARY DAMAGES ARISING OUT OF THIS LICENSE OR THE USE OF THE WORK, EVEN IF LICENSOR HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
|
||||
|
||||
7. Termination
|
||||
|
||||
a. This License and the rights granted hereunder will terminate automatically upon any breach by You of the terms of this License. Individuals or entities who have received Adaptations or Collections from You under this License, however, will not have their licenses terminated provided such individuals or entities remain in full compliance with those licenses. Sections 1, 2, 5, 6, 7, and 8 will survive any termination of this License.
|
||||
|
||||
b. Subject to the above terms and conditions, the license granted here is perpetual (for the duration of the applicable copyright in the Work). Notwithstanding the above, Licensor reserves the right to release the Work under different license terms or to stop distributing the Work at any time; provided, however that any such election will not serve to withdraw this License (or any other license that has been, or is required to be, granted under the terms of this License), and this License will continue in full force and effect unless terminated as stated above.
|
||||
|
||||
8. Miscellaneous
|
||||
|
||||
a. Each time You Distribute or Publicly Perform the Work or a Collection, the Licensor offers to the recipient a license to the Work on the same terms and conditions as the license granted to You under this License.
|
||||
|
||||
b. Each time You Distribute or Publicly Perform an Adaptation, Licensor offers to the recipient a license to the original Work on the same terms and conditions as the license granted to You under this License.
|
||||
|
||||
c. If any provision of this License is invalid or unenforceable under applicable law, it shall not affect the validity or enforceability of the remainder of the terms of this License, and without further action by the parties to this agreement, such provision shall be reformed to the minimum extent necessary to make such provision valid and enforceable.
|
||||
|
||||
d. No term or provision of this License shall be deemed waived and no breach consented to unless such waiver or consent shall be in writing and signed by the party to be charged with such waiver or consent.
|
||||
|
||||
e. This License constitutes the entire agreement between the parties with respect to the Work licensed here. There are no understandings, agreements or representations with respect to the Work not specified here. Licensor shall not be bound by any additional provisions that may appear in any communication from You. This License may not be modified without the mutual written agreement of the Licensor and You.
|
||||
|
||||
f. The rights granted under, and the subject matter referenced, in this License were drafted utilizing the terminology of the Berne Convention for the Protection of Literary and Artistic Works (as amended on September 28, 1979), the Rome Convention of 1961, the WIPO Copyright Treaty of 1996, the WIPO Performances and Phonograms Treaty of 1996 and the Universal Copyright Convention (as revised on July 24, 1971). These rights and subject matter take effect in the relevant jurisdiction in which the License terms are sought to be enforced according to the corresponding provisions of the implementation of those treaty provisions in the applicable national law. If the standard suite of rights granted under applicable copyright law includes additional rights not granted under this License, such additional rights are deemed to be included in the License; this License is not intended to restrict the license of any rights under applicable law.
|
||||
|
||||
>**SIDEBAR**
|
||||
>Creative Commons Notice
|
||||
>
|
||||
>Creative Commons is not a party to this License, and makes no warranty whatsoever in connection with the Work. Creative Commons will not be liable to You or any party on any legal theory for any damages whatsoever, including without limitation any general, special, incidental or consequential damages arising in connection to this license. Notwithstanding the foregoing two (2) sentences, if Creative Commons has expressly identified itself as the Licensor hereunder, it shall have all rights and obligations of Licensor.
|
||||
>
|
||||
>Except for the limited purpose of indicating to the public that the Work is licensed under the CCPL, Creative Commons does not authorize the use by either party of the trademark "Creative Commons" or any related trademark or logo of Creative Commons without the prior written consent of Creative Commons. Any permitted use will be in compliance with Creative Commons' then-current trademark usage guidelines, as may be published on its website or otherwise made available upon request from time to time. For the avoidance of doubt, this trademark restriction does not form part of the License.
|
||||
>
|
||||
>Creative Commons may be contacted at http://creativecommons.org/.
|
||||
|
|
@ -0,0 +1,135 @@
|
|||
<?php
|
||||
|
||||
/*
|
||||
* This file is part of the symfony package.
|
||||
* (c) 2004-2006 Fabien Potencier <fabien.potencier@symfony-project.com>
|
||||
*
|
||||
* For the full copyright and license information, please view the LICENSE
|
||||
* file that was distributed with this source code.
|
||||
*/
|
||||
|
||||
/**
|
||||
* sfYaml offers convenience methods to load and dump YAML.
|
||||
*
|
||||
* @package symfony
|
||||
* @subpackage yaml
|
||||
* @author Fabien Potencier <fabien.potencier@symfony-project.com>
|
||||
* @version SVN: $Id: sfYaml.class.php 8988 2008-05-15 20:24:26Z fabien $
|
||||
*/
|
||||
class sfYaml
|
||||
{
|
||||
static protected
|
||||
$spec = '1.2';
|
||||
|
||||
/**
|
||||
* Sets the YAML specification version to use.
|
||||
*
|
||||
* @param string $version The YAML specification version
|
||||
*/
|
||||
static public function setSpecVersion($version)
|
||||
{
|
||||
if (!in_array($version, array('1.1', '1.2')))
|
||||
{
|
||||
throw new InvalidArgumentException(sprintf('Version %s of the YAML specifications is not supported', $version));
|
||||
}
|
||||
|
||||
self::$spec = $version;
|
||||
}
|
||||
|
||||
/**
|
||||
* Gets the YAML specification version to use.
|
||||
*
|
||||
* @return string The YAML specification version
|
||||
*/
|
||||
static public function getSpecVersion()
|
||||
{
|
||||
return self::$spec;
|
||||
}
|
||||
|
||||
/**
|
||||
* Loads YAML into a PHP array.
|
||||
*
|
||||
* The load method, when supplied with a YAML stream (string or file),
|
||||
* will do its best to convert YAML in a file into a PHP array.
|
||||
*
|
||||
* Usage:
|
||||
* <code>
|
||||
* $array = sfYaml::load('config.yml');
|
||||
* print_r($array);
|
||||
* </code>
|
||||
*
|
||||
* @param string $input Path of YAML file or string containing YAML
|
||||
*
|
||||
* @return array The YAML converted to a PHP array
|
||||
*
|
||||
* @throws InvalidArgumentException If the YAML is not valid
|
||||
*/
|
||||
public static function load($input)
|
||||
{
|
||||
$file = '';
|
||||
|
||||
// if input is a file, process it
|
||||
if (strpos($input, "\n") === false && is_file($input))
|
||||
{
|
||||
$file = $input;
|
||||
|
||||
ob_start();
|
||||
$retval = include($input);
|
||||
$content = ob_get_clean();
|
||||
|
||||
// if an array is returned by the config file assume it's in plain php form else in YAML
|
||||
$input = is_array($retval) ? $retval : $content;
|
||||
}
|
||||
|
||||
// if an array is returned by the config file assume it's in plain php form else in YAML
|
||||
if (is_array($input))
|
||||
{
|
||||
return $input;
|
||||
}
|
||||
|
||||
require_once dirname(__FILE__).'/sfYamlParser.php';
|
||||
|
||||
$yaml = new sfYamlParser();
|
||||
|
||||
try
|
||||
{
|
||||
$ret = $yaml->parse($input);
|
||||
}
|
||||
catch (Exception $e)
|
||||
{
|
||||
throw new InvalidArgumentException(sprintf('Unable to parse %s: %s', $file ? sprintf('file "%s"', $file) : 'string', $e->getMessage()));
|
||||
}
|
||||
|
||||
return $ret;
|
||||
}
|
||||
|
||||
/**
|
||||
* Dumps a PHP array to a YAML string.
|
||||
*
|
||||
* The dump method, when supplied with an array, will do its best
|
||||
* to convert the array into friendly YAML.
|
||||
*
|
||||
* @param array $array PHP array
|
||||
* @param integer $inline The level where you switch to inline YAML
|
||||
*
|
||||
* @return string A YAML string representing the original PHP array
|
||||
*/
|
||||
public static function dump($array, $inline = 2)
|
||||
{
|
||||
require_once dirname(__FILE__).'/sfYamlDumper.php';
|
||||
|
||||
$yaml = new sfYamlDumper();
|
||||
|
||||
return $yaml->dump($array, $inline);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Wraps echo to automatically provide a newline.
|
||||
*
|
||||
* @param string $string The string to echo with new line
|
||||
*/
|
||||
function echoln($string)
|
||||
{
|
||||
echo $string."\n";
|
||||
}
|
||||
|
|
@ -0,0 +1,60 @@
|
|||
<?php
|
||||
|
||||
/*
|
||||
* This file is part of the symfony package.
|
||||
* (c) Fabien Potencier <fabien.potencier@symfony-project.com>
|
||||
*
|
||||
* For the full copyright and license information, please view the LICENSE
|
||||
* file that was distributed with this source code.
|
||||
*/
|
||||
|
||||
require_once(dirname(__FILE__).'/sfYamlInline.php');
|
||||
|
||||
/**
|
||||
* sfYamlDumper dumps PHP variables to YAML strings.
|
||||
*
|
||||
* @package symfony
|
||||
* @subpackage yaml
|
||||
* @author Fabien Potencier <fabien.potencier@symfony-project.com>
|
||||
* @version SVN: $Id: sfYamlDumper.class.php 10575 2008-08-01 13:08:42Z nicolas $
|
||||
*/
|
||||
class sfYamlDumper
|
||||
{
|
||||
/**
|
||||
* Dumps a PHP value to YAML.
|
||||
*
|
||||
* @param mixed $input The PHP value
|
||||
* @param integer $inline The level where you switch to inline YAML
|
||||
* @param integer $indent The level o indentation indentation (used internally)
|
||||
*
|
||||
* @return string The YAML representation of the PHP value
|
||||
*/
|
||||
public function dump($input, $inline = 0, $indent = 0)
|
||||
{
|
||||
$output = '';
|
||||
$prefix = $indent ? str_repeat(' ', $indent) : '';
|
||||
|
||||
if ($inline <= 0 || !is_array($input) || empty($input))
|
||||
{
|
||||
$output .= $prefix.sfYamlInline::dump($input);
|
||||
}
|
||||
else
|
||||
{
|
||||
$isAHash = array_keys($input) !== range(0, count($input) - 1);
|
||||
|
||||
foreach ($input as $key => $value)
|
||||
{
|
||||
$willBeInlined = $inline - 1 <= 0 || !is_array($value) || empty($value);
|
||||
|
||||
$output .= sprintf('%s%s%s%s',
|
||||
$prefix,
|
||||
$isAHash ? sfYamlInline::dump($key).':' : '-',
|
||||
$willBeInlined ? ' ' : "\n",
|
||||
$this->dump($value, $inline - 1, $willBeInlined ? 0 : $indent + 2)
|
||||
).($willBeInlined ? "\n" : '');
|
||||
}
|
||||
}
|
||||
|
||||
return $output;
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,442 @@
|
|||
<?php
|
||||
|
||||
/*
|
||||
* This file is part of the symfony package.
|
||||
* (c) Fabien Potencier <fabien.potencier@symfony-project.com>
|
||||
*
|
||||
* For the full copyright and license information, please view the LICENSE
|
||||
* file that was distributed with this source code.
|
||||
*/
|
||||
|
||||
require_once dirname(__FILE__).'/sfYaml.php';
|
||||
|
||||
/**
|
||||
* sfYamlInline implements a YAML parser/dumper for the YAML inline syntax.
|
||||
*
|
||||
* @package symfony
|
||||
* @subpackage yaml
|
||||
* @author Fabien Potencier <fabien.potencier@symfony-project.com>
|
||||
* @version SVN: $Id: sfYamlInline.class.php 16177 2009-03-11 08:32:48Z fabien $
|
||||
*/
|
||||
class sfYamlInline
|
||||
{
|
||||
const REGEX_QUOTED_STRING = '(?:"([^"\\\\]*(?:\\\\.[^"\\\\]*)*)"|\'([^\']*(?:\'\'[^\']*)*)\')';
|
||||
|
||||
/**
|
||||
* Convert a YAML string to a PHP array.
|
||||
*
|
||||
* @param string $value A YAML string
|
||||
*
|
||||
* @return array A PHP array representing the YAML string
|
||||
*/
|
||||
static public function load($value)
|
||||
{
|
||||
$value = trim($value);
|
||||
|
||||
if (0 == strlen($value))
|
||||
{
|
||||
return '';
|
||||
}
|
||||
|
||||
if (function_exists('mb_internal_encoding') && ((int) ini_get('mbstring.func_overload')) & 2)
|
||||
{
|
||||
$mbEncoding = mb_internal_encoding();
|
||||
mb_internal_encoding('ASCII');
|
||||
}
|
||||
|
||||
switch ($value[0])
|
||||
{
|
||||
case '[':
|
||||
$result = self::parseSequence($value);
|
||||
break;
|
||||
case '{':
|
||||
$result = self::parseMapping($value);
|
||||
break;
|
||||
default:
|
||||
$result = self::parseScalar($value);
|
||||
}
|
||||
|
||||
if (isset($mbEncoding))
|
||||
{
|
||||
mb_internal_encoding($mbEncoding);
|
||||
}
|
||||
|
||||
return $result;
|
||||
}
|
||||
|
||||
/**
|
||||
* Dumps a given PHP variable to a YAML string.
|
||||
*
|
||||
* @param mixed $value The PHP variable to convert
|
||||
*
|
||||
* @return string The YAML string representing the PHP array
|
||||
*/
|
||||
static public function dump($value)
|
||||
{
|
||||
if ('1.1' === sfYaml::getSpecVersion())
|
||||
{
|
||||
$trueValues = array('true', 'on', '+', 'yes', 'y');
|
||||
$falseValues = array('false', 'off', '-', 'no', 'n');
|
||||
}
|
||||
else
|
||||
{
|
||||
$trueValues = array('true');
|
||||
$falseValues = array('false');
|
||||
}
|
||||
|
||||
switch (true)
|
||||
{
|
||||
case is_resource($value):
|
||||
throw new InvalidArgumentException('Unable to dump PHP resources in a YAML file.');
|
||||
case is_object($value):
|
||||
return '!!php/object:'.serialize($value);
|
||||
case is_array($value):
|
||||
return self::dumpArray($value);
|
||||
case null === $value:
|
||||
return 'null';
|
||||
case true === $value:
|
||||
return 'true';
|
||||
case false === $value:
|
||||
return 'false';
|
||||
case ctype_digit($value):
|
||||
return is_string($value) ? "'$value'" : (int) $value;
|
||||
case is_numeric($value):
|
||||
return is_infinite($value) ? str_ireplace('INF', '.Inf', strval($value)) : (is_string($value) ? "'$value'" : $value);
|
||||
case false !== strpos($value, "\n") || false !== strpos($value, "\r"):
|
||||
return sprintf('"%s"', str_replace(array('"', "\n", "\r"), array('\\"', '\n', '\r'), $value));
|
||||
case preg_match('/[ \s \' " \: \{ \} \[ \] , & \* \# \?] | \A[ - ? | < > = ! % @ ` ]/x', $value):
|
||||
return sprintf("'%s'", str_replace('\'', '\'\'', $value));
|
||||
case '' == $value:
|
||||
return "''";
|
||||
case preg_match(self::getTimestampRegex(), $value):
|
||||
return "'$value'";
|
||||
case in_array(strtolower($value), $trueValues):
|
||||
return "'$value'";
|
||||
case in_array(strtolower($value), $falseValues):
|
||||
return "'$value'";
|
||||
case in_array(strtolower($value), array('null', '~')):
|
||||
return "'$value'";
|
||||
default:
|
||||
return $value;
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Dumps a PHP array to a YAML string.
|
||||
*
|
||||
* @param array $value The PHP array to dump
|
||||
*
|
||||
* @return string The YAML string representing the PHP array
|
||||
*/
|
||||
static protected function dumpArray($value)
|
||||
{
|
||||
// array
|
||||
$keys = array_keys($value);
|
||||
if (
|
||||
(1 == count($keys) && '0' == $keys[0])
|
||||
||
|
||||
(count($keys) > 1 && array_reduce($keys, create_function('$v,$w', 'return (integer) $v + $w;'), 0) == count($keys) * (count($keys) - 1) / 2))
|
||||
{
|
||||
$output = array();
|
||||
foreach ($value as $val)
|
||||
{
|
||||
$output[] = self::dump($val);
|
||||
}
|
||||
|
||||
return sprintf('[%s]', implode(', ', $output));
|
||||
}
|
||||
|
||||
// mapping
|
||||
$output = array();
|
||||
foreach ($value as $key => $val)
|
||||
{
|
||||
$output[] = sprintf('%s: %s', self::dump($key), self::dump($val));
|
||||
}
|
||||
|
||||
return sprintf('{ %s }', implode(', ', $output));
|
||||
}
|
||||
|
||||
/**
|
||||
* Parses a scalar to a YAML string.
|
||||
*
|
||||
* @param scalar $scalar
|
||||
* @param string $delimiters
|
||||
* @param array $stringDelimiter
|
||||
* @param integer $i
|
||||
* @param boolean $evaluate
|
||||
*
|
||||
* @return string A YAML string
|
||||
*/
|
||||
static public function parseScalar($scalar, $delimiters = null, $stringDelimiters = array('"', "'"), &$i = 0, $evaluate = true)
|
||||
{
|
||||
if (in_array($scalar[$i], $stringDelimiters))
|
||||
{
|
||||
// quoted scalar
|
||||
$output = self::parseQuotedScalar($scalar, $i);
|
||||
}
|
||||
else
|
||||
{
|
||||
// "normal" string
|
||||
if (!$delimiters)
|
||||
{
|
||||
$output = substr($scalar, $i);
|
||||
$i += strlen($output);
|
||||
|
||||
// remove comments
|
||||
if (false !== $strpos = strpos($output, ' #'))
|
||||
{
|
||||
$output = rtrim(substr($output, 0, $strpos));
|
||||
}
|
||||
}
|
||||
else if (preg_match('/^(.+?)('.implode('|', $delimiters).')/', substr($scalar, $i), $match))
|
||||
{
|
||||
$output = $match[1];
|
||||
$i += strlen($output);
|
||||
}
|
||||
else
|
||||
{
|
||||
throw new InvalidArgumentException(sprintf('Malformed inline YAML string (%s).', $scalar));
|
||||
}
|
||||
|
||||
$output = $evaluate ? self::evaluateScalar($output) : $output;
|
||||
}
|
||||
|
||||
return $output;
|
||||
}
|
||||
|
||||
/**
|
||||
* Parses a quoted scalar to YAML.
|
||||
*
|
||||
* @param string $scalar
|
||||
* @param integer $i
|
||||
*
|
||||
* @return string A YAML string
|
||||
*/
|
||||
static protected function parseQuotedScalar($scalar, &$i)
|
||||
{
|
||||
if (!preg_match('/'.self::REGEX_QUOTED_STRING.'/Au', substr($scalar, $i), $match))
|
||||
{
|
||||
throw new InvalidArgumentException(sprintf('Malformed inline YAML string (%s).', substr($scalar, $i)));
|
||||
}
|
||||
|
||||
$output = substr($match[0], 1, strlen($match[0]) - 2);
|
||||
|
||||
if ('"' == $scalar[$i])
|
||||
{
|
||||
// evaluate the string
|
||||
$output = str_replace(array('\\"', '\\n', '\\r'), array('"', "\n", "\r"), $output);
|
||||
}
|
||||
else
|
||||
{
|
||||
// unescape '
|
||||
$output = str_replace('\'\'', '\'', $output);
|
||||
}
|
||||
|
||||
$i += strlen($match[0]);
|
||||
|
||||
return $output;
|
||||
}
|
||||
|
||||
/**
|
||||
* Parses a sequence to a YAML string.
|
||||
*
|
||||
* @param string $sequence
|
||||
* @param integer $i
|
||||
*
|
||||
* @return string A YAML string
|
||||
*/
|
||||
static protected function parseSequence($sequence, &$i = 0)
|
||||
{
|
||||
$output = array();
|
||||
$len = strlen($sequence);
|
||||
$i += 1;
|
||||
|
||||
// [foo, bar, ...]
|
||||
while ($i < $len)
|
||||
{
|
||||
switch ($sequence[$i])
|
||||
{
|
||||
case '[':
|
||||
// nested sequence
|
||||
$output[] = self::parseSequence($sequence, $i);
|
||||
break;
|
||||
case '{':
|
||||
// nested mapping
|
||||
$output[] = self::parseMapping($sequence, $i);
|
||||
break;
|
||||
case ']':
|
||||
return $output;
|
||||
case ',':
|
||||
case ' ':
|
||||
break;
|
||||
default:
|
||||
$isQuoted = in_array($sequence[$i], array('"', "'"));
|
||||
$value = self::parseScalar($sequence, array(',', ']'), array('"', "'"), $i);
|
||||
|
||||
if (!$isQuoted && false !== strpos($value, ': '))
|
||||
{
|
||||
// embedded mapping?
|
||||
try
|
||||
{
|
||||
$value = self::parseMapping('{'.$value.'}');
|
||||
}
|
||||
catch (InvalidArgumentException $e)
|
||||
{
|
||||
// no, it's not
|
||||
}
|
||||
}
|
||||
|
||||
$output[] = $value;
|
||||
|
||||
--$i;
|
||||
}
|
||||
|
||||
++$i;
|
||||
}
|
||||
|
||||
throw new InvalidArgumentException(sprintf('Malformed inline YAML string %s', $sequence));
|
||||
}
|
||||
|
||||
/**
|
||||
* Parses a mapping to a YAML string.
|
||||
*
|
||||
* @param string $mapping
|
||||
* @param integer $i
|
||||
*
|
||||
* @return string A YAML string
|
||||
*/
|
||||
static protected function parseMapping($mapping, &$i = 0)
|
||||
{
|
||||
$output = array();
|
||||
$len = strlen($mapping);
|
||||
$i += 1;
|
||||
|
||||
// {foo: bar, bar:foo, ...}
|
||||
while ($i < $len)
|
||||
{
|
||||
switch ($mapping[$i])
|
||||
{
|
||||
case ' ':
|
||||
case ',':
|
||||
++$i;
|
||||
continue 2;
|
||||
case '}':
|
||||
return $output;
|
||||
}
|
||||
|
||||
// key
|
||||
$key = self::parseScalar($mapping, array(':', ' '), array('"', "'"), $i, false);
|
||||
|
||||
// value
|
||||
$done = false;
|
||||
while ($i < $len)
|
||||
{
|
||||
switch ($mapping[$i])
|
||||
{
|
||||
case '[':
|
||||
// nested sequence
|
||||
$output[$key] = self::parseSequence($mapping, $i);
|
||||
$done = true;
|
||||
break;
|
||||
case '{':
|
||||
// nested mapping
|
||||
$output[$key] = self::parseMapping($mapping, $i);
|
||||
$done = true;
|
||||
break;
|
||||
case ':':
|
||||
case ' ':
|
||||
break;
|
||||
default:
|
||||
$output[$key] = self::parseScalar($mapping, array(',', '}'), array('"', "'"), $i);
|
||||
$done = true;
|
||||
--$i;
|
||||
}
|
||||
|
||||
++$i;
|
||||
|
||||
if ($done)
|
||||
{
|
||||
continue 2;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
throw new InvalidArgumentException(sprintf('Malformed inline YAML string %s', $mapping));
|
||||
}
|
||||
|
||||
/**
|
||||
* Evaluates scalars and replaces magic values.
|
||||
*
|
||||
* @param string $scalar
|
||||
*
|
||||
* @return string A YAML string
|
||||
*/
|
||||
static protected function evaluateScalar($scalar)
|
||||
{
|
||||
$scalar = trim($scalar);
|
||||
|
||||
if ('1.1' === sfYaml::getSpecVersion())
|
||||
{
|
||||
$trueValues = array('true', 'on', '+', 'yes', 'y');
|
||||
$falseValues = array('false', 'off', '-', 'no', 'n');
|
||||
}
|
||||
else
|
||||
{
|
||||
$trueValues = array('true');
|
||||
$falseValues = array('false');
|
||||
}
|
||||
|
||||
switch (true)
|
||||
{
|
||||
case 'null' == strtolower($scalar):
|
||||
case '' == $scalar:
|
||||
case '~' == $scalar:
|
||||
return null;
|
||||
case 0 === strpos($scalar, '!str'):
|
||||
return (string) substr($scalar, 5);
|
||||
case 0 === strpos($scalar, '! '):
|
||||
return intval(self::parseScalar(substr($scalar, 2)));
|
||||
case 0 === strpos($scalar, '!!php/object:'):
|
||||
return unserialize(substr($scalar, 13));
|
||||
case ctype_digit($scalar):
|
||||
$raw = $scalar;
|
||||
$cast = intval($scalar);
|
||||
return '0' == $scalar[0] ? octdec($scalar) : (((string) $raw == (string) $cast) ? $cast : $raw);
|
||||
case in_array(strtolower($scalar), $trueValues):
|
||||
return true;
|
||||
case in_array(strtolower($scalar), $falseValues):
|
||||
return false;
|
||||
case is_numeric($scalar):
|
||||
return '0x' == $scalar[0].$scalar[1] ? hexdec($scalar) : floatval($scalar);
|
||||
case 0 == strcasecmp($scalar, '.inf'):
|
||||
case 0 == strcasecmp($scalar, '.NaN'):
|
||||
return -log(0);
|
||||
case 0 == strcasecmp($scalar, '-.inf'):
|
||||
return log(0);
|
||||
case preg_match('/^(-|\+)?[0-9,]+(\.[0-9]+)?$/', $scalar):
|
||||
return floatval(str_replace(',', '', $scalar));
|
||||
case preg_match(self::getTimestampRegex(), $scalar):
|
||||
return strtotime($scalar);
|
||||
default:
|
||||
return (string) $scalar;
|
||||
}
|
||||
}
|
||||
|
||||
static protected function getTimestampRegex()
|
||||
{
|
||||
return <<<EOF
|
||||
~^
|
||||
(?P<year>[0-9][0-9][0-9][0-9])
|
||||
-(?P<month>[0-9][0-9]?)
|
||||
-(?P<day>[0-9][0-9]?)
|
||||
(?:(?:[Tt]|[ \t]+)
|
||||
(?P<hour>[0-9][0-9]?)
|
||||
:(?P<minute>[0-9][0-9])
|
||||
:(?P<second>[0-9][0-9])
|
||||
(?:\.(?P<fraction>[0-9]*))?
|
||||
(?:[ \t]*(?P<tz>Z|(?P<tz_sign>[-+])(?P<tz_hour>[0-9][0-9]?)
|
||||
(?::(?P<tz_minute>[0-9][0-9]))?))?)?
|
||||
$~x
|
||||
EOF;
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,622 @@
|
|||
<?php
|
||||
|
||||
/*
|
||||
* This file is part of the symfony package.
|
||||
* (c) Fabien Potencier <fabien.potencier@symfony-project.com>
|
||||
*
|
||||
* For the full copyright and license information, please view the LICENSE
|
||||
* file that was distributed with this source code.
|
||||
*/
|
||||
|
||||
require_once(dirname(__FILE__).'/sfYamlInline.php');
|
||||
|
||||
if (!defined('PREG_BAD_UTF8_OFFSET_ERROR'))
|
||||
{
|
||||
define('PREG_BAD_UTF8_OFFSET_ERROR', 5);
|
||||
}
|
||||
|
||||
/**
|
||||
* sfYamlParser parses YAML strings to convert them to PHP arrays.
|
||||
*
|
||||
* @package symfony
|
||||
* @subpackage yaml
|
||||
* @author Fabien Potencier <fabien.potencier@symfony-project.com>
|
||||
* @version SVN: $Id: sfYamlParser.class.php 10832 2008-08-13 07:46:08Z fabien $
|
||||
*/
|
||||
class sfYamlParser
|
||||
{
|
||||
protected
|
||||
$offset = 0,
|
||||
$lines = array(),
|
||||
$currentLineNb = -1,
|
||||
$currentLine = '',
|
||||
$refs = array();
|
||||
|
||||
/**
|
||||
* Constructor
|
||||
*
|
||||
* @param integer $offset The offset of YAML document (used for line numbers in error messages)
|
||||
*/
|
||||
public function __construct($offset = 0)
|
||||
{
|
||||
$this->offset = $offset;
|
||||
}
|
||||
|
||||
/**
|
||||
* Parses a YAML string to a PHP value.
|
||||
*
|
||||
* @param string $value A YAML string
|
||||
*
|
||||
* @return mixed A PHP value
|
||||
*
|
||||
* @throws InvalidArgumentException If the YAML is not valid
|
||||
*/
|
||||
public function parse($value)
|
||||
{
|
||||
$this->currentLineNb = -1;
|
||||
$this->currentLine = '';
|
||||
$this->lines = explode("\n", $this->cleanup($value));
|
||||
|
||||
if (function_exists('mb_internal_encoding') && ((int) ini_get('mbstring.func_overload')) & 2)
|
||||
{
|
||||
$mbEncoding = mb_internal_encoding();
|
||||
mb_internal_encoding('UTF-8');
|
||||
}
|
||||
|
||||
$data = array();
|
||||
while ($this->moveToNextLine())
|
||||
{
|
||||
if ($this->isCurrentLineEmpty())
|
||||
{
|
||||
continue;
|
||||
}
|
||||
|
||||
// tab?
|
||||
if (preg_match('#^\t+#', $this->currentLine))
|
||||
{
|
||||
throw new InvalidArgumentException(sprintf('A YAML file cannot contain tabs as indentation at line %d (%s).', $this->getRealCurrentLineNb() + 1, $this->currentLine));
|
||||
}
|
||||
|
||||
$isRef = $isInPlace = $isProcessed = false;
|
||||
if (preg_match('#^\-((?P<leadspaces>\s+)(?P<value>.+?))?\s*$#u', $this->currentLine, $values))
|
||||
{
|
||||
if (isset($values['value']) && preg_match('#^&(?P<ref>[^ ]+) *(?P<value>.*)#u', $values['value'], $matches))
|
||||
{
|
||||
$isRef = $matches['ref'];
|
||||
$values['value'] = $matches['value'];
|
||||
}
|
||||
|
||||
// array
|
||||
if (!isset($values['value']) || '' == trim($values['value'], ' ') || 0 === strpos(ltrim($values['value'], ' '), '#'))
|
||||
{
|
||||
$c = $this->getRealCurrentLineNb() + 1;
|
||||
$parser = new sfYamlParser($c);
|
||||
$parser->refs =& $this->refs;
|
||||
$data[] = $parser->parse($this->getNextEmbedBlock());
|
||||
}
|
||||
else
|
||||
{
|
||||
if (isset($values['leadspaces'])
|
||||
&& ' ' == $values['leadspaces']
|
||||
&& preg_match('#^(?P<key>'.sfYamlInline::REGEX_QUOTED_STRING.'|[^ \'"\{].*?) *\:(\s+(?P<value>.+?))?\s*$#u', $values['value'], $matches))
|
||||
{
|
||||
// this is a compact notation element, add to next block and parse
|
||||
$c = $this->getRealCurrentLineNb();
|
||||
$parser = new sfYamlParser($c);
|
||||
$parser->refs =& $this->refs;
|
||||
|
||||
$block = $values['value'];
|
||||
if (!$this->isNextLineIndented())
|
||||
{
|
||||
$block .= "\n".$this->getNextEmbedBlock($this->getCurrentLineIndentation() + 2);
|
||||
}
|
||||
|
||||
$data[] = $parser->parse($block);
|
||||
}
|
||||
else
|
||||
{
|
||||
$data[] = $this->parseValue($values['value']);
|
||||
}
|
||||
}
|
||||
}
|
||||
else if (preg_match('#^(?P<key>'.sfYamlInline::REGEX_QUOTED_STRING.'|[^ \'"].*?) *\:(\s+(?P<value>.+?))?\s*$#u', $this->currentLine, $values))
|
||||
{
|
||||
$key = sfYamlInline::parseScalar($values['key']);
|
||||
|
||||
if ('<<' === $key)
|
||||
{
|
||||
if (isset($values['value']) && '*' === substr($values['value'], 0, 1))
|
||||
{
|
||||
$isInPlace = substr($values['value'], 1);
|
||||
if (!array_key_exists($isInPlace, $this->refs))
|
||||
{
|
||||
throw new InvalidArgumentException(sprintf('Reference "%s" does not exist at line %s (%s).', $isInPlace, $this->getRealCurrentLineNb() + 1, $this->currentLine));
|
||||
}
|
||||
}
|
||||
else
|
||||
{
|
||||
if (isset($values['value']) && $values['value'] !== '')
|
||||
{
|
||||
$value = $values['value'];
|
||||
}
|
||||
else
|
||||
{
|
||||
$value = $this->getNextEmbedBlock();
|
||||
}
|
||||
$c = $this->getRealCurrentLineNb() + 1;
|
||||
$parser = new sfYamlParser($c);
|
||||
$parser->refs =& $this->refs;
|
||||
$parsed = $parser->parse($value);
|
||||
|
||||
$merged = array();
|
||||
if (!is_array($parsed))
|
||||
{
|
||||
throw new InvalidArgumentException(sprintf("YAML merge keys used with a scalar value instead of an array at line %s (%s)", $this->getRealCurrentLineNb() + 1, $this->currentLine));
|
||||
}
|
||||
else if (isset($parsed[0]))
|
||||
{
|
||||
// Numeric array, merge individual elements
|
||||
foreach (array_reverse($parsed) as $parsedItem)
|
||||
{
|
||||
if (!is_array($parsedItem))
|
||||
{
|
||||
throw new InvalidArgumentException(sprintf("Merge items must be arrays at line %s (%s).", $this->getRealCurrentLineNb() + 1, $parsedItem));
|
||||
}
|
||||
$merged = array_merge($parsedItem, $merged);
|
||||
}
|
||||
}
|
||||
else
|
||||
{
|
||||
// Associative array, merge
|
||||
$merged = array_merge($merged, $parsed);
|
||||
}
|
||||
|
||||
$isProcessed = $merged;
|
||||
}
|
||||
}
|
||||
else if (isset($values['value']) && preg_match('#^&(?P<ref>[^ ]+) *(?P<value>.*)#u', $values['value'], $matches))
|
||||
{
|
||||
$isRef = $matches['ref'];
|
||||
$values['value'] = $matches['value'];
|
||||
}
|
||||
|
||||
if ($isProcessed)
|
||||
{
|
||||
// Merge keys
|
||||
$data = $isProcessed;
|
||||
}
|
||||
// hash
|
||||
else if (!isset($values['value']) || '' == trim($values['value'], ' ') || 0 === strpos(ltrim($values['value'], ' '), '#'))
|
||||
{
|
||||
// if next line is less indented or equal, then it means that the current value is null
|
||||
if ($this->isNextLineIndented())
|
||||
{
|
||||
$data[$key] = null;
|
||||
}
|
||||
else
|
||||
{
|
||||
$c = $this->getRealCurrentLineNb() + 1;
|
||||
$parser = new sfYamlParser($c);
|
||||
$parser->refs =& $this->refs;
|
||||
$data[$key] = $parser->parse($this->getNextEmbedBlock());
|
||||
}
|
||||
}
|
||||
else
|
||||
{
|
||||
if ($isInPlace)
|
||||
{
|
||||
$data = $this->refs[$isInPlace];
|
||||
}
|
||||
else
|
||||
{
|
||||
$data[$key] = $this->parseValue($values['value']);
|
||||
}
|
||||
}
|
||||
}
|
||||
else
|
||||
{
|
||||
// 1-liner followed by newline
|
||||
if (2 == count($this->lines) && empty($this->lines[1]))
|
||||
{
|
||||
$value = sfYamlInline::load($this->lines[0]);
|
||||
if (is_array($value))
|
||||
{
|
||||
$first = reset($value);
|
||||
if ('*' === substr($first, 0, 1))
|
||||
{
|
||||
$data = array();
|
||||
foreach ($value as $alias)
|
||||
{
|
||||
$data[] = $this->refs[substr($alias, 1)];
|
||||
}
|
||||
$value = $data;
|
||||
}
|
||||
}
|
||||
|
||||
if (isset($mbEncoding))
|
||||
{
|
||||
mb_internal_encoding($mbEncoding);
|
||||
}
|
||||
|
||||
return $value;
|
||||
}
|
||||
|
||||
switch (preg_last_error())
|
||||
{
|
||||
case PREG_INTERNAL_ERROR:
|
||||
$error = 'Internal PCRE error on line';
|
||||
break;
|
||||
case PREG_BACKTRACK_LIMIT_ERROR:
|
||||
$error = 'pcre.backtrack_limit reached on line';
|
||||
break;
|
||||
case PREG_RECURSION_LIMIT_ERROR:
|
||||
$error = 'pcre.recursion_limit reached on line';
|
||||
break;
|
||||
case PREG_BAD_UTF8_ERROR:
|
||||
$error = 'Malformed UTF-8 data on line';
|
||||
break;
|
||||
case PREG_BAD_UTF8_OFFSET_ERROR:
|
||||
$error = 'Offset doesn\'t correspond to the begin of a valid UTF-8 code point on line';
|
||||
break;
|
||||
default:
|
||||
$error = 'Unable to parse line';
|
||||
}
|
||||
|
||||
throw new InvalidArgumentException(sprintf('%s %d (%s).', $error, $this->getRealCurrentLineNb() + 1, $this->currentLine));
|
||||
}
|
||||
|
||||
if ($isRef)
|
||||
{
|
||||
$this->refs[$isRef] = end($data);
|
||||
}
|
||||
}
|
||||
|
||||
if (isset($mbEncoding))
|
||||
{
|
||||
mb_internal_encoding($mbEncoding);
|
||||
}
|
||||
|
||||
return empty($data) ? null : $data;
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns the current line number (takes the offset into account).
|
||||
*
|
||||
* @return integer The current line number
|
||||
*/
|
||||
protected function getRealCurrentLineNb()
|
||||
{
|
||||
return $this->currentLineNb + $this->offset;
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns the current line indentation.
|
||||
*
|
||||
* @return integer The current line indentation
|
||||
*/
|
||||
protected function getCurrentLineIndentation()
|
||||
{
|
||||
return strlen($this->currentLine) - strlen(ltrim($this->currentLine, ' '));
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns the next embed block of YAML.
|
||||
*
|
||||
* @param integer $indentation The indent level at which the block is to be read, or null for default
|
||||
*
|
||||
* @return string A YAML string
|
||||
*/
|
||||
protected function getNextEmbedBlock($indentation = null)
|
||||
{
|
||||
$this->moveToNextLine();
|
||||
|
||||
if (null === $indentation)
|
||||
{
|
||||
$newIndent = $this->getCurrentLineIndentation();
|
||||
|
||||
if (!$this->isCurrentLineEmpty() && 0 == $newIndent)
|
||||
{
|
||||
throw new InvalidArgumentException(sprintf('Indentation problem at line %d (%s)', $this->getRealCurrentLineNb() + 1, $this->currentLine));
|
||||
}
|
||||
}
|
||||
else
|
||||
{
|
||||
$newIndent = $indentation;
|
||||
}
|
||||
|
||||
$data = array(substr($this->currentLine, $newIndent));
|
||||
|
||||
while ($this->moveToNextLine())
|
||||
{
|
||||
if ($this->isCurrentLineEmpty())
|
||||
{
|
||||
if ($this->isCurrentLineBlank())
|
||||
{
|
||||
$data[] = substr($this->currentLine, $newIndent);
|
||||
}
|
||||
|
||||
continue;
|
||||
}
|
||||
|
||||
$indent = $this->getCurrentLineIndentation();
|
||||
|
||||
if (preg_match('#^(?P<text> *)$#', $this->currentLine, $match))
|
||||
{
|
||||
// empty line
|
||||
$data[] = $match['text'];
|
||||
}
|
||||
else if ($indent >= $newIndent)
|
||||
{
|
||||
$data[] = substr($this->currentLine, $newIndent);
|
||||
}
|
||||
else if (0 == $indent)
|
||||
{
|
||||
$this->moveToPreviousLine();
|
||||
|
||||
break;
|
||||
}
|
||||
else
|
||||
{
|
||||
throw new InvalidArgumentException(sprintf('Indentation problem at line %d (%s)', $this->getRealCurrentLineNb() + 1, $this->currentLine));
|
||||
}
|
||||
}
|
||||
|
||||
return implode("\n", $data);
|
||||
}
|
||||
|
||||
/**
|
||||
* Moves the parser to the next line.
|
||||
*/
|
||||
protected function moveToNextLine()
|
||||
{
|
||||
if ($this->currentLineNb >= count($this->lines) - 1)
|
||||
{
|
||||
return false;
|
||||
}
|
||||
|
||||
$this->currentLine = $this->lines[++$this->currentLineNb];
|
||||
|
||||
return true;
|
||||
}
|
||||
|
||||
/**
|
||||
* Moves the parser to the previous line.
|
||||
*/
|
||||
protected function moveToPreviousLine()
|
||||
{
|
||||
$this->currentLine = $this->lines[--$this->currentLineNb];
|
||||
}
|
||||
|
||||
/**
|
||||
* Parses a YAML value.
|
||||
*
|
||||
* @param string $value A YAML value
|
||||
*
|
||||
* @return mixed A PHP value
|
||||
*/
|
||||
protected function parseValue($value)
|
||||
{
|
||||
if ('*' === substr($value, 0, 1))
|
||||
{
|
||||
if (false !== $pos = strpos($value, '#'))
|
||||
{
|
||||
$value = substr($value, 1, $pos - 2);
|
||||
}
|
||||
else
|
||||
{
|
||||
$value = substr($value, 1);
|
||||
}
|
||||
|
||||
if (!array_key_exists($value, $this->refs))
|
||||
{
|
||||
throw new InvalidArgumentException(sprintf('Reference "%s" does not exist (%s).', $value, $this->currentLine));
|
||||
}
|
||||
return $this->refs[$value];
|
||||
}
|
||||
|
||||
if (preg_match('/^(?P<separator>\||>)(?P<modifiers>\+|\-|\d+|\+\d+|\-\d+|\d+\+|\d+\-)?(?P<comments> +#.*)?$/', $value, $matches))
|
||||
{
|
||||
$modifiers = isset($matches['modifiers']) ? $matches['modifiers'] : '';
|
||||
|
||||
return $this->parseFoldedScalar($matches['separator'], preg_replace('#\d+#', '', $modifiers), intval(abs($modifiers)));
|
||||
}
|
||||
else
|
||||
{
|
||||
return sfYamlInline::load($value);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Parses a folded scalar.
|
||||
*
|
||||
* @param string $separator The separator that was used to begin this folded scalar (| or >)
|
||||
* @param string $indicator The indicator that was used to begin this folded scalar (+ or -)
|
||||
* @param integer $indentation The indentation that was used to begin this folded scalar
|
||||
*
|
||||
* @return string The text value
|
||||
*/
|
||||
protected function parseFoldedScalar($separator, $indicator = '', $indentation = 0)
|
||||
{
|
||||
$separator = '|' == $separator ? "\n" : ' ';
|
||||
$text = '';
|
||||
|
||||
$notEOF = $this->moveToNextLine();
|
||||
|
||||
while ($notEOF && $this->isCurrentLineBlank())
|
||||
{
|
||||
$text .= "\n";
|
||||
|
||||
$notEOF = $this->moveToNextLine();
|
||||
}
|
||||
|
||||
if (!$notEOF)
|
||||
{
|
||||
return '';
|
||||
}
|
||||
|
||||
if (!preg_match('#^(?P<indent>'.($indentation ? str_repeat(' ', $indentation) : ' +').')(?P<text>.*)$#u', $this->currentLine, $matches))
|
||||
{
|
||||
$this->moveToPreviousLine();
|
||||
|
||||
return '';
|
||||
}
|
||||
|
||||
$textIndent = $matches['indent'];
|
||||
$previousIndent = 0;
|
||||
|
||||
$text .= $matches['text'].$separator;
|
||||
while ($this->currentLineNb + 1 < count($this->lines))
|
||||
{
|
||||
$this->moveToNextLine();
|
||||
|
||||
if (preg_match('#^(?P<indent> {'.strlen($textIndent).',})(?P<text>.+)$#u', $this->currentLine, $matches))
|
||||
{
|
||||
if (' ' == $separator && $previousIndent != $matches['indent'])
|
||||
{
|
||||
$text = substr($text, 0, -1)."\n";
|
||||
}
|
||||
$previousIndent = $matches['indent'];
|
||||
|
||||
$text .= str_repeat(' ', $diff = strlen($matches['indent']) - strlen($textIndent)).$matches['text'].($diff ? "\n" : $separator);
|
||||
}
|
||||
else if (preg_match('#^(?P<text> *)$#', $this->currentLine, $matches))
|
||||
{
|
||||
$text .= preg_replace('#^ {1,'.strlen($textIndent).'}#', '', $matches['text'])."\n";
|
||||
}
|
||||
else
|
||||
{
|
||||
$this->moveToPreviousLine();
|
||||
|
||||
break;
|
||||
}
|
||||
}
|
||||
|
||||
if (' ' == $separator)
|
||||
{
|
||||
// replace last separator by a newline
|
||||
$text = preg_replace('/ (\n*)$/', "\n$1", $text);
|
||||
}
|
||||
|
||||
switch ($indicator)
|
||||
{
|
||||
case '':
|
||||
$text = preg_replace('#\n+$#s', "\n", $text);
|
||||
break;
|
||||
case '+':
|
||||
break;
|
||||
case '-':
|
||||
$text = preg_replace('#\n+$#s', '', $text);
|
||||
break;
|
||||
}
|
||||
|
||||
return $text;
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns true if the next line is indented.
|
||||
*
|
||||
* @return Boolean Returns true if the next line is indented, false otherwise
|
||||
*/
|
||||
protected function isNextLineIndented()
|
||||
{
|
||||
$currentIndentation = $this->getCurrentLineIndentation();
|
||||
$notEOF = $this->moveToNextLine();
|
||||
|
||||
while ($notEOF && $this->isCurrentLineEmpty())
|
||||
{
|
||||
$notEOF = $this->moveToNextLine();
|
||||
}
|
||||
|
||||
if (false === $notEOF)
|
||||
{
|
||||
return false;
|
||||
}
|
||||
|
||||
$ret = false;
|
||||
if ($this->getCurrentLineIndentation() <= $currentIndentation)
|
||||
{
|
||||
$ret = true;
|
||||
}
|
||||
|
||||
$this->moveToPreviousLine();
|
||||
|
||||
return $ret;
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns true if the current line is blank or if it is a comment line.
|
||||
*
|
||||
* @return Boolean Returns true if the current line is empty or if it is a comment line, false otherwise
|
||||
*/
|
||||
protected function isCurrentLineEmpty()
|
||||
{
|
||||
return $this->isCurrentLineBlank() || $this->isCurrentLineComment();
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns true if the current line is blank.
|
||||
*
|
||||
* @return Boolean Returns true if the current line is blank, false otherwise
|
||||
*/
|
||||
protected function isCurrentLineBlank()
|
||||
{
|
||||
return '' == trim($this->currentLine, ' ');
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns true if the current line is a comment line.
|
||||
*
|
||||
* @return Boolean Returns true if the current line is a comment line, false otherwise
|
||||
*/
|
||||
protected function isCurrentLineComment()
|
||||
{
|
||||
//checking explicitly the first char of the trim is faster than loops or strpos
|
||||
$ltrimmedLine = ltrim($this->currentLine, ' ');
|
||||
return $ltrimmedLine[0] === '#';
|
||||
}
|
||||
|
||||
/**
|
||||
* Cleanups a YAML string to be parsed.
|
||||
*
|
||||
* @param string $value The input YAML string
|
||||
*
|
||||
* @return string A cleaned up YAML string
|
||||
*/
|
||||
protected function cleanup($value)
|
||||
{
|
||||
$value = str_replace(array("\r\n", "\r"), "\n", $value);
|
||||
|
||||
if (!preg_match("#\n$#", $value))
|
||||
{
|
||||
$value .= "\n";
|
||||
}
|
||||
|
||||
// strip YAML header
|
||||
$count = 0;
|
||||
$value = preg_replace('#^\%YAML[: ][\d\.]+.*\n#su', '', $value, -1, $count);
|
||||
$this->offset += $count;
|
||||
|
||||
// remove leading comments
|
||||
$trimmedValue = preg_replace('#^(\#.*?\n)+#s', '', $value, -1, $count);
|
||||
if ($count == 1)
|
||||
{
|
||||
// items have been removed, update the offset
|
||||
$this->offset += substr_count($value, "\n") - substr_count($trimmedValue, "\n");
|
||||
$value = $trimmedValue;
|
||||
}
|
||||
|
||||
// remove start of the document marker (---)
|
||||
$trimmedValue = preg_replace('#^\-\-\-.*?\n#s', '', $value, -1, $count);
|
||||
if ($count == 1)
|
||||
{
|
||||
// items have been removed, update the offset
|
||||
$this->offset += substr_count($value, "\n") - substr_count($trimmedValue, "\n");
|
||||
$value = $trimmedValue;
|
||||
|
||||
// remove end of the document marker (...)
|
||||
$value = preg_replace('#\.\.\.\s*$#s', '', $value);
|
||||
}
|
||||
|
||||
return $value;
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,172 @@
|
|||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<package version="2.1" xmlns="http://pear.php.net/dtd/package-2.1" xmlns:tasks="http://pear.php.net/dtd/tasks-1.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://pear.php.net/dtd/tasks-1.0 http://pear.php.net/dtd/tasks-1.0.xsd http://pear.php.net/dtd/package-2.1 http://pear.php.net/dtd/package-2.1.xsd">
|
||||
<name>YAML</name>
|
||||
<channel>pear.symfony-project.com</channel>
|
||||
<summary>The Symfony YAML Component.</summary>
|
||||
<description>The Symfony YAML Component.</description>
|
||||
<lead>
|
||||
<name>Fabien Potencier</name>
|
||||
<user>fabpot</user>
|
||||
<email>fabien.potencier@symfony-project.org</email>
|
||||
<active>yes</active>
|
||||
</lead>
|
||||
<date>2011-02-22</date>
|
||||
<version>
|
||||
<release>1.0.6</release>
|
||||
<api>1.0.0</api>
|
||||
</version>
|
||||
<stability>
|
||||
<release>stable</release>
|
||||
<api>stable</api>
|
||||
</stability>
|
||||
<license uri="http://www.symfony-project.com/license">MIT license</license>
|
||||
<notes>-</notes>
|
||||
<contents>
|
||||
<dir name="/">
|
||||
<file name="SF_README.markdown" role="doc" />
|
||||
<file name="SF_LICENSE" role="doc" />
|
||||
|
||||
<dir name="lib">
|
||||
<file name="sfYaml.php" role="php" />
|
||||
<file name="sfYamlDumper.php" role="php" />
|
||||
<file name="sfYamlInline.php" role="php" />
|
||||
<file name="sfYamlParser.php" role="php" />
|
||||
</dir>
|
||||
</dir>
|
||||
</contents>
|
||||
|
||||
<dependencies>
|
||||
<required>
|
||||
<php>
|
||||
<min>5.2.4</min>
|
||||
</php>
|
||||
<pearinstaller>
|
||||
<min>1.4.1</min>
|
||||
</pearinstaller>
|
||||
</required>
|
||||
</dependencies>
|
||||
|
||||
<phprelease>
|
||||
<filelist>
|
||||
<install as="SymfonyComponents/YAML/sfYaml.php" name="lib/sfYaml.php" />
|
||||
<install as="SymfonyComponents/YAML/sfYamlDumper.php" name="lib/sfYamlDumper.php" />
|
||||
<install as="SymfonyComponents/YAML/sfYamlInline.php" name="lib/sfYamlInline.php" />
|
||||
<install as="SymfonyComponents/YAML/sfYamlParser.php" name="lib/sfYamlParser.php" />
|
||||
</filelist>
|
||||
</phprelease>
|
||||
|
||||
<changelog>
|
||||
<release>
|
||||
<version>
|
||||
<release>1.0.6</release>
|
||||
<api>1.0.0</api>
|
||||
</version>
|
||||
<stability>
|
||||
<release>stable</release>
|
||||
<api>stable</api>
|
||||
</stability>
|
||||
<date>2010-02-22</date>
|
||||
<license>MIT</license>
|
||||
<notes>
|
||||
* fabien: renamed doc files to avoid collision with pecl/yaml
|
||||
</notes>
|
||||
</release>
|
||||
<release>
|
||||
<version>
|
||||
<release>1.0.5</release>
|
||||
<api>1.0.0</api>
|
||||
</version>
|
||||
<stability>
|
||||
<release>stable</release>
|
||||
<api>stable</api>
|
||||
</stability>
|
||||
<date>2010-02-22</date>
|
||||
<license>MIT</license>
|
||||
<notes>
|
||||
* indiyets: fixed package.xml
|
||||
</notes>
|
||||
</release>
|
||||
<release>
|
||||
<version>
|
||||
<release>1.0.4</release>
|
||||
<api>1.0.0</api>
|
||||
</version>
|
||||
<stability>
|
||||
<release>stable</release>
|
||||
<api>stable</api>
|
||||
</stability>
|
||||
<date>2010-11-29</date>
|
||||
<license>MIT</license>
|
||||
<notes>
|
||||
* fabien: fixed parsing of simple inline documents
|
||||
</notes>
|
||||
</release>
|
||||
<release>
|
||||
<version>
|
||||
<release>1.0.3</release>
|
||||
<api>1.0.0</api>
|
||||
</version>
|
||||
<stability>
|
||||
<release>stable</release>
|
||||
<api>stable</api>
|
||||
</stability>
|
||||
<date>2010-04-06</date>
|
||||
<license>MIT</license>
|
||||
<notes>
|
||||
* fabien: fixed YAML parser when mbstring.func_overload is used with an mbstring.internal_encoding different from ASCII
|
||||
* fabien: fixed offset when the document use --- or the %YAML element
|
||||
* fabien: added ? in the list of characters that trigger quoting (for compatibility with libyaml)
|
||||
* fabien: added backtick to the list of characters that trigger quotes as it is reserved for future use
|
||||
* FabianLange: fixed missing newline in sfYamlParser when parsing certain symfony core files
|
||||
* FabianLange: removed the unused value property from Parser
|
||||
* fabien: changed Exception to InvalidArgumentException
|
||||
* fabien: fixed YAML dump when a string contains a \r without a \n
|
||||
</notes>
|
||||
</release>
|
||||
<release>
|
||||
<version>
|
||||
<release>1.0.2</release>
|
||||
<api>1.0.0</api>
|
||||
</version>
|
||||
<stability>
|
||||
<release>stable</release>
|
||||
<api>stable</api>
|
||||
</stability>
|
||||
<date>2009-12-01</date>
|
||||
<license>MIT</license>
|
||||
<notes>
|
||||
* fabien: fixed \ usage in quoted string
|
||||
</notes>
|
||||
</release>
|
||||
<release>
|
||||
<version>
|
||||
<release>1.0.1</release>
|
||||
<api>1.0.0</api>
|
||||
</version>
|
||||
<stability>
|
||||
<release>stable</release>
|
||||
<api>stable</api>
|
||||
</stability>
|
||||
<date>2009-12-01</date>
|
||||
<license>MIT</license>
|
||||
<notes>
|
||||
* fabien: fixed a possible loop in parsing a non-valid quoted string
|
||||
</notes>
|
||||
</release>
|
||||
<release>
|
||||
<version>
|
||||
<release>1.0.0</release>
|
||||
<api>1.0.0</api>
|
||||
</version>
|
||||
<stability>
|
||||
<release>stable</release>
|
||||
<api>stable</api>
|
||||
</stability>
|
||||
<date>2009-11-30</date>
|
||||
<license>MIT</license>
|
||||
<notes>
|
||||
* fabien: first stable release as a Symfony Component
|
||||
</notes>
|
||||
</release>
|
||||
</changelog>
|
||||
</package>
|
||||
|
|
@ -0,0 +1,31 @@
|
|||
--- %YAML:1.0
|
||||
test: Simple Alias Example
|
||||
brief: >
|
||||
If you need to refer to the same item of data twice,
|
||||
you can give that item an alias. The alias is a plain
|
||||
string, starting with an ampersand. The item may then
|
||||
be referred to by the alias throughout your document
|
||||
by using an asterisk before the name of the alias.
|
||||
This is called an anchor.
|
||||
yaml: |
|
||||
- &showell Steve
|
||||
- Clark
|
||||
- Brian
|
||||
- Oren
|
||||
- *showell
|
||||
php: |
|
||||
array('Steve', 'Clark', 'Brian', 'Oren', 'Steve')
|
||||
|
||||
---
|
||||
test: Alias of a Mapping
|
||||
brief: >
|
||||
An alias can be used on any item of data, including
|
||||
sequences, mappings, and other complex data types.
|
||||
yaml: |
|
||||
- &hello
|
||||
Meat: pork
|
||||
Starch: potato
|
||||
- banana
|
||||
- *hello
|
||||
php: |
|
||||
array(array('Meat'=>'pork', 'Starch'=>'potato'), 'banana', array('Meat'=>'pork', 'Starch'=>'potato'))
|
||||
|
|
@ -0,0 +1,178 @@
|
|||
--- %YAML:1.0
|
||||
test: Simple Sequence
|
||||
brief: |
|
||||
You can specify a list in YAML by placing each
|
||||
member of the list on a new line with an opening
|
||||
dash. These lists are called sequences.
|
||||
yaml: |
|
||||
- apple
|
||||
- banana
|
||||
- carrot
|
||||
php: |
|
||||
array('apple', 'banana', 'carrot')
|
||||
---
|
||||
test: Nested Sequences
|
||||
brief: |
|
||||
You can include a sequence within another
|
||||
sequence by giving the sequence an empty
|
||||
dash, followed by an indented list.
|
||||
yaml: |
|
||||
-
|
||||
- foo
|
||||
- bar
|
||||
- baz
|
||||
php: |
|
||||
array(array('foo', 'bar', 'baz'))
|
||||
---
|
||||
test: Mixed Sequences
|
||||
brief: |
|
||||
Sequences can contain any YAML data,
|
||||
including strings and other sequences.
|
||||
yaml: |
|
||||
- apple
|
||||
-
|
||||
- foo
|
||||
- bar
|
||||
- x123
|
||||
- banana
|
||||
- carrot
|
||||
php: |
|
||||
array('apple', array('foo', 'bar', 'x123'), 'banana', 'carrot')
|
||||
---
|
||||
test: Deeply Nested Sequences
|
||||
brief: |
|
||||
Sequences can be nested even deeper, with each
|
||||
level of indentation representing a level of
|
||||
depth.
|
||||
yaml: |
|
||||
-
|
||||
-
|
||||
- uno
|
||||
- dos
|
||||
php: |
|
||||
array(array(array('uno', 'dos')))
|
||||
---
|
||||
test: Simple Mapping
|
||||
brief: |
|
||||
You can add a keyed list (also known as a dictionary or
|
||||
hash) to your document by placing each member of the
|
||||
list on a new line, with a colon seperating the key
|
||||
from its value. In YAML, this type of list is called
|
||||
a mapping.
|
||||
yaml: |
|
||||
foo: whatever
|
||||
bar: stuff
|
||||
php: |
|
||||
array('foo' => 'whatever', 'bar' => 'stuff')
|
||||
---
|
||||
test: Sequence in a Mapping
|
||||
brief: |
|
||||
A value in a mapping can be a sequence.
|
||||
yaml: |
|
||||
foo: whatever
|
||||
bar:
|
||||
- uno
|
||||
- dos
|
||||
php: |
|
||||
array('foo' => 'whatever', 'bar' => array('uno', 'dos'))
|
||||
---
|
||||
test: Nested Mappings
|
||||
brief: |
|
||||
A value in a mapping can be another mapping.
|
||||
yaml: |
|
||||
foo: whatever
|
||||
bar:
|
||||
fruit: apple
|
||||
name: steve
|
||||
sport: baseball
|
||||
php: |
|
||||
array(
|
||||
'foo' => 'whatever',
|
||||
'bar' => array(
|
||||
'fruit' => 'apple',
|
||||
'name' => 'steve',
|
||||
'sport' => 'baseball'
|
||||
)
|
||||
)
|
||||
---
|
||||
test: Mixed Mapping
|
||||
brief: |
|
||||
A mapping can contain any assortment
|
||||
of mappings and sequences as values.
|
||||
yaml: |
|
||||
foo: whatever
|
||||
bar:
|
||||
-
|
||||
fruit: apple
|
||||
name: steve
|
||||
sport: baseball
|
||||
- more
|
||||
-
|
||||
python: rocks
|
||||
perl: papers
|
||||
ruby: scissorses
|
||||
php: |
|
||||
array(
|
||||
'foo' => 'whatever',
|
||||
'bar' => array(
|
||||
array(
|
||||
'fruit' => 'apple',
|
||||
'name' => 'steve',
|
||||
'sport' => 'baseball'
|
||||
),
|
||||
'more',
|
||||
array(
|
||||
'python' => 'rocks',
|
||||
'perl' => 'papers',
|
||||
'ruby' => 'scissorses'
|
||||
)
|
||||
)
|
||||
)
|
||||
---
|
||||
test: Mapping-in-Sequence Shortcut
|
||||
todo: true
|
||||
brief: |
|
||||
If you are adding a mapping to a sequence, you
|
||||
can place the mapping on the same line as the
|
||||
dash as a shortcut.
|
||||
yaml: |
|
||||
- work on YAML.py:
|
||||
- work on Store
|
||||
php: |
|
||||
array(array('work on YAML.py' => array('work on Store')))
|
||||
---
|
||||
test: Sequence-in-Mapping Shortcut
|
||||
todo: true
|
||||
brief: |
|
||||
The dash in a sequence counts as indentation, so
|
||||
you can add a sequence inside of a mapping without
|
||||
needing spaces as indentation.
|
||||
yaml: |
|
||||
allow:
|
||||
- 'localhost'
|
||||
- '%.sourceforge.net'
|
||||
- '%.freepan.org'
|
||||
php: |
|
||||
array('allow' => array('localhost', '%.sourceforge.net', '%.freepan.org'))
|
||||
---
|
||||
todo: true
|
||||
test: Merge key
|
||||
brief: |
|
||||
A merge key ('<<') can be used in a mapping to insert other mappings. If
|
||||
the value associated with the merge key is a mapping, each of its key/value
|
||||
pairs is inserted into the current mapping.
|
||||
yaml: |
|
||||
mapping:
|
||||
name: Joe
|
||||
job: Accountant
|
||||
<<:
|
||||
age: 38
|
||||
php: |
|
||||
array(
|
||||
'mapping' =>
|
||||
array(
|
||||
'name' => 'Joe',
|
||||
'job' => 'Accountant',
|
||||
'age' => 38
|
||||
)
|
||||
)
|
||||
|
|
@ -0,0 +1,52 @@
|
|||
---
|
||||
test: One Element Mapping
|
||||
brief: |
|
||||
A mapping with one key/value pair
|
||||
yaml: |
|
||||
foo: bar
|
||||
php: |
|
||||
array('foo' => 'bar')
|
||||
---
|
||||
test: Multi Element Mapping
|
||||
brief: |
|
||||
More than one key/value pair
|
||||
yaml: |
|
||||
red: baron
|
||||
white: walls
|
||||
blue: berries
|
||||
php: |
|
||||
array(
|
||||
'red' => 'baron',
|
||||
'white' => 'walls',
|
||||
'blue' => 'berries',
|
||||
)
|
||||
---
|
||||
test: Values aligned
|
||||
brief: |
|
||||
Often times human editors of documents will align the values even
|
||||
though YAML emitters generally don't.
|
||||
yaml: |
|
||||
red: baron
|
||||
white: walls
|
||||
blue: berries
|
||||
php: |
|
||||
array(
|
||||
'red' => 'baron',
|
||||
'white' => 'walls',
|
||||
'blue' => 'berries',
|
||||
)
|
||||
---
|
||||
test: Colons aligned
|
||||
brief: |
|
||||
Spaces can come before the ': ' key/value separator.
|
||||
yaml: |
|
||||
red : baron
|
||||
white : walls
|
||||
blue : berries
|
||||
php: |
|
||||
array(
|
||||
'red' => 'baron',
|
||||
'white' => 'walls',
|
||||
'blue' => 'berries',
|
||||
)
|
||||
|
||||
|
|
@ -0,0 +1,85 @@
|
|||
--- %YAML:1.0
|
||||
test: Trailing Document Separator
|
||||
todo: true
|
||||
brief: >
|
||||
You can separate YAML documents
|
||||
with a string of three dashes.
|
||||
yaml: |
|
||||
- foo: 1
|
||||
bar: 2
|
||||
---
|
||||
more: stuff
|
||||
python: |
|
||||
[
|
||||
[ { 'foo': 1, 'bar': 2 } ],
|
||||
{ 'more': 'stuff' }
|
||||
]
|
||||
ruby: |
|
||||
[ { 'foo' => 1, 'bar' => 2 } ]
|
||||
|
||||
---
|
||||
test: Leading Document Separator
|
||||
todo: true
|
||||
brief: >
|
||||
You can explicity give an opening
|
||||
document separator to your YAML stream.
|
||||
yaml: |
|
||||
---
|
||||
- foo: 1
|
||||
bar: 2
|
||||
---
|
||||
more: stuff
|
||||
python: |
|
||||
[
|
||||
[ {'foo': 1, 'bar': 2}],
|
||||
{'more': 'stuff'}
|
||||
]
|
||||
ruby: |
|
||||
[ { 'foo' => 1, 'bar' => 2 } ]
|
||||
|
||||
---
|
||||
test: YAML Header
|
||||
todo: true
|
||||
brief: >
|
||||
The opening separator can contain directives
|
||||
to the YAML parser, such as the version
|
||||
number.
|
||||
yaml: |
|
||||
--- %YAML:1.0
|
||||
foo: 1
|
||||
bar: 2
|
||||
php: |
|
||||
array('foo' => 1, 'bar' => 2)
|
||||
documents: 1
|
||||
|
||||
---
|
||||
test: Red Herring Document Separator
|
||||
brief: >
|
||||
Separators included in blocks or strings
|
||||
are treated as blocks or strings, as the
|
||||
document separator should have no indentation
|
||||
preceding it.
|
||||
yaml: |
|
||||
foo: |
|
||||
---
|
||||
php: |
|
||||
array('foo' => "---\n")
|
||||
|
||||
---
|
||||
test: Multiple Document Separators in Block
|
||||
brief: >
|
||||
This technique allows you to embed other YAML
|
||||
documents within literal blocks.
|
||||
yaml: |
|
||||
foo: |
|
||||
---
|
||||
foo: bar
|
||||
---
|
||||
yo: baz
|
||||
bar: |
|
||||
fooness
|
||||
php: |
|
||||
array(
|
||||
'foo' => "---\nfoo: bar\n---\nyo: baz\n",
|
||||
'bar' => "fooness\n"
|
||||
)
|
||||
|
|
@ -0,0 +1,26 @@
|
|||
---
|
||||
test: Missing value for hash item
|
||||
todo: true
|
||||
brief: |
|
||||
Third item in this hash doesn't have a value
|
||||
yaml: |
|
||||
okay: value
|
||||
also okay: ~
|
||||
causes error because no value specified
|
||||
last key: value okay here too
|
||||
python-error: causes error because no value specified
|
||||
|
||||
---
|
||||
test: Not indenting enough
|
||||
brief: |
|
||||
There was a bug in PyYaml where it was off by one
|
||||
in the indentation check. It was allowing the YAML
|
||||
below.
|
||||
# This is actually valid YAML now. Someone should tell showell.
|
||||
yaml: |
|
||||
foo:
|
||||
firstline: 1
|
||||
secondline: 2
|
||||
php: |
|
||||
array('foo' => null, 'firstline' => 1, 'secondline' => 2)
|
||||
|
||||
|
|
@ -0,0 +1,60 @@
|
|||
---
|
||||
test: Simple Inline Array
|
||||
brief: >
|
||||
Sequences can be contained on a
|
||||
single line, using the inline syntax.
|
||||
Separate each entry with commas and
|
||||
enclose in square brackets.
|
||||
yaml: |
|
||||
seq: [ a, b, c ]
|
||||
php: |
|
||||
array('seq' => array('a', 'b', 'c'))
|
||||
---
|
||||
test: Simple Inline Hash
|
||||
brief: >
|
||||
Mapping can also be contained on
|
||||
a single line, using the inline
|
||||
syntax. Each key-value pair is
|
||||
separated by a colon, with a comma
|
||||
between each entry in the mapping.
|
||||
Enclose with curly braces.
|
||||
yaml: |
|
||||
hash: { name: Steve, foo: bar }
|
||||
php: |
|
||||
array('hash' => array('name' => 'Steve', 'foo' => 'bar'))
|
||||
---
|
||||
test: Multi-line Inline Collections
|
||||
todo: true
|
||||
brief: >
|
||||
Both inline sequences and inline mappings
|
||||
can span multiple lines, provided that you
|
||||
indent the additional lines.
|
||||
yaml: |
|
||||
languages: [ Ruby,
|
||||
Perl,
|
||||
Python ]
|
||||
websites: { YAML: yaml.org,
|
||||
Ruby: ruby-lang.org,
|
||||
Python: python.org,
|
||||
Perl: use.perl.org }
|
||||
php: |
|
||||
array(
|
||||
'languages' => array('Ruby', 'Perl', 'Python'),
|
||||
'websites' => array(
|
||||
'YAML' => 'yaml.org',
|
||||
'Ruby' => 'ruby-lang.org',
|
||||
'Python' => 'python.org',
|
||||
'Perl' => 'use.perl.org'
|
||||
)
|
||||
)
|
||||
---
|
||||
test: Commas in Values (not in the spec!)
|
||||
todo: true
|
||||
brief: >
|
||||
List items in collections are delimited by commas, but
|
||||
there must be a space after each comma. This allows you
|
||||
to add numbers without quoting.
|
||||
yaml: |
|
||||
attendances: [ 45,123, 70,000, 17,222 ]
|
||||
php: |
|
||||
array('attendances' => array(45123, 70000, 17222))
|
||||
|
|
@ -0,0 +1,176 @@
|
|||
--- %YAML:1.0
|
||||
test: Single ending newline
|
||||
brief: >
|
||||
A pipe character, followed by an indented
|
||||
block of text is treated as a literal
|
||||
block, in which newlines are preserved
|
||||
throughout the block, including the final
|
||||
newline.
|
||||
yaml: |
|
||||
---
|
||||
this: |
|
||||
Foo
|
||||
Bar
|
||||
php: |
|
||||
array('this' => "Foo\nBar\n")
|
||||
---
|
||||
test: The '+' indicator
|
||||
brief: >
|
||||
The '+' indicator says to keep newlines at the end of text
|
||||
blocks.
|
||||
yaml: |
|
||||
normal: |
|
||||
extra new lines not kept
|
||||
|
||||
preserving: |+
|
||||
extra new lines are kept
|
||||
|
||||
|
||||
dummy: value
|
||||
php: |
|
||||
array(
|
||||
'normal' => "extra new lines not kept\n",
|
||||
'preserving' => "extra new lines are kept\n\n\n",
|
||||
'dummy' => 'value'
|
||||
)
|
||||
---
|
||||
test: Three trailing newlines in literals
|
||||
brief: >
|
||||
To give you more control over how space
|
||||
is preserved in text blocks, YAML has
|
||||
the keep '+' and chomp '-' indicators.
|
||||
The keep indicator will preserve all
|
||||
ending newlines, while the chomp indicator
|
||||
will strip all ending newlines.
|
||||
yaml: |
|
||||
clipped: |
|
||||
This has one newline.
|
||||
|
||||
|
||||
|
||||
same as "clipped" above: "This has one newline.\n"
|
||||
|
||||
stripped: |-
|
||||
This has no newline.
|
||||
|
||||
|
||||
|
||||
same as "stripped" above: "This has no newline."
|
||||
|
||||
kept: |+
|
||||
This has four newlines.
|
||||
|
||||
|
||||
|
||||
same as "kept" above: "This has four newlines.\n\n\n\n"
|
||||
php: |
|
||||
array(
|
||||
'clipped' => "This has one newline.\n",
|
||||
'same as "clipped" above' => "This has one newline.\n",
|
||||
'stripped' => 'This has no newline.',
|
||||
'same as "stripped" above' => 'This has no newline.',
|
||||
'kept' => "This has four newlines.\n\n\n\n",
|
||||
'same as "kept" above' => "This has four newlines.\n\n\n\n"
|
||||
)
|
||||
---
|
||||
test: Extra trailing newlines with spaces
|
||||
todo: true
|
||||
brief: >
|
||||
Normally, only a single newline is kept
|
||||
from the end of a literal block, unless the
|
||||
keep '+' character is used in combination
|
||||
with the pipe. The following example
|
||||
will preserve all ending whitespace
|
||||
since the last line of both literal blocks
|
||||
contains spaces which extend past the indentation
|
||||
level.
|
||||
yaml: |
|
||||
---
|
||||
this: |
|
||||
Foo
|
||||
|
||||
|
||||
kept: |+
|
||||
Foo
|
||||
|
||||
|
||||
php: |
|
||||
array('this' => "Foo\n\n \n",
|
||||
'kept' => "Foo\n\n \n" )
|
||||
|
||||
---
|
||||
test: Folded Block in a Sequence
|
||||
brief: >
|
||||
A greater-then character, followed by an indented
|
||||
block of text is treated as a folded block, in
|
||||
which lines of text separated by a single newline
|
||||
are concatenated as a single line.
|
||||
yaml: |
|
||||
---
|
||||
- apple
|
||||
- banana
|
||||
- >
|
||||
can't you see
|
||||
the beauty of yaml?
|
||||
hmm
|
||||
- dog
|
||||
php: |
|
||||
array(
|
||||
'apple',
|
||||
'banana',
|
||||
"can't you see the beauty of yaml? hmm\n",
|
||||
'dog'
|
||||
)
|
||||
---
|
||||
test: Folded Block as a Mapping Value
|
||||
brief: >
|
||||
Both literal and folded blocks can be
|
||||
used in collections, as values in a
|
||||
sequence or a mapping.
|
||||
yaml: |
|
||||
---
|
||||
quote: >
|
||||
Mark McGwire's
|
||||
year was crippled
|
||||
by a knee injury.
|
||||
source: espn
|
||||
php: |
|
||||
array(
|
||||
'quote' => "Mark McGwire's year was crippled by a knee injury.\n",
|
||||
'source' => 'espn'
|
||||
)
|
||||
---
|
||||
test: Three trailing newlines in folded blocks
|
||||
brief: >
|
||||
The keep and chomp indicators can also
|
||||
be applied to folded blocks.
|
||||
yaml: |
|
||||
clipped: >
|
||||
This has one newline.
|
||||
|
||||
|
||||
|
||||
same as "clipped" above: "This has one newline.\n"
|
||||
|
||||
stripped: >-
|
||||
This has no newline.
|
||||
|
||||
|
||||
|
||||
same as "stripped" above: "This has no newline."
|
||||
|
||||
kept: >+
|
||||
This has four newlines.
|
||||
|
||||
|
||||
|
||||
same as "kept" above: "This has four newlines.\n\n\n\n"
|
||||
php: |
|
||||
array(
|
||||
'clipped' => "This has one newline.\n",
|
||||
'same as "clipped" above' => "This has one newline.\n",
|
||||
'stripped' => 'This has no newline.',
|
||||
'same as "stripped" above' => 'This has no newline.',
|
||||
'kept' => "This has four newlines.\n\n\n\n",
|
||||
'same as "kept" above' => "This has four newlines.\n\n\n\n"
|
||||
)
|
||||
|
|
@ -0,0 +1,45 @@
|
|||
--- %YAML:1.0
|
||||
test: Empty Sequence
|
||||
brief: >
|
||||
You can represent the empty sequence
|
||||
with an empty inline sequence.
|
||||
yaml: |
|
||||
empty: []
|
||||
php: |
|
||||
array('empty' => array())
|
||||
---
|
||||
test: Empty Mapping
|
||||
brief: >
|
||||
You can represent the empty mapping
|
||||
with an empty inline mapping.
|
||||
yaml: |
|
||||
empty: {}
|
||||
php: |
|
||||
array('empty' => array())
|
||||
---
|
||||
test: Empty Sequence as Entire Document
|
||||
yaml: |
|
||||
[]
|
||||
php: |
|
||||
array()
|
||||
---
|
||||
test: Empty Mapping as Entire Document
|
||||
yaml: |
|
||||
{}
|
||||
php: |
|
||||
array()
|
||||
---
|
||||
test: Null as Document
|
||||
yaml: |
|
||||
~
|
||||
php: |
|
||||
null
|
||||
---
|
||||
test: Empty String
|
||||
brief: >
|
||||
You can represent an empty string
|
||||
with a pair of quotes.
|
||||
yaml: |
|
||||
''
|
||||
php: |
|
||||
''
|
||||
|
|
@ -0,0 +1,1695 @@
|
|||
--- %YAML:1.0
|
||||
test: Sequence of scalars
|
||||
spec: 2.1
|
||||
yaml: |
|
||||
- Mark McGwire
|
||||
- Sammy Sosa
|
||||
- Ken Griffey
|
||||
php: |
|
||||
array('Mark McGwire', 'Sammy Sosa', 'Ken Griffey')
|
||||
---
|
||||
test: Mapping of scalars to scalars
|
||||
spec: 2.2
|
||||
yaml: |
|
||||
hr: 65
|
||||
avg: 0.278
|
||||
rbi: 147
|
||||
php: |
|
||||
array('hr' => 65, 'avg' => 0.278, 'rbi' => 147)
|
||||
---
|
||||
test: Mapping of scalars to sequences
|
||||
spec: 2.3
|
||||
yaml: |
|
||||
american:
|
||||
- Boston Red Sox
|
||||
- Detroit Tigers
|
||||
- New York Yankees
|
||||
national:
|
||||
- New York Mets
|
||||
- Chicago Cubs
|
||||
- Atlanta Braves
|
||||
php: |
|
||||
array('american' =>
|
||||
array( 'Boston Red Sox', 'Detroit Tigers',
|
||||
'New York Yankees' ),
|
||||
'national' =>
|
||||
array( 'New York Mets', 'Chicago Cubs',
|
||||
'Atlanta Braves' )
|
||||
)
|
||||
---
|
||||
test: Sequence of mappings
|
||||
spec: 2.4
|
||||
yaml: |
|
||||
-
|
||||
name: Mark McGwire
|
||||
hr: 65
|
||||
avg: 0.278
|
||||
-
|
||||
name: Sammy Sosa
|
||||
hr: 63
|
||||
avg: 0.288
|
||||
php: |
|
||||
array(
|
||||
array('name' => 'Mark McGwire', 'hr' => 65, 'avg' => 0.278),
|
||||
array('name' => 'Sammy Sosa', 'hr' => 63, 'avg' => 0.288)
|
||||
)
|
||||
---
|
||||
test: Legacy A5
|
||||
todo: true
|
||||
spec: legacy_A5
|
||||
yaml: |
|
||||
?
|
||||
- New York Yankees
|
||||
- Atlanta Braves
|
||||
:
|
||||
- 2001-07-02
|
||||
- 2001-08-12
|
||||
- 2001-08-14
|
||||
?
|
||||
- Detroit Tigers
|
||||
- Chicago Cubs
|
||||
:
|
||||
- 2001-07-23
|
||||
perl-busted: >
|
||||
YAML.pm will be able to emulate this behavior soon. In this regard
|
||||
it may be somewhat more correct than Python's native behaviour which
|
||||
can only use tuples as mapping keys. PyYAML will also need to figure
|
||||
out some clever way to roundtrip structured keys.
|
||||
python: |
|
||||
[
|
||||
{
|
||||
('New York Yankees', 'Atlanta Braves'):
|
||||
[yaml.timestamp('2001-07-02'),
|
||||
yaml.timestamp('2001-08-12'),
|
||||
yaml.timestamp('2001-08-14')],
|
||||
('Detroit Tigers', 'Chicago Cubs'):
|
||||
[yaml.timestamp('2001-07-23')]
|
||||
}
|
||||
]
|
||||
ruby: |
|
||||
{
|
||||
[ 'New York Yankees', 'Atlanta Braves' ] =>
|
||||
[ Date.new( 2001, 7, 2 ), Date.new( 2001, 8, 12 ), Date.new( 2001, 8, 14 ) ],
|
||||
[ 'Detroit Tigers', 'Chicago Cubs' ] =>
|
||||
[ Date.new( 2001, 7, 23 ) ]
|
||||
}
|
||||
syck: |
|
||||
struct test_node seq1[] = {
|
||||
{ T_STR, 0, "New York Yankees" },
|
||||
{ T_STR, 0, "Atlanta Braves" },
|
||||
end_node
|
||||
};
|
||||
struct test_node seq2[] = {
|
||||
{ T_STR, 0, "2001-07-02" },
|
||||
{ T_STR, 0, "2001-08-12" },
|
||||
{ T_STR, 0, "2001-08-14" },
|
||||
end_node
|
||||
};
|
||||
struct test_node seq3[] = {
|
||||
{ T_STR, 0, "Detroit Tigers" },
|
||||
{ T_STR, 0, "Chicago Cubs" },
|
||||
end_node
|
||||
};
|
||||
struct test_node seq4[] = {
|
||||
{ T_STR, 0, "2001-07-23" },
|
||||
end_node
|
||||
};
|
||||
struct test_node map[] = {
|
||||
{ T_SEQ, 0, 0, seq1 },
|
||||
{ T_SEQ, 0, 0, seq2 },
|
||||
{ T_SEQ, 0, 0, seq3 },
|
||||
{ T_SEQ, 0, 0, seq4 },
|
||||
end_node
|
||||
};
|
||||
struct test_node stream[] = {
|
||||
{ T_MAP, 0, 0, map },
|
||||
end_node
|
||||
};
|
||||
|
||||
---
|
||||
test: Sequence of sequences
|
||||
spec: 2.5
|
||||
yaml: |
|
||||
- [ name , hr , avg ]
|
||||
- [ Mark McGwire , 65 , 0.278 ]
|
||||
- [ Sammy Sosa , 63 , 0.288 ]
|
||||
php: |
|
||||
array(
|
||||
array( 'name', 'hr', 'avg' ),
|
||||
array( 'Mark McGwire', 65, 0.278 ),
|
||||
array( 'Sammy Sosa', 63, 0.288 )
|
||||
)
|
||||
---
|
||||
test: Mapping of mappings
|
||||
todo: true
|
||||
spec: 2.6
|
||||
yaml: |
|
||||
Mark McGwire: {hr: 65, avg: 0.278}
|
||||
Sammy Sosa: {
|
||||
hr: 63,
|
||||
avg: 0.288
|
||||
}
|
||||
php: |
|
||||
array(
|
||||
'Mark McGwire' =>
|
||||
array( 'hr' => 65, 'avg' => 0.278 ),
|
||||
'Sammy Sosa' =>
|
||||
array( 'hr' => 63, 'avg' => 0.288 )
|
||||
)
|
||||
---
|
||||
test: Two documents in a stream each with a leading comment
|
||||
todo: true
|
||||
spec: 2.7
|
||||
yaml: |
|
||||
# Ranking of 1998 home runs
|
||||
---
|
||||
- Mark McGwire
|
||||
- Sammy Sosa
|
||||
- Ken Griffey
|
||||
|
||||
# Team ranking
|
||||
---
|
||||
- Chicago Cubs
|
||||
- St Louis Cardinals
|
||||
ruby: |
|
||||
y = YAML::Stream.new
|
||||
y.add( [ 'Mark McGwire', 'Sammy Sosa', 'Ken Griffey' ] )
|
||||
y.add( [ 'Chicago Cubs', 'St Louis Cardinals' ] )
|
||||
documents: 2
|
||||
|
||||
---
|
||||
test: Play by play feed from a game
|
||||
todo: true
|
||||
spec: 2.8
|
||||
yaml: |
|
||||
---
|
||||
time: 20:03:20
|
||||
player: Sammy Sosa
|
||||
action: strike (miss)
|
||||
...
|
||||
---
|
||||
time: 20:03:47
|
||||
player: Sammy Sosa
|
||||
action: grand slam
|
||||
...
|
||||
perl: |
|
||||
[ 'Mark McGwire', 'Sammy Sosa', 'Ken Griffey' ]
|
||||
documents: 2
|
||||
|
||||
---
|
||||
test: Single document with two comments
|
||||
spec: 2.9
|
||||
yaml: |
|
||||
hr: # 1998 hr ranking
|
||||
- Mark McGwire
|
||||
- Sammy Sosa
|
||||
rbi:
|
||||
# 1998 rbi ranking
|
||||
- Sammy Sosa
|
||||
- Ken Griffey
|
||||
php: |
|
||||
array(
|
||||
'hr' => array( 'Mark McGwire', 'Sammy Sosa' ),
|
||||
'rbi' => array( 'Sammy Sosa', 'Ken Griffey' )
|
||||
)
|
||||
---
|
||||
test: Node for Sammy Sosa appears twice in this document
|
||||
spec: 2.10
|
||||
yaml: |
|
||||
---
|
||||
hr:
|
||||
- Mark McGwire
|
||||
# Following node labeled SS
|
||||
- &SS Sammy Sosa
|
||||
rbi:
|
||||
- *SS # Subsequent occurance
|
||||
- Ken Griffey
|
||||
php: |
|
||||
array(
|
||||
'hr' =>
|
||||
array('Mark McGwire', 'Sammy Sosa'),
|
||||
'rbi' =>
|
||||
array('Sammy Sosa', 'Ken Griffey')
|
||||
)
|
||||
---
|
||||
test: Mapping between sequences
|
||||
todo: true
|
||||
spec: 2.11
|
||||
yaml: |
|
||||
? # PLAY SCHEDULE
|
||||
- Detroit Tigers
|
||||
- Chicago Cubs
|
||||
:
|
||||
- 2001-07-23
|
||||
|
||||
? [ New York Yankees,
|
||||
Atlanta Braves ]
|
||||
: [ 2001-07-02, 2001-08-12,
|
||||
2001-08-14 ]
|
||||
ruby: |
|
||||
{
|
||||
[ 'Detroit Tigers', 'Chicago Cubs' ] => [ Date.new( 2001, 7, 23 ) ],
|
||||
[ 'New York Yankees', 'Atlanta Braves' ] => [ Date.new( 2001, 7, 2 ), Date.new( 2001, 8, 12 ), Date.new( 2001, 8, 14 ) ]
|
||||
}
|
||||
syck: |
|
||||
struct test_node seq1[] = {
|
||||
{ T_STR, 0, "New York Yankees" },
|
||||
{ T_STR, 0, "Atlanta Braves" },
|
||||
end_node
|
||||
};
|
||||
struct test_node seq2[] = {
|
||||
{ T_STR, 0, "2001-07-02" },
|
||||
{ T_STR, 0, "2001-08-12" },
|
||||
{ T_STR, 0, "2001-08-14" },
|
||||
end_node
|
||||
};
|
||||
struct test_node seq3[] = {
|
||||
{ T_STR, 0, "Detroit Tigers" },
|
||||
{ T_STR, 0, "Chicago Cubs" },
|
||||
end_node
|
||||
};
|
||||
struct test_node seq4[] = {
|
||||
{ T_STR, 0, "2001-07-23" },
|
||||
end_node
|
||||
};
|
||||
struct test_node map[] = {
|
||||
{ T_SEQ, 0, 0, seq3 },
|
||||
{ T_SEQ, 0, 0, seq4 },
|
||||
{ T_SEQ, 0, 0, seq1 },
|
||||
{ T_SEQ, 0, 0, seq2 },
|
||||
end_node
|
||||
};
|
||||
struct test_node stream[] = {
|
||||
{ T_MAP, 0, 0, map },
|
||||
end_node
|
||||
};
|
||||
|
||||
---
|
||||
test: Sequence key shortcut
|
||||
spec: 2.12
|
||||
yaml: |
|
||||
---
|
||||
# products purchased
|
||||
- item : Super Hoop
|
||||
quantity: 1
|
||||
- item : Basketball
|
||||
quantity: 4
|
||||
- item : Big Shoes
|
||||
quantity: 1
|
||||
php: |
|
||||
array (
|
||||
array (
|
||||
'item' => 'Super Hoop',
|
||||
'quantity' => 1,
|
||||
),
|
||||
array (
|
||||
'item' => 'Basketball',
|
||||
'quantity' => 4,
|
||||
),
|
||||
array (
|
||||
'item' => 'Big Shoes',
|
||||
'quantity' => 1,
|
||||
)
|
||||
)
|
||||
perl: |
|
||||
[
|
||||
{ item => 'Super Hoop', quantity => 1 },
|
||||
{ item => 'Basketball', quantity => 4 },
|
||||
{ item => 'Big Shoes', quantity => 1 }
|
||||
]
|
||||
|
||||
ruby: |
|
||||
[
|
||||
{ 'item' => 'Super Hoop', 'quantity' => 1 },
|
||||
{ 'item' => 'Basketball', 'quantity' => 4 },
|
||||
{ 'item' => 'Big Shoes', 'quantity' => 1 }
|
||||
]
|
||||
python: |
|
||||
[
|
||||
{ 'item': 'Super Hoop', 'quantity': 1 },
|
||||
{ 'item': 'Basketball', 'quantity': 4 },
|
||||
{ 'item': 'Big Shoes', 'quantity': 1 }
|
||||
]
|
||||
syck: |
|
||||
struct test_node map1[] = {
|
||||
{ T_STR, 0, "item" },
|
||||
{ T_STR, 0, "Super Hoop" },
|
||||
{ T_STR, 0, "quantity" },
|
||||
{ T_STR, 0, "1" },
|
||||
end_node
|
||||
};
|
||||
struct test_node map2[] = {
|
||||
{ T_STR, 0, "item" },
|
||||
{ T_STR, 0, "Basketball" },
|
||||
{ T_STR, 0, "quantity" },
|
||||
{ T_STR, 0, "4" },
|
||||
end_node
|
||||
};
|
||||
struct test_node map3[] = {
|
||||
{ T_STR, 0, "item" },
|
||||
{ T_STR, 0, "Big Shoes" },
|
||||
{ T_STR, 0, "quantity" },
|
||||
{ T_STR, 0, "1" },
|
||||
end_node
|
||||
};
|
||||
struct test_node seq[] = {
|
||||
{ T_MAP, 0, 0, map1 },
|
||||
{ T_MAP, 0, 0, map2 },
|
||||
{ T_MAP, 0, 0, map3 },
|
||||
end_node
|
||||
};
|
||||
struct test_node stream[] = {
|
||||
{ T_SEQ, 0, 0, seq },
|
||||
end_node
|
||||
};
|
||||
|
||||
|
||||
---
|
||||
test: Literal perserves newlines
|
||||
todo: true
|
||||
spec: 2.13
|
||||
yaml: |
|
||||
# ASCII Art
|
||||
--- |
|
||||
\//||\/||
|
||||
// || ||_
|
||||
perl: |
|
||||
"\\//||\\/||\n// || ||_\n"
|
||||
ruby: |
|
||||
"\\//||\\/||\n// || ||_\n"
|
||||
python: |
|
||||
[
|
||||
flushLeft(
|
||||
"""
|
||||
\//||\/||
|
||||
// || ||_
|
||||
"""
|
||||
)
|
||||
]
|
||||
syck: |
|
||||
struct test_node stream[] = {
|
||||
{ T_STR, 0, "\\//||\\/||\n// || ||_\n" },
|
||||
end_node
|
||||
};
|
||||
|
||||
---
|
||||
test: Folded treats newlines as a space
|
||||
todo: true
|
||||
spec: 2.14
|
||||
yaml: |
|
||||
---
|
||||
Mark McGwire's
|
||||
year was crippled
|
||||
by a knee injury.
|
||||
perl: |
|
||||
"Mark McGwire's year was crippled by a knee injury."
|
||||
ruby: |
|
||||
"Mark McGwire's year was crippled by a knee injury."
|
||||
python: |
|
||||
[ "Mark McGwire's year was crippled by a knee injury." ]
|
||||
syck: |
|
||||
struct test_node stream[] = {
|
||||
{ T_STR, 0, "Mark McGwire's year was crippled by a knee injury." },
|
||||
end_node
|
||||
};
|
||||
|
||||
---
|
||||
test: Newlines preserved for indented and blank lines
|
||||
todo: true
|
||||
spec: 2.15
|
||||
yaml: |
|
||||
--- >
|
||||
Sammy Sosa completed another
|
||||
fine season with great stats.
|
||||
|
||||
63 Home Runs
|
||||
0.288 Batting Average
|
||||
|
||||
What a year!
|
||||
perl: |
|
||||
"Sammy Sosa completed another fine season with great stats.\n\n 63 Home Runs\n 0.288 Batting Average\n\nWhat a year!\n"
|
||||
ruby: |
|
||||
"Sammy Sosa completed another fine season with great stats.\n\n 63 Home Runs\n 0.288 Batting Average\n\nWhat a year!\n"
|
||||
python: |
|
||||
[
|
||||
flushLeft(
|
||||
"""
|
||||
Sammy Sosa completed another fine season with great stats.
|
||||
|
||||
63 Home Runs
|
||||
0.288 Batting Average
|
||||
|
||||
What a year!
|
||||
"""
|
||||
)
|
||||
]
|
||||
syck: |
|
||||
struct test_node stream[] = {
|
||||
{ T_STR, 0, "Sammy Sosa completed another fine season with great stats.\n\n 63 Home Runs\n 0.288 Batting Average\n\nWhat a year!\n" },
|
||||
end_node
|
||||
};
|
||||
|
||||
|
||||
---
|
||||
test: Indentation determines scope
|
||||
spec: 2.16
|
||||
yaml: |
|
||||
name: Mark McGwire
|
||||
accomplishment: >
|
||||
Mark set a major league
|
||||
home run record in 1998.
|
||||
stats: |
|
||||
65 Home Runs
|
||||
0.278 Batting Average
|
||||
php: |
|
||||
array(
|
||||
'name' => 'Mark McGwire',
|
||||
'accomplishment' => "Mark set a major league home run record in 1998.\n",
|
||||
'stats' => "65 Home Runs\n0.278 Batting Average\n"
|
||||
)
|
||||
---
|
||||
test: Quoted scalars
|
||||
todo: true
|
||||
spec: 2.17
|
||||
yaml: |
|
||||
unicode: "Sosa did fine.\u263A"
|
||||
control: "\b1998\t1999\t2000\n"
|
||||
hexesc: "\x0D\x0A is \r\n"
|
||||
|
||||
single: '"Howdy!" he cried.'
|
||||
quoted: ' # not a ''comment''.'
|
||||
tie-fighter: '|\-*-/|'
|
||||
ruby: |
|
||||
{
|
||||
"tie-fighter" => "|\\-*-/|",
|
||||
"control"=>"\0101998\t1999\t2000\n",
|
||||
"unicode"=>"Sosa did fine." + ["263A".hex ].pack('U*'),
|
||||
"quoted"=>" # not a 'comment'.",
|
||||
"single"=>"\"Howdy!\" he cried.",
|
||||
"hexesc"=>"\r\n is \r\n"
|
||||
}
|
||||
---
|
||||
test: Multiline flow scalars
|
||||
todo: true
|
||||
spec: 2.18
|
||||
yaml: |
|
||||
plain:
|
||||
This unquoted scalar
|
||||
spans many lines.
|
||||
|
||||
quoted: "So does this
|
||||
quoted scalar.\n"
|
||||
ruby: |
|
||||
{
|
||||
'plain' => 'This unquoted scalar spans many lines.',
|
||||
'quoted' => "So does this quoted scalar.\n"
|
||||
}
|
||||
---
|
||||
test: Integers
|
||||
spec: 2.19
|
||||
yaml: |
|
||||
canonical: 12345
|
||||
decimal: +12,345
|
||||
octal: 014
|
||||
hexadecimal: 0xC
|
||||
php: |
|
||||
array(
|
||||
'canonical' => 12345,
|
||||
'decimal' => 12345,
|
||||
'octal' => 014,
|
||||
'hexadecimal' => 0xC
|
||||
)
|
||||
---
|
||||
# FIX: spec shows parens around -inf and NaN
|
||||
test: Floating point
|
||||
spec: 2.20
|
||||
yaml: |
|
||||
canonical: 1.23015e+3
|
||||
exponential: 12.3015e+02
|
||||
fixed: 1,230.15
|
||||
negative infinity: -.inf
|
||||
not a number: .NaN
|
||||
php: |
|
||||
array(
|
||||
'canonical' => 1230.15,
|
||||
'exponential' => 1230.15,
|
||||
'fixed' => 1230.15,
|
||||
'negative infinity' => log(0),
|
||||
'not a number' => -log(0),
|
||||
)
|
||||
---
|
||||
test: Miscellaneous
|
||||
spec: 2.21
|
||||
yaml: |
|
||||
null: ~
|
||||
true: y
|
||||
false: n
|
||||
string: '12345'
|
||||
php: |
|
||||
array(
|
||||
'' => null,
|
||||
1 => true,
|
||||
0 => false,
|
||||
'string' => '12345'
|
||||
)
|
||||
---
|
||||
test: Timestamps
|
||||
todo: true
|
||||
spec: 2.22
|
||||
yaml: |
|
||||
canonical: 2001-12-15T02:59:43.1Z
|
||||
iso8601: 2001-12-14t21:59:43.10-05:00
|
||||
spaced: 2001-12-14 21:59:43.10 -05:00
|
||||
date: 2002-12-14 # Time is noon UTC
|
||||
php: |
|
||||
array(
|
||||
'canonical' => YAML::mktime( 2001, 12, 15, 2, 59, 43, 0.10 ),
|
||||
'iso8601' => YAML::mktime( 2001, 12, 14, 21, 59, 43, 0.10, "-05:00" ),
|
||||
'spaced' => YAML::mktime( 2001, 12, 14, 21, 59, 43, 0.10, "-05:00" ),
|
||||
'date' => Date.new( 2002, 12, 14 )
|
||||
)
|
||||
---
|
||||
test: legacy Timestamps test
|
||||
todo: true
|
||||
spec: legacy D4
|
||||
yaml: |
|
||||
canonical: 2001-12-15T02:59:43.00Z
|
||||
iso8601: 2001-02-28t21:59:43.00-05:00
|
||||
spaced: 2001-12-14 21:59:43.00 -05:00
|
||||
date: 2002-12-14
|
||||
php: |
|
||||
array(
|
||||
'canonical' => Time::utc( 2001, 12, 15, 2, 59, 43, 0 ),
|
||||
'iso8601' => YAML::mktime( 2001, 2, 28, 21, 59, 43, 0, "-05:00" ),
|
||||
'spaced' => YAML::mktime( 2001, 12, 14, 21, 59, 43, 0, "-05:00" ),
|
||||
'date' => Date.new( 2002, 12, 14 )
|
||||
)
|
||||
---
|
||||
test: Various explicit families
|
||||
todo: true
|
||||
spec: 2.23
|
||||
yaml: |
|
||||
not-date: !str 2002-04-28
|
||||
picture: !binary |
|
||||
R0lGODlhDAAMAIQAAP//9/X
|
||||
17unp5WZmZgAAAOfn515eXv
|
||||
Pz7Y6OjuDg4J+fn5OTk6enp
|
||||
56enmleECcgggoBADs=
|
||||
|
||||
application specific tag: !!something |
|
||||
The semantics of the tag
|
||||
above may be different for
|
||||
different documents.
|
||||
|
||||
ruby-setup: |
|
||||
YAML.add_private_type( "something" ) do |type, val|
|
||||
"SOMETHING: #{val}"
|
||||
end
|
||||
ruby: |
|
||||
{
|
||||
'not-date' => '2002-04-28',
|
||||
'picture' => "GIF89a\f\000\f\000\204\000\000\377\377\367\365\365\356\351\351\345fff\000\000\000\347\347\347^^^\363\363\355\216\216\216\340\340\340\237\237\237\223\223\223\247\247\247\236\236\236i^\020' \202\n\001\000;",
|
||||
'application specific tag' => "SOMETHING: The semantics of the tag\nabove may be different for\ndifferent documents.\n"
|
||||
}
|
||||
---
|
||||
test: Application specific family
|
||||
todo: true
|
||||
spec: 2.24
|
||||
yaml: |
|
||||
# Establish a tag prefix
|
||||
--- !clarkevans.com,2002/graph/^shape
|
||||
# Use the prefix: shorthand for
|
||||
# !clarkevans.com,2002/graph/circle
|
||||
- !^circle
|
||||
center: &ORIGIN {x: 73, 'y': 129}
|
||||
radius: 7
|
||||
- !^line # !clarkevans.com,2002/graph/line
|
||||
start: *ORIGIN
|
||||
finish: { x: 89, 'y': 102 }
|
||||
- !^label
|
||||
start: *ORIGIN
|
||||
color: 0xFFEEBB
|
||||
value: Pretty vector drawing.
|
||||
ruby-setup: |
|
||||
YAML.add_domain_type( "clarkevans.com,2002", 'graph/shape' ) { |type, val|
|
||||
if Array === val
|
||||
val << "Shape Container"
|
||||
val
|
||||
else
|
||||
raise YAML::Error, "Invalid graph of class #{ val.class }: " + val.inspect
|
||||
end
|
||||
}
|
||||
one_shape_proc = Proc.new { |type, val|
|
||||
scheme, domain, type = type.split( /:/, 3 )
|
||||
if val.is_a? ::Hash
|
||||
val['TYPE'] = "Shape: #{type}"
|
||||
val
|
||||
else
|
||||
raise YAML::Error, "Invalid graph of class #{ val.class }: " + val.inspect
|
||||
end
|
||||
}
|
||||
YAML.add_domain_type( "clarkevans.com,2002", 'graph/circle', &one_shape_proc )
|
||||
YAML.add_domain_type( "clarkevans.com,2002", 'graph/line', &one_shape_proc )
|
||||
YAML.add_domain_type( "clarkevans.com,2002", 'graph/label', &one_shape_proc )
|
||||
ruby: |
|
||||
[
|
||||
{
|
||||
"radius" => 7,
|
||||
"center"=>
|
||||
{
|
||||
"x" => 73,
|
||||
"y" => 129
|
||||
},
|
||||
"TYPE" => "Shape: graph/circle"
|
||||
}, {
|
||||
"finish" =>
|
||||
{
|
||||
"x" => 89,
|
||||
"y" => 102
|
||||
},
|
||||
"TYPE" => "Shape: graph/line",
|
||||
"start" =>
|
||||
{
|
||||
"x" => 73,
|
||||
"y" => 129
|
||||
}
|
||||
}, {
|
||||
"TYPE" => "Shape: graph/label",
|
||||
"value" => "Pretty vector drawing.",
|
||||
"start" =>
|
||||
{
|
||||
"x" => 73,
|
||||
"y" => 129
|
||||
},
|
||||
"color" => 16772795
|
||||
},
|
||||
"Shape Container"
|
||||
]
|
||||
# ---
|
||||
# test: Unordered set
|
||||
# spec: 2.25
|
||||
# yaml: |
|
||||
# # sets are represented as a
|
||||
# # mapping where each key is
|
||||
# # associated with the empty string
|
||||
# --- !set
|
||||
# ? Mark McGwire
|
||||
# ? Sammy Sosa
|
||||
# ? Ken Griff
|
||||
---
|
||||
test: Ordered mappings
|
||||
todo: true
|
||||
spec: 2.26
|
||||
yaml: |
|
||||
# ordered maps are represented as
|
||||
# a sequence of mappings, with
|
||||
# each mapping having one key
|
||||
--- !omap
|
||||
- Mark McGwire: 65
|
||||
- Sammy Sosa: 63
|
||||
- Ken Griffy: 58
|
||||
ruby: |
|
||||
YAML::Omap[
|
||||
'Mark McGwire', 65,
|
||||
'Sammy Sosa', 63,
|
||||
'Ken Griffy', 58
|
||||
]
|
||||
---
|
||||
test: Invoice
|
||||
dump_skip: true
|
||||
spec: 2.27
|
||||
yaml: |
|
||||
--- !clarkevans.com,2002/^invoice
|
||||
invoice: 34843
|
||||
date : 2001-01-23
|
||||
bill-to: &id001
|
||||
given : Chris
|
||||
family : Dumars
|
||||
address:
|
||||
lines: |
|
||||
458 Walkman Dr.
|
||||
Suite #292
|
||||
city : Royal Oak
|
||||
state : MI
|
||||
postal : 48046
|
||||
ship-to: *id001
|
||||
product:
|
||||
-
|
||||
sku : BL394D
|
||||
quantity : 4
|
||||
description : Basketball
|
||||
price : 450.00
|
||||
-
|
||||
sku : BL4438H
|
||||
quantity : 1
|
||||
description : Super Hoop
|
||||
price : 2392.00
|
||||
tax : 251.42
|
||||
total: 4443.52
|
||||
comments: >
|
||||
Late afternoon is best.
|
||||
Backup contact is Nancy
|
||||
Billsmer @ 338-4338.
|
||||
php: |
|
||||
array(
|
||||
'invoice' => 34843, 'date' => mktime(0, 0, 0, 1, 23, 2001),
|
||||
'bill-to' =>
|
||||
array( 'given' => 'Chris', 'family' => 'Dumars', 'address' => array( 'lines' => "458 Walkman Dr.\nSuite #292\n", 'city' => 'Royal Oak', 'state' => 'MI', 'postal' => 48046 ) )
|
||||
, 'ship-to' =>
|
||||
array( 'given' => 'Chris', 'family' => 'Dumars', 'address' => array( 'lines' => "458 Walkman Dr.\nSuite #292\n", 'city' => 'Royal Oak', 'state' => 'MI', 'postal' => 48046 ) )
|
||||
, 'product' =>
|
||||
array(
|
||||
array( 'sku' => 'BL394D', 'quantity' => 4, 'description' => 'Basketball', 'price' => 450.00 ),
|
||||
array( 'sku' => 'BL4438H', 'quantity' => 1, 'description' => 'Super Hoop', 'price' => 2392.00 )
|
||||
),
|
||||
'tax' => 251.42, 'total' => 4443.52,
|
||||
'comments' => "Late afternoon is best. Backup contact is Nancy Billsmer @ 338-4338.\n"
|
||||
)
|
||||
---
|
||||
test: Log file
|
||||
todo: true
|
||||
spec: 2.28
|
||||
yaml: |
|
||||
---
|
||||
Time: 2001-11-23 15:01:42 -05:00
|
||||
User: ed
|
||||
Warning: >
|
||||
This is an error message
|
||||
for the log file
|
||||
---
|
||||
Time: 2001-11-23 15:02:31 -05:00
|
||||
User: ed
|
||||
Warning: >
|
||||
A slightly different error
|
||||
message.
|
||||
---
|
||||
Date: 2001-11-23 15:03:17 -05:00
|
||||
User: ed
|
||||
Fatal: >
|
||||
Unknown variable "bar"
|
||||
Stack:
|
||||
- file: TopClass.py
|
||||
line: 23
|
||||
code: |
|
||||
x = MoreObject("345\n")
|
||||
- file: MoreClass.py
|
||||
line: 58
|
||||
code: |-
|
||||
foo = bar
|
||||
ruby: |
|
||||
y = YAML::Stream.new
|
||||
y.add( { 'Time' => YAML::mktime( 2001, 11, 23, 15, 01, 42, 00, "-05:00" ),
|
||||
'User' => 'ed', 'Warning' => "This is an error message for the log file\n" } )
|
||||
y.add( { 'Time' => YAML::mktime( 2001, 11, 23, 15, 02, 31, 00, "-05:00" ),
|
||||
'User' => 'ed', 'Warning' => "A slightly different error message.\n" } )
|
||||
y.add( { 'Date' => YAML::mktime( 2001, 11, 23, 15, 03, 17, 00, "-05:00" ),
|
||||
'User' => 'ed', 'Fatal' => "Unknown variable \"bar\"\n",
|
||||
'Stack' => [
|
||||
{ 'file' => 'TopClass.py', 'line' => 23, 'code' => "x = MoreObject(\"345\\n\")\n" },
|
||||
{ 'file' => 'MoreClass.py', 'line' => 58, 'code' => "foo = bar" } ] } )
|
||||
documents: 3
|
||||
|
||||
---
|
||||
test: Throwaway comments
|
||||
yaml: |
|
||||
### These are four throwaway comment ###
|
||||
|
||||
### lines (the second line is empty). ###
|
||||
this: | # Comments may trail lines.
|
||||
contains three lines of text.
|
||||
The third one starts with a
|
||||
# character. This isn't a comment.
|
||||
|
||||
# These are three throwaway comment
|
||||
# lines (the first line is empty).
|
||||
php: |
|
||||
array(
|
||||
'this' => "contains three lines of text.\nThe third one starts with a\n# character. This isn't a comment.\n"
|
||||
)
|
||||
---
|
||||
test: Document with a single value
|
||||
todo: true
|
||||
yaml: |
|
||||
--- >
|
||||
This YAML stream contains a single text value.
|
||||
The next stream is a log file - a sequence of
|
||||
log entries. Adding an entry to the log is a
|
||||
simple matter of appending it at the end.
|
||||
ruby: |
|
||||
"This YAML stream contains a single text value. The next stream is a log file - a sequence of log entries. Adding an entry to the log is a simple matter of appending it at the end.\n"
|
||||
---
|
||||
test: Document stream
|
||||
todo: true
|
||||
yaml: |
|
||||
---
|
||||
at: 2001-08-12 09:25:00.00 Z
|
||||
type: GET
|
||||
HTTP: '1.0'
|
||||
url: '/index.html'
|
||||
---
|
||||
at: 2001-08-12 09:25:10.00 Z
|
||||
type: GET
|
||||
HTTP: '1.0'
|
||||
url: '/toc.html'
|
||||
ruby: |
|
||||
y = YAML::Stream.new
|
||||
y.add( {
|
||||
'at' => Time::utc( 2001, 8, 12, 9, 25, 00 ),
|
||||
'type' => 'GET',
|
||||
'HTTP' => '1.0',
|
||||
'url' => '/index.html'
|
||||
} )
|
||||
y.add( {
|
||||
'at' => Time::utc( 2001, 8, 12, 9, 25, 10 ),
|
||||
'type' => 'GET',
|
||||
'HTTP' => '1.0',
|
||||
'url' => '/toc.html'
|
||||
} )
|
||||
documents: 2
|
||||
|
||||
---
|
||||
test: Top level mapping
|
||||
yaml: |
|
||||
# This stream is an example of a top-level mapping.
|
||||
invoice : 34843
|
||||
date : 2001-01-23
|
||||
total : 4443.52
|
||||
php: |
|
||||
array(
|
||||
'invoice' => 34843,
|
||||
'date' => mktime(0, 0, 0, 1, 23, 2001),
|
||||
'total' => 4443.52
|
||||
)
|
||||
---
|
||||
test: Single-line documents
|
||||
todo: true
|
||||
yaml: |
|
||||
# The following is a sequence of three documents.
|
||||
# The first contains an empty mapping, the second
|
||||
# an empty sequence, and the last an empty string.
|
||||
--- {}
|
||||
--- [ ]
|
||||
--- ''
|
||||
ruby: |
|
||||
y = YAML::Stream.new
|
||||
y.add( {} )
|
||||
y.add( [] )
|
||||
y.add( '' )
|
||||
documents: 3
|
||||
|
||||
---
|
||||
test: Document with pause
|
||||
todo: true
|
||||
yaml: |
|
||||
# A communication channel based on a YAML stream.
|
||||
---
|
||||
sent at: 2002-06-06 11:46:25.10 Z
|
||||
payload: Whatever
|
||||
# Receiver can process this as soon as the following is sent:
|
||||
...
|
||||
# Even if the next message is sent long after:
|
||||
---
|
||||
sent at: 2002-06-06 12:05:53.47 Z
|
||||
payload: Whatever
|
||||
...
|
||||
ruby: |
|
||||
y = YAML::Stream.new
|
||||
y.add(
|
||||
{ 'sent at' => YAML::mktime( 2002, 6, 6, 11, 46, 25, 0.10 ),
|
||||
'payload' => 'Whatever' }
|
||||
)
|
||||
y.add(
|
||||
{ "payload" => "Whatever", "sent at" => YAML::mktime( 2002, 6, 6, 12, 5, 53, 0.47 ) }
|
||||
)
|
||||
documents: 2
|
||||
|
||||
---
|
||||
test: Explicit typing
|
||||
yaml: |
|
||||
integer: 12
|
||||
also int: ! "12"
|
||||
string: !str 12
|
||||
php: |
|
||||
array( 'integer' => 12, 'also int' => 12, 'string' => '12' )
|
||||
---
|
||||
test: Private types
|
||||
todo: true
|
||||
yaml: |
|
||||
# Both examples below make use of the 'x-private:ball'
|
||||
# type family URI, but with different semantics.
|
||||
---
|
||||
pool: !!ball
|
||||
number: 8
|
||||
color: black
|
||||
---
|
||||
bearing: !!ball
|
||||
material: steel
|
||||
ruby: |
|
||||
y = YAML::Stream.new
|
||||
y.add( { 'pool' =>
|
||||
YAML::PrivateType.new( 'ball',
|
||||
{ 'number' => 8, 'color' => 'black' } ) }
|
||||
)
|
||||
y.add( { 'bearing' =>
|
||||
YAML::PrivateType.new( 'ball',
|
||||
{ 'material' => 'steel' } ) }
|
||||
)
|
||||
documents: 2
|
||||
|
||||
---
|
||||
test: Type family under yaml.org
|
||||
yaml: |
|
||||
# The URI is 'tag:yaml.org,2002:str'
|
||||
- !str a Unicode string
|
||||
php: |
|
||||
array( 'a Unicode string' )
|
||||
---
|
||||
test: Type family under perl.yaml.org
|
||||
todo: true
|
||||
yaml: |
|
||||
# The URI is 'tag:perl.yaml.org,2002:Text::Tabs'
|
||||
- !perl/Text::Tabs {}
|
||||
ruby: |
|
||||
[ YAML::DomainType.new( 'perl.yaml.org,2002', 'Text::Tabs', {} ) ]
|
||||
---
|
||||
test: Type family under clarkevans.com
|
||||
todo: true
|
||||
yaml: |
|
||||
# The URI is 'tag:clarkevans.com,2003-02:timesheet'
|
||||
- !clarkevans.com,2003-02/timesheet {}
|
||||
ruby: |
|
||||
[ YAML::DomainType.new( 'clarkevans.com,2003-02', 'timesheet', {} ) ]
|
||||
---
|
||||
test: URI Escaping
|
||||
todo: true
|
||||
yaml: |
|
||||
same:
|
||||
- !domain.tld,2002/type\x30 value
|
||||
- !domain.tld,2002/type0 value
|
||||
different: # As far as the YAML parser is concerned
|
||||
- !domain.tld,2002/type%30 value
|
||||
- !domain.tld,2002/type0 value
|
||||
ruby-setup: |
|
||||
YAML.add_domain_type( "domain.tld,2002", "type0" ) { |type, val|
|
||||
"ONE: #{val}"
|
||||
}
|
||||
YAML.add_domain_type( "domain.tld,2002", "type%30" ) { |type, val|
|
||||
"TWO: #{val}"
|
||||
}
|
||||
ruby: |
|
||||
{ 'same' => [ 'ONE: value', 'ONE: value' ], 'different' => [ 'TWO: value', 'ONE: value' ] }
|
||||
---
|
||||
test: URI Prefixing
|
||||
todo: true
|
||||
yaml: |
|
||||
# 'tag:domain.tld,2002:invoice' is some type family.
|
||||
invoice: !domain.tld,2002/^invoice
|
||||
# 'seq' is shorthand for 'tag:yaml.org,2002:seq'.
|
||||
# This does not effect '^customer' below
|
||||
# because it is does not specify a prefix.
|
||||
customers: !seq
|
||||
# '^customer' is shorthand for the full
|
||||
# notation 'tag:domain.tld,2002:customer'.
|
||||
- !^customer
|
||||
given : Chris
|
||||
family : Dumars
|
||||
ruby-setup: |
|
||||
YAML.add_domain_type( "domain.tld,2002", /(invoice|customer)/ ) { |type, val|
|
||||
if val.is_a? ::Hash
|
||||
scheme, domain, type = type.split( /:/, 3 )
|
||||
val['type'] = "domain #{type}"
|
||||
val
|
||||
else
|
||||
raise YAML::Error, "Not a Hash in domain.tld/invoice: " + val.inspect
|
||||
end
|
||||
}
|
||||
ruby: |
|
||||
{ "invoice"=> { "customers"=> [ { "given"=>"Chris", "type"=>"domain customer", "family"=>"Dumars" } ], "type"=>"domain invoice" } }
|
||||
|
||||
---
|
||||
test: Overriding anchors
|
||||
yaml: |
|
||||
anchor : &A001 This scalar has an anchor.
|
||||
override : &A001 >
|
||||
The alias node below is a
|
||||
repeated use of this value.
|
||||
alias : *A001
|
||||
php: |
|
||||
array( 'anchor' => 'This scalar has an anchor.',
|
||||
'override' => "The alias node below is a repeated use of this value.\n",
|
||||
'alias' => "The alias node below is a repeated use of this value.\n" )
|
||||
---
|
||||
test: Flow and block formatting
|
||||
todo: true
|
||||
yaml: |
|
||||
empty: []
|
||||
flow: [ one, two, three # May span lines,
|
||||
, four, # indentation is
|
||||
five ] # mostly ignored.
|
||||
block:
|
||||
- First item in top sequence
|
||||
-
|
||||
- Subordinate sequence entry
|
||||
- >
|
||||
A folded sequence entry
|
||||
- Sixth item in top sequence
|
||||
ruby: |
|
||||
{ 'empty' => [], 'flow' => [ 'one', 'two', 'three', 'four', 'five' ],
|
||||
'block' => [ 'First item in top sequence', [ 'Subordinate sequence entry' ],
|
||||
"A folded sequence entry\n", 'Sixth item in top sequence' ] }
|
||||
---
|
||||
test: Complete mapping test
|
||||
todo: true
|
||||
yaml: |
|
||||
empty: {}
|
||||
flow: { one: 1, two: 2 }
|
||||
spanning: { one: 1,
|
||||
two: 2 }
|
||||
block:
|
||||
first : First entry
|
||||
second:
|
||||
key: Subordinate mapping
|
||||
third:
|
||||
- Subordinate sequence
|
||||
- { }
|
||||
- Previous mapping is empty.
|
||||
- A key: value pair in a sequence.
|
||||
A second: key:value pair.
|
||||
- The previous entry is equal to the following one.
|
||||
-
|
||||
A key: value pair in a sequence.
|
||||
A second: key:value pair.
|
||||
!float 12 : This key is a float.
|
||||
? >
|
||||
?
|
||||
: This key had to be protected.
|
||||
"\a" : This key had to be escaped.
|
||||
? >
|
||||
This is a
|
||||
multi-line
|
||||
folded key
|
||||
: Whose value is
|
||||
also multi-line.
|
||||
? this also works as a key
|
||||
: with a value at the next line.
|
||||
?
|
||||
- This key
|
||||
- is a sequence
|
||||
:
|
||||
- With a sequence value.
|
||||
?
|
||||
This: key
|
||||
is a: mapping
|
||||
:
|
||||
with a: mapping value.
|
||||
ruby: |
|
||||
{ 'empty' => {}, 'flow' => { 'one' => 1, 'two' => 2 },
|
||||
'spanning' => { 'one' => 1, 'two' => 2 },
|
||||
'block' => { 'first' => 'First entry', 'second' =>
|
||||
{ 'key' => 'Subordinate mapping' }, 'third' =>
|
||||
[ 'Subordinate sequence', {}, 'Previous mapping is empty.',
|
||||
{ 'A key' => 'value pair in a sequence.', 'A second' => 'key:value pair.' },
|
||||
'The previous entry is equal to the following one.',
|
||||
{ 'A key' => 'value pair in a sequence.', 'A second' => 'key:value pair.' } ],
|
||||
12.0 => 'This key is a float.', "?\n" => 'This key had to be protected.',
|
||||
"\a" => 'This key had to be escaped.',
|
||||
"This is a multi-line folded key\n" => "Whose value is also multi-line.",
|
||||
'this also works as a key' => 'with a value at the next line.',
|
||||
[ 'This key', 'is a sequence' ] => [ 'With a sequence value.' ] } }
|
||||
# Couldn't recreate map exactly, so we'll do a detailed check to be sure it's entact
|
||||
obj_y['block'].keys.each { |k|
|
||||
if Hash === k
|
||||
v = obj_y['block'][k]
|
||||
if k['This'] == 'key' and k['is a'] == 'mapping' and v['with a'] == 'mapping value.'
|
||||
obj_r['block'][k] = v
|
||||
end
|
||||
end
|
||||
}
|
||||
---
|
||||
test: Literal explicit indentation
|
||||
yaml: |
|
||||
# Explicit indentation must
|
||||
# be given in all the three
|
||||
# following cases.
|
||||
leading spaces: |2
|
||||
This value starts with four spaces.
|
||||
|
||||
leading line break: |2
|
||||
|
||||
This value starts with a line break.
|
||||
|
||||
leading comment indicator: |2
|
||||
# first line starts with a
|
||||
# character.
|
||||
|
||||
# Explicit indentation may
|
||||
# also be given when it is
|
||||
# not required.
|
||||
redundant: |2
|
||||
This value is indented 2 spaces.
|
||||
php: |
|
||||
array(
|
||||
'leading spaces' => " This value starts with four spaces.\n",
|
||||
'leading line break' => "\nThis value starts with a line break.\n",
|
||||
'leading comment indicator' => "# first line starts with a\n# character.\n",
|
||||
'redundant' => "This value is indented 2 spaces.\n"
|
||||
)
|
||||
---
|
||||
test: Chomping and keep modifiers
|
||||
yaml: |
|
||||
clipped: |
|
||||
This has one newline.
|
||||
|
||||
same as "clipped" above: "This has one newline.\n"
|
||||
|
||||
stripped: |-
|
||||
This has no newline.
|
||||
|
||||
same as "stripped" above: "This has no newline."
|
||||
|
||||
kept: |+
|
||||
This has two newlines.
|
||||
|
||||
same as "kept" above: "This has two newlines.\n\n"
|
||||
php: |
|
||||
array(
|
||||
'clipped' => "This has one newline.\n",
|
||||
'same as "clipped" above' => "This has one newline.\n",
|
||||
'stripped' => 'This has no newline.',
|
||||
'same as "stripped" above' => 'This has no newline.',
|
||||
'kept' => "This has two newlines.\n\n",
|
||||
'same as "kept" above' => "This has two newlines.\n\n"
|
||||
)
|
||||
---
|
||||
test: Literal combinations
|
||||
todo: true
|
||||
yaml: |
|
||||
empty: |
|
||||
|
||||
literal: |
|
||||
The \ ' " characters may be
|
||||
freely used. Leading white
|
||||
space is significant.
|
||||
|
||||
Line breaks are significant.
|
||||
Thus this value contains one
|
||||
empty line and ends with a
|
||||
single line break, but does
|
||||
not start with one.
|
||||
|
||||
is equal to: "The \\ ' \" characters may \
|
||||
be\nfreely used. Leading white\n space \
|
||||
is significant.\n\nLine breaks are \
|
||||
significant.\nThus this value contains \
|
||||
one\nempty line and ends with a\nsingle \
|
||||
line break, but does\nnot start with one.\n"
|
||||
|
||||
# Comments may follow a block
|
||||
# scalar value. They must be
|
||||
# less indented.
|
||||
|
||||
# Modifiers may be combined in any order.
|
||||
indented and chomped: |2-
|
||||
This has no newline.
|
||||
|
||||
also written as: |-2
|
||||
This has no newline.
|
||||
|
||||
both are equal to: " This has no newline."
|
||||
php: |
|
||||
array(
|
||||
'empty' => '',
|
||||
'literal' => "The \\ ' \" characters may be\nfreely used. Leading white\n space " +
|
||||
"is significant.\n\nLine breaks are significant.\nThus this value contains one\n" +
|
||||
"empty line and ends with a\nsingle line break, but does\nnot start with one.\n",
|
||||
'is equal to' => "The \\ ' \" characters may be\nfreely used. Leading white\n space " +
|
||||
"is significant.\n\nLine breaks are significant.\nThus this value contains one\n" +
|
||||
"empty line and ends with a\nsingle line break, but does\nnot start with one.\n",
|
||||
'indented and chomped' => ' This has no newline.',
|
||||
'also written as' => ' This has no newline.',
|
||||
'both are equal to' => ' This has no newline.'
|
||||
)
|
||||
---
|
||||
test: Folded combinations
|
||||
todo: true
|
||||
yaml: |
|
||||
empty: >
|
||||
|
||||
one paragraph: >
|
||||
Line feeds are converted
|
||||
to spaces, so this value
|
||||
contains no line breaks
|
||||
except for the final one.
|
||||
|
||||
multiple paragraphs: >2
|
||||
|
||||
An empty line, either
|
||||
at the start or in
|
||||
the value:
|
||||
|
||||
Is interpreted as a
|
||||
line break. Thus this
|
||||
value contains three
|
||||
line breaks.
|
||||
|
||||
indented text: >
|
||||
This is a folded
|
||||
paragraph followed
|
||||
by a list:
|
||||
* first entry
|
||||
* second entry
|
||||
Followed by another
|
||||
folded paragraph,
|
||||
another list:
|
||||
|
||||
* first entry
|
||||
|
||||
* second entry
|
||||
|
||||
And a final folded
|
||||
paragraph.
|
||||
|
||||
above is equal to: |
|
||||
This is a folded paragraph followed by a list:
|
||||
* first entry
|
||||
* second entry
|
||||
Followed by another folded paragraph, another list:
|
||||
|
||||
* first entry
|
||||
|
||||
* second entry
|
||||
|
||||
And a final folded paragraph.
|
||||
|
||||
# Explicit comments may follow
|
||||
# but must be less indented.
|
||||
php: |
|
||||
array(
|
||||
'empty' => '',
|
||||
'one paragraph' => 'Line feeds are converted to spaces, so this value'.
|
||||
" contains no line breaks except for the final one.\n",
|
||||
'multiple paragraphs' => "\nAn empty line, either at the start or in the value:\n".
|
||||
"Is interpreted as a line break. Thus this value contains three line breaks.\n",
|
||||
'indented text' => "This is a folded paragraph followed by a list:\n".
|
||||
" * first entry\n * second entry\nFollowed by another folded paragraph, ".
|
||||
"another list:\n\n * first entry\n\n * second entry\n\nAnd a final folded paragraph.\n",
|
||||
'above is equal to' => "This is a folded paragraph followed by a list:\n".
|
||||
" * first entry\n * second entry\nFollowed by another folded paragraph, ".
|
||||
"another list:\n\n * first entry\n\n * second entry\n\nAnd a final folded paragraph.\n"
|
||||
)
|
||||
---
|
||||
test: Single quotes
|
||||
todo: true
|
||||
yaml: |
|
||||
empty: ''
|
||||
second: '! : \ etc. can be used freely.'
|
||||
third: 'a single quote '' must be escaped.'
|
||||
span: 'this contains
|
||||
six spaces
|
||||
|
||||
and one
|
||||
line break'
|
||||
is same as: "this contains six spaces\nand one line break"
|
||||
php: |
|
||||
array(
|
||||
'empty' => '',
|
||||
'second' => '! : \\ etc. can be used freely.',
|
||||
'third' => "a single quote ' must be escaped.",
|
||||
'span' => "this contains six spaces\nand one line break",
|
||||
'is same as' => "this contains six spaces\nand one line break"
|
||||
)
|
||||
---
|
||||
test: Double quotes
|
||||
todo: true
|
||||
yaml: |
|
||||
empty: ""
|
||||
second: "! : etc. can be used freely."
|
||||
third: "a \" or a \\ must be escaped."
|
||||
fourth: "this value ends with an LF.\n"
|
||||
span: "this contains
|
||||
four \
|
||||
spaces"
|
||||
is equal to: "this contains four spaces"
|
||||
php: |
|
||||
array(
|
||||
'empty' => '',
|
||||
'second' => '! : etc. can be used freely.',
|
||||
'third' => 'a " or a \\ must be escaped.',
|
||||
'fourth' => "this value ends with an LF.\n",
|
||||
'span' => "this contains four spaces",
|
||||
'is equal to' => "this contains four spaces"
|
||||
)
|
||||
---
|
||||
test: Unquoted strings
|
||||
todo: true
|
||||
yaml: |
|
||||
first: There is no unquoted empty string.
|
||||
|
||||
second: 12 ## This is an integer.
|
||||
|
||||
third: !str 12 ## This is a string.
|
||||
|
||||
span: this contains
|
||||
six spaces
|
||||
|
||||
and one
|
||||
line break
|
||||
|
||||
indicators: this has no comments.
|
||||
#:foo and bar# are
|
||||
both text.
|
||||
|
||||
flow: [ can span
|
||||
lines, # comment
|
||||
like
|
||||
this ]
|
||||
|
||||
note: { one-line keys: but multi-line values }
|
||||
|
||||
php: |
|
||||
array(
|
||||
'first' => 'There is no unquoted empty string.',
|
||||
'second' => 12,
|
||||
'third' => '12',
|
||||
'span' => "this contains six spaces\nand one line break",
|
||||
'indicators' => "this has no comments. #:foo and bar# are both text.",
|
||||
'flow' => [ 'can span lines', 'like this' ],
|
||||
'note' => { 'one-line keys' => 'but multi-line values' }
|
||||
)
|
||||
---
|
||||
test: Spanning sequences
|
||||
todo: true
|
||||
yaml: |
|
||||
# The following are equal seqs
|
||||
# with different identities.
|
||||
flow: [ one, two ]
|
||||
spanning: [ one,
|
||||
two ]
|
||||
block:
|
||||
- one
|
||||
- two
|
||||
php: |
|
||||
array(
|
||||
'flow' => [ 'one', 'two' ],
|
||||
'spanning' => [ 'one', 'two' ],
|
||||
'block' => [ 'one', 'two' ]
|
||||
)
|
||||
---
|
||||
test: Flow mappings
|
||||
yaml: |
|
||||
# The following are equal maps
|
||||
# with different identities.
|
||||
flow: { one: 1, two: 2 }
|
||||
block:
|
||||
one: 1
|
||||
two: 2
|
||||
php: |
|
||||
array(
|
||||
'flow' => array( 'one' => 1, 'two' => 2 ),
|
||||
'block' => array( 'one' => 1, 'two' => 2 )
|
||||
)
|
||||
---
|
||||
test: Representations of 12
|
||||
todo: true
|
||||
yaml: |
|
||||
- 12 # An integer
|
||||
# The following scalars
|
||||
# are loaded to the
|
||||
# string value '1' '2'.
|
||||
- !str 12
|
||||
- '12'
|
||||
- "12"
|
||||
- "\
|
||||
1\
|
||||
2\
|
||||
"
|
||||
# Strings containing paths and regexps can be unquoted:
|
||||
- /foo/bar
|
||||
- d:/foo/bar
|
||||
- foo/bar
|
||||
- /a.*b/
|
||||
php: |
|
||||
array( 12, '12', '12', '12', '12', '/foo/bar', 'd:/foo/bar', 'foo/bar', '/a.*b/' )
|
||||
---
|
||||
test: "Null"
|
||||
todo: true
|
||||
yaml: |
|
||||
canonical: ~
|
||||
|
||||
english: null
|
||||
|
||||
# This sequence has five
|
||||
# entries, two with values.
|
||||
sparse:
|
||||
- ~
|
||||
- 2nd entry
|
||||
- Null
|
||||
- 4th entry
|
||||
-
|
||||
|
||||
four: This mapping has five keys,
|
||||
only two with values.
|
||||
|
||||
php: |
|
||||
array (
|
||||
'canonical' => null,
|
||||
'english' => null,
|
||||
'sparse' => array( null, '2nd entry', null, '4th entry', null ]),
|
||||
'four' => 'This mapping has five keys, only two with values.'
|
||||
)
|
||||
---
|
||||
test: Omap
|
||||
todo: true
|
||||
yaml: |
|
||||
# Explicitly typed dictionary.
|
||||
Bestiary: !omap
|
||||
- aardvark: African pig-like ant eater. Ugly.
|
||||
- anteater: South-American ant eater. Two species.
|
||||
- anaconda: South-American constrictor snake. Scary.
|
||||
# Etc.
|
||||
ruby: |
|
||||
{
|
||||
'Bestiary' => YAML::Omap[
|
||||
'aardvark', 'African pig-like ant eater. Ugly.',
|
||||
'anteater', 'South-American ant eater. Two species.',
|
||||
'anaconda', 'South-American constrictor snake. Scary.'
|
||||
]
|
||||
}
|
||||
|
||||
---
|
||||
test: Pairs
|
||||
todo: true
|
||||
yaml: |
|
||||
# Explicitly typed pairs.
|
||||
tasks: !pairs
|
||||
- meeting: with team.
|
||||
- meeting: with boss.
|
||||
- break: lunch.
|
||||
- meeting: with client.
|
||||
ruby: |
|
||||
{
|
||||
'tasks' => YAML::Pairs[
|
||||
'meeting', 'with team.',
|
||||
'meeting', 'with boss.',
|
||||
'break', 'lunch.',
|
||||
'meeting', 'with client.'
|
||||
]
|
||||
}
|
||||
|
||||
---
|
||||
test: Set
|
||||
todo: true
|
||||
yaml: |
|
||||
# Explicitly typed set.
|
||||
baseball players: !set
|
||||
Mark McGwire:
|
||||
Sammy Sosa:
|
||||
Ken Griffey:
|
||||
ruby: |
|
||||
{
|
||||
'baseball players' => YAML::Set[
|
||||
'Mark McGwire', nil,
|
||||
'Sammy Sosa', nil,
|
||||
'Ken Griffey', nil
|
||||
]
|
||||
}
|
||||
|
||||
---
|
||||
test: Boolean
|
||||
yaml: |
|
||||
false: used as key
|
||||
logical: true
|
||||
answer: no
|
||||
php: |
|
||||
array(
|
||||
false => 'used as key',
|
||||
'logical' => true,
|
||||
'answer' => false
|
||||
)
|
||||
---
|
||||
test: Integer
|
||||
yaml: |
|
||||
canonical: 12345
|
||||
decimal: +12,345
|
||||
octal: 014
|
||||
hexadecimal: 0xC
|
||||
php: |
|
||||
array(
|
||||
'canonical' => 12345,
|
||||
'decimal' => 12345,
|
||||
'octal' => 12,
|
||||
'hexadecimal' => 12
|
||||
)
|
||||
---
|
||||
test: Float
|
||||
yaml: |
|
||||
canonical: 1.23015e+3
|
||||
exponential: 12.3015e+02
|
||||
fixed: 1,230.15
|
||||
negative infinity: -.inf
|
||||
not a number: .NaN
|
||||
php: |
|
||||
array(
|
||||
'canonical' => 1230.15,
|
||||
'exponential' => 1230.15,
|
||||
'fixed' => 1230.15,
|
||||
'negative infinity' => log(0),
|
||||
'not a number' => -log(0)
|
||||
)
|
||||
---
|
||||
test: Timestamp
|
||||
todo: true
|
||||
yaml: |
|
||||
canonical: 2001-12-15T02:59:43.1Z
|
||||
valid iso8601: 2001-12-14t21:59:43.10-05:00
|
||||
space separated: 2001-12-14 21:59:43.10 -05:00
|
||||
date (noon UTC): 2002-12-14
|
||||
ruby: |
|
||||
array(
|
||||
'canonical' => YAML::mktime( 2001, 12, 15, 2, 59, 43, 0.10 ),
|
||||
'valid iso8601' => YAML::mktime( 2001, 12, 14, 21, 59, 43, 0.10, "-05:00" ),
|
||||
'space separated' => YAML::mktime( 2001, 12, 14, 21, 59, 43, 0.10, "-05:00" ),
|
||||
'date (noon UTC)' => Date.new( 2002, 12, 14 )
|
||||
)
|
||||
---
|
||||
test: Binary
|
||||
todo: true
|
||||
yaml: |
|
||||
canonical: !binary "\
|
||||
R0lGODlhDAAMAIQAAP//9/X17unp5WZmZgAAAOfn515eXvPz7Y6OjuDg4J+fn5\
|
||||
OTk6enp56enmlpaWNjY6Ojo4SEhP/++f/++f/++f/++f/++f/++f/++f/++f/+\
|
||||
+f/++f/++f/++f/++f/++SH+Dk1hZGUgd2l0aCBHSU1QACwAAAAADAAMAAAFLC\
|
||||
AgjoEwnuNAFOhpEMTRiggcz4BNJHrv/zCFcLiwMWYNG84BwwEeECcgggoBADs="
|
||||
base64: !binary |
|
||||
R0lGODlhDAAMAIQAAP//9/X17unp5WZmZgAAAOfn515eXvPz7Y6OjuDg4J+fn5
|
||||
OTk6enp56enmlpaWNjY6Ojo4SEhP/++f/++f/++f/++f/++f/++f/++f/++f/+
|
||||
+f/++f/++f/++f/++f/++SH+Dk1hZGUgd2l0aCBHSU1QACwAAAAADAAMAAAFLC
|
||||
AgjoEwnuNAFOhpEMTRiggcz4BNJHrv/zCFcLiwMWYNG84BwwEeECcgggoBADs=
|
||||
description: >
|
||||
The binary value above is a tiny arrow
|
||||
encoded as a gif image.
|
||||
ruby-setup: |
|
||||
arrow_gif = "GIF89a\f\000\f\000\204\000\000\377\377\367\365\365\356\351\351\345fff\000\000\000\347\347\347^^^\363\363\355\216\216\216\340\340\340\237\237\237\223\223\223\247\247\247\236\236\236iiiccc\243\243\243\204\204\204\377\376\371\377\376\371\377\376\371\377\376\371\377\376\371\377\376\371\377\376\371\377\376\371\377\376\371\377\376\371\377\376\371\377\376\371\377\376\371\377\376\371!\376\016Made with GIMP\000,\000\000\000\000\f\000\f\000\000\005, \216\2010\236\343@\024\350i\020\304\321\212\010\034\317\200M$z\357\3770\205p\270\2601f\r\e\316\001\303\001\036\020' \202\n\001\000;"
|
||||
ruby: |
|
||||
{
|
||||
'canonical' => arrow_gif,
|
||||
'base64' => arrow_gif,
|
||||
'description' => "The binary value above is a tiny arrow encoded as a gif image.\n"
|
||||
}
|
||||
|
||||
---
|
||||
test: Merge key
|
||||
todo: true
|
||||
yaml: |
|
||||
---
|
||||
- &CENTER { x: 1, y: 2 }
|
||||
- &LEFT { x: 0, y: 2 }
|
||||
- &BIG { r: 10 }
|
||||
- &SMALL { r: 1 }
|
||||
|
||||
# All the following maps are equal:
|
||||
|
||||
- # Explicit keys
|
||||
x: 1
|
||||
y: 2
|
||||
r: 10
|
||||
label: center/big
|
||||
|
||||
- # Merge one map
|
||||
<< : *CENTER
|
||||
r: 10
|
||||
label: center/big
|
||||
|
||||
- # Merge multiple maps
|
||||
<< : [ *CENTER, *BIG ]
|
||||
label: center/big
|
||||
|
||||
- # Override
|
||||
<< : [ *BIG, *LEFT, *SMALL ]
|
||||
x: 1
|
||||
label: center/big
|
||||
|
||||
ruby-setup: |
|
||||
center = { 'x' => 1, 'y' => 2 }
|
||||
left = { 'x' => 0, 'y' => 2 }
|
||||
big = { 'r' => 10 }
|
||||
small = { 'r' => 1 }
|
||||
node1 = { 'x' => 1, 'y' => 2, 'r' => 10, 'label' => 'center/big' }
|
||||
node2 = center.dup
|
||||
node2.update( { 'r' => 10, 'label' => 'center/big' } )
|
||||
node3 = big.dup
|
||||
node3.update( center )
|
||||
node3.update( { 'label' => 'center/big' } )
|
||||
node4 = small.dup
|
||||
node4.update( left )
|
||||
node4.update( big )
|
||||
node4.update( { 'x' => 1, 'label' => 'center/big' } )
|
||||
|
||||
ruby: |
|
||||
[
|
||||
center, left, big, small, node1, node2, node3, node4
|
||||
]
|
||||
|
||||
---
|
||||
test: Default key
|
||||
todo: true
|
||||
yaml: |
|
||||
--- # Old schema
|
||||
link with:
|
||||
- library1.dll
|
||||
- library2.dll
|
||||
--- # New schema
|
||||
link with:
|
||||
- = : library1.dll
|
||||
version: 1.2
|
||||
- = : library2.dll
|
||||
version: 2.3
|
||||
ruby: |
|
||||
y = YAML::Stream.new
|
||||
y.add( { 'link with' => [ 'library1.dll', 'library2.dll' ] } )
|
||||
obj_h = Hash[ 'version' => 1.2 ]
|
||||
obj_h.default = 'library1.dll'
|
||||
obj_h2 = Hash[ 'version' => 2.3 ]
|
||||
obj_h2.default = 'library2.dll'
|
||||
y.add( { 'link with' => [ obj_h, obj_h2 ] } )
|
||||
documents: 2
|
||||
|
||||
---
|
||||
test: Special keys
|
||||
todo: true
|
||||
yaml: |
|
||||
"!": These three keys
|
||||
"&": had to be quoted
|
||||
"=": and are normal strings.
|
||||
# NOTE: the following node should NOT be serialized this way.
|
||||
encoded node :
|
||||
!special '!' : '!type'
|
||||
!special|canonical '&' : 12
|
||||
= : value
|
||||
# The proper way to serialize the above node is as follows:
|
||||
node : !!type &12 value
|
||||
ruby: |
|
||||
{ '!' => 'These three keys', '&' => 'had to be quoted',
|
||||
'=' => 'and are normal strings.',
|
||||
'encoded node' => YAML::PrivateType.new( 'type', 'value' ),
|
||||
'node' => YAML::PrivateType.new( 'type', 'value' ) }
|
||||
|
|
@ -0,0 +1,244 @@
|
|||
--- %YAML:1.0
|
||||
test: Strings
|
||||
brief: >
|
||||
Any group of characters beginning with an
|
||||
alphabetic or numeric character is a string,
|
||||
unless it belongs to one of the groups below
|
||||
(such as an Integer or Time).
|
||||
yaml: |
|
||||
String
|
||||
php: |
|
||||
'String'
|
||||
---
|
||||
test: String characters
|
||||
brief: >
|
||||
A string can contain any alphabetic or
|
||||
numeric character, along with many
|
||||
punctuation characters, including the
|
||||
period, dash, space, quotes, exclamation, and
|
||||
question mark.
|
||||
yaml: |
|
||||
- What's Yaml?
|
||||
- It's for writing data structures in plain text.
|
||||
- And?
|
||||
- And what? That's not good enough for you?
|
||||
- No, I mean, "And what about Yaml?"
|
||||
- Oh, oh yeah. Uh.. Yaml for Ruby.
|
||||
php: |
|
||||
array(
|
||||
"What's Yaml?",
|
||||
"It's for writing data structures in plain text.",
|
||||
"And?",
|
||||
"And what? That's not good enough for you?",
|
||||
"No, I mean, \"And what about Yaml?\"",
|
||||
"Oh, oh yeah. Uh.. Yaml for Ruby."
|
||||
)
|
||||
---
|
||||
test: Indicators in Strings
|
||||
brief: >
|
||||
Be careful using indicators in strings. In particular,
|
||||
the comma, colon, and pound sign must be used carefully.
|
||||
yaml: |
|
||||
the colon followed by space is an indicator: but is a string:right here
|
||||
same for the pound sign: here we have it#in a string
|
||||
the comma can, honestly, be used in most cases: [ but not in, inline collections ]
|
||||
php: |
|
||||
array(
|
||||
'the colon followed by space is an indicator' => 'but is a string:right here',
|
||||
'same for the pound sign' => 'here we have it#in a string',
|
||||
'the comma can, honestly, be used in most cases' => array('but not in', 'inline collections')
|
||||
)
|
||||
---
|
||||
test: Forcing Strings
|
||||
brief: >
|
||||
Any YAML type can be forced into a string using the
|
||||
explicit !str method.
|
||||
yaml: |
|
||||
date string: !str 2001-08-01
|
||||
number string: !str 192
|
||||
php: |
|
||||
array(
|
||||
'date string' => '2001-08-01',
|
||||
'number string' => '192'
|
||||
)
|
||||
---
|
||||
test: Single-quoted Strings
|
||||
brief: >
|
||||
You can also enclose your strings within single quotes,
|
||||
which allows use of slashes, colons, and other indicators
|
||||
freely. Inside single quotes, you can represent a single
|
||||
quote in your string by using two single quotes next to
|
||||
each other.
|
||||
yaml: |
|
||||
all my favorite symbols: '#:!/%.)'
|
||||
a few i hate: '&(*'
|
||||
why do i hate them?: 'it''s very hard to explain'
|
||||
entities: '£ me'
|
||||
php: |
|
||||
array(
|
||||
'all my favorite symbols' => '#:!/%.)',
|
||||
'a few i hate' => '&(*',
|
||||
'why do i hate them?' => 'it\'s very hard to explain',
|
||||
'entities' => '£ me'
|
||||
)
|
||||
---
|
||||
test: Double-quoted Strings
|
||||
brief: >
|
||||
Enclosing strings in double quotes allows you
|
||||
to use escapings to represent ASCII and
|
||||
Unicode characters.
|
||||
yaml: |
|
||||
i know where i want my line breaks: "one here\nand another here\n"
|
||||
php: |
|
||||
array(
|
||||
'i know where i want my line breaks' => "one here\nand another here\n"
|
||||
)
|
||||
---
|
||||
test: Multi-line Quoted Strings
|
||||
todo: true
|
||||
brief: >
|
||||
Both single- and double-quoted strings may be
|
||||
carried on to new lines in your YAML document.
|
||||
They must be indented a step and indentation
|
||||
is interpreted as a single space.
|
||||
yaml: |
|
||||
i want a long string: "so i'm going to
|
||||
let it go on and on to other lines
|
||||
until i end it with a quote."
|
||||
php: |
|
||||
array('i want a long string' => "so i'm going to ".
|
||||
"let it go on and on to other lines ".
|
||||
"until i end it with a quote."
|
||||
)
|
||||
|
||||
---
|
||||
test: Plain scalars
|
||||
todo: true
|
||||
brief: >
|
||||
Unquoted strings may also span multiple lines, if they
|
||||
are free of YAML space indicators and indented.
|
||||
yaml: |
|
||||
- My little toe is broken in two places;
|
||||
- I'm crazy to have skied this way;
|
||||
- I'm not the craziest he's seen, since there was always the German guy
|
||||
who skied for 3 hours on a broken shin bone (just below the kneecap);
|
||||
- Nevertheless, second place is respectable, and he doesn't
|
||||
recommend going for the record;
|
||||
- He's going to put my foot in plaster for a month;
|
||||
- This would impair my skiing ability somewhat for the
|
||||
duration, as can be imagined.
|
||||
php: |
|
||||
array(
|
||||
"My little toe is broken in two places;",
|
||||
"I'm crazy to have skied this way;",
|
||||
"I'm not the craziest he's seen, since there was always ".
|
||||
"the German guy who skied for 3 hours on a broken shin ".
|
||||
"bone (just below the kneecap);",
|
||||
"Nevertheless, second place is respectable, and he doesn't ".
|
||||
"recommend going for the record;",
|
||||
"He's going to put my foot in plaster for a month;",
|
||||
"This would impair my skiing ability somewhat for the duration, ".
|
||||
"as can be imagined."
|
||||
)
|
||||
---
|
||||
test: 'Null'
|
||||
brief: >
|
||||
You can use the tilde '~' character for a null value.
|
||||
yaml: |
|
||||
name: Mr. Show
|
||||
hosted by: Bob and David
|
||||
date of next season: ~
|
||||
php: |
|
||||
array(
|
||||
'name' => 'Mr. Show',
|
||||
'hosted by' => 'Bob and David',
|
||||
'date of next season' => null
|
||||
)
|
||||
---
|
||||
test: Boolean
|
||||
brief: >
|
||||
You can use 'true' and 'false' for boolean values.
|
||||
yaml: |
|
||||
Is Gus a Liar?: true
|
||||
Do I rely on Gus for Sustenance?: false
|
||||
php: |
|
||||
array(
|
||||
'Is Gus a Liar?' => true,
|
||||
'Do I rely on Gus for Sustenance?' => false
|
||||
)
|
||||
---
|
||||
test: Integers
|
||||
dump_skip: true
|
||||
brief: >
|
||||
An integer is a series of numbers, optionally
|
||||
starting with a positive or negative sign. Integers
|
||||
may also contain commas for readability.
|
||||
yaml: |
|
||||
zero: 0
|
||||
simple: 12
|
||||
one-thousand: 1,000
|
||||
negative one-thousand: -1,000
|
||||
php: |
|
||||
array(
|
||||
'zero' => 0,
|
||||
'simple' => 12,
|
||||
'one-thousand' => 1000,
|
||||
'negative one-thousand' => -1000
|
||||
)
|
||||
---
|
||||
test: Integers as Map Keys
|
||||
brief: >
|
||||
An integer can be used a dictionary key.
|
||||
yaml: |
|
||||
1: one
|
||||
2: two
|
||||
3: three
|
||||
php: |
|
||||
array(
|
||||
1 => 'one',
|
||||
2 => 'two',
|
||||
3 => 'three'
|
||||
)
|
||||
---
|
||||
test: Floats
|
||||
dump_skip: true
|
||||
brief: >
|
||||
Floats are represented by numbers with decimals,
|
||||
allowing for scientific notation, as well as
|
||||
positive and negative infinity and "not a number."
|
||||
yaml: |
|
||||
a simple float: 2.00
|
||||
larger float: 1,000.09
|
||||
scientific notation: 1.00009e+3
|
||||
php: |
|
||||
array(
|
||||
'a simple float' => 2.0,
|
||||
'larger float' => 1000.09,
|
||||
'scientific notation' => 1000.09
|
||||
)
|
||||
---
|
||||
test: Time
|
||||
todo: true
|
||||
brief: >
|
||||
You can represent timestamps by using
|
||||
ISO8601 format, or a variation which
|
||||
allows spaces between the date, time and
|
||||
time zone.
|
||||
yaml: |
|
||||
iso8601: 2001-12-14t21:59:43.10-05:00
|
||||
space seperated: 2001-12-14 21:59:43.10 -05:00
|
||||
php: |
|
||||
array(
|
||||
'iso8601' => mktime( 2001, 12, 14, 21, 59, 43, 0.10, "-05:00" ),
|
||||
'space seperated' => mktime( 2001, 12, 14, 21, 59, 43, 0.10, "-05:00" )
|
||||
)
|
||||
---
|
||||
test: Date
|
||||
todo: true
|
||||
brief: >
|
||||
A date can be represented by its year,
|
||||
month and day in ISO8601 order.
|
||||
yaml: |
|
||||
1976-07-31
|
||||
php: |
|
||||
date( 1976, 7, 31 )
|
||||
|
|
@ -0,0 +1,16 @@
|
|||
- sfComments
|
||||
- sfCompact
|
||||
- sfTests
|
||||
- sfObjects
|
||||
- sfMergeKey
|
||||
- sfQuotes
|
||||
- YtsAnchorAlias
|
||||
- YtsBasicTests
|
||||
- YtsBlockMapping
|
||||
- YtsDocumentSeparator
|
||||
- YtsErrorTests
|
||||
- YtsFlowCollections
|
||||
- YtsFoldedScalars
|
||||
- YtsNullsAndEmpties
|
||||
- YtsSpecificationExamples
|
||||
- YtsTypeTransfers
|
||||
|
|
@ -0,0 +1,51 @@
|
|||
--- %YAML:1.0
|
||||
test: Comments at the end of a line
|
||||
brief: >
|
||||
Comments at the end of a line
|
||||
yaml: |
|
||||
ex1: "foo # bar"
|
||||
ex2: "foo # bar" # comment
|
||||
ex3: 'foo # bar' # comment
|
||||
ex4: foo # comment
|
||||
php: |
|
||||
array('ex1' => 'foo # bar', 'ex2' => 'foo # bar', 'ex3' => 'foo # bar', 'ex4' => 'foo')
|
||||
---
|
||||
test: Comments in the middle
|
||||
brief: >
|
||||
Comments in the middle
|
||||
yaml: |
|
||||
foo:
|
||||
# some comment
|
||||
# some comment
|
||||
bar: foo
|
||||
# some comment
|
||||
# some comment
|
||||
php: |
|
||||
array('foo' => array('bar' => 'foo'))
|
||||
---
|
||||
test: Comments on a hash line
|
||||
brief: >
|
||||
Comments on a hash line
|
||||
yaml: |
|
||||
foo: # a comment
|
||||
foo: bar # a comment
|
||||
php: |
|
||||
array('foo' => array('foo' => 'bar'))
|
||||
---
|
||||
test: 'Value starting with a #'
|
||||
brief: >
|
||||
'Value starting with a #'
|
||||
yaml: |
|
||||
foo: '#bar'
|
||||
php: |
|
||||
array('foo' => '#bar')
|
||||
---
|
||||
test: Document starting with a comment and a separator
|
||||
brief: >
|
||||
Commenting before document start is allowed
|
||||
yaml: |
|
||||
# document comment
|
||||
---
|
||||
foo: bar # a comment
|
||||
php: |
|
||||
array('foo' => 'bar')
|
||||
|
|
@ -0,0 +1,53 @@
|
|||
--- %YAML:1.0
|
||||
test: Compact notation
|
||||
brief: |
|
||||
Compact notation for sets of mappings with single element
|
||||
yaml: |
|
||||
---
|
||||
# products purchased
|
||||
- item : Super Hoop
|
||||
- item : Basketball
|
||||
quantity: 1
|
||||
- item:
|
||||
name: Big Shoes
|
||||
nick: Biggies
|
||||
quantity: 1
|
||||
php: |
|
||||
array (
|
||||
array (
|
||||
'item' => 'Super Hoop',
|
||||
),
|
||||
array (
|
||||
'item' => 'Basketball',
|
||||
'quantity' => 1,
|
||||
),
|
||||
array (
|
||||
'item' => array(
|
||||
'name' => 'Big Shoes',
|
||||
'nick' => 'Biggies'
|
||||
),
|
||||
'quantity' => 1
|
||||
)
|
||||
)
|
||||
---
|
||||
test: Compact notation combined with inline notation
|
||||
brief: |
|
||||
Combinations of compact and inline notation are allowed
|
||||
yaml: |
|
||||
---
|
||||
items:
|
||||
- { item: Super Hoop, quantity: 1 }
|
||||
- [ Basketball, Big Shoes ]
|
||||
php: |
|
||||
array (
|
||||
'items' => array (
|
||||
array (
|
||||
'item' => 'Super Hoop',
|
||||
'quantity' => 1,
|
||||
),
|
||||
array (
|
||||
'Basketball',
|
||||
'Big Shoes'
|
||||
)
|
||||
)
|
||||
)
|
||||
|
|
@ -0,0 +1,27 @@
|
|||
--- %YAML:1.0
|
||||
test: Simple In Place Substitution
|
||||
brief: >
|
||||
If you want to reuse an entire alias, only overwriting what is different
|
||||
you can use a << in place substitution. This is not part of the official
|
||||
YAML spec, but a widely implemented extension. See the following URL for
|
||||
details: http://yaml.org/type/merge.html
|
||||
yaml: |
|
||||
foo: &foo
|
||||
a: Steve
|
||||
b: Clark
|
||||
c: Brian
|
||||
bar: &bar
|
||||
<<: *foo
|
||||
x: Oren
|
||||
foo2: &foo2
|
||||
a: Ballmer
|
||||
ding: &dong [ fi, fei, fo, fam]
|
||||
check:
|
||||
<<:
|
||||
- *foo
|
||||
- *dong
|
||||
isit: tested
|
||||
head:
|
||||
<<: [ *foo , *dong , *foo2 ]
|
||||
php: |
|
||||
array('foo' => array('a' => 'Steve', 'b' => 'Clark', 'c' => 'Brian'), 'bar' => array('a' => 'Steve', 'b' => 'Clark', 'c' => 'Brian', 'x' => 'Oren'), 'foo2' => array('a' => 'Ballmer'), 'ding' => array('fi', 'fei', 'fo', 'fam'), 'check' => array('a' => 'Steve', 'b' => 'Clark', 'c' => 'Brian', 'fi', 'fei', 'fo', 'fam', 'isit' => 'tested'), 'head' => array('a' => 'Ballmer', 'b' => 'Clark', 'c' => 'Brian', 'fi', 'fei', 'fo', 'fam'))
|
||||
|
|
@ -0,0 +1,11 @@
|
|||
--- %YAML:1.0
|
||||
test: Objects
|
||||
brief: >
|
||||
Comments at the end of a line
|
||||
yaml: |
|
||||
ex1: "foo # bar"
|
||||
ex2: "foo # bar" # comment
|
||||
ex3: 'foo # bar' # comment
|
||||
ex4: foo # comment
|
||||
php: |
|
||||
array('ex1' => 'foo # bar', 'ex2' => 'foo # bar', 'ex3' => 'foo # bar', 'ex4' => 'foo')
|
||||
|
|
@ -0,0 +1,33 @@
|
|||
--- %YAML:1.0
|
||||
test: Some characters at the beginning of a string must be escaped
|
||||
brief: >
|
||||
Some characters at the beginning of a string must be escaped
|
||||
yaml: |
|
||||
foo: | bar
|
||||
php: |
|
||||
array('foo' => '| bar')
|
||||
---
|
||||
test: A key can be a quoted string
|
||||
brief: >
|
||||
A key can be a quoted string
|
||||
yaml: |
|
||||
"foo1": bar
|
||||
'foo2': bar
|
||||
"foo \" bar": bar
|
||||
'foo '' bar': bar
|
||||
'foo3: ': bar
|
||||
"foo4: ": bar
|
||||
foo5: { "foo \" bar: ": bar, 'foo '' bar: ': bar }
|
||||
php: |
|
||||
array(
|
||||
'foo1' => 'bar',
|
||||
'foo2' => 'bar',
|
||||
'foo " bar' => 'bar',
|
||||
'foo \' bar' => 'bar',
|
||||
'foo3: ' => 'bar',
|
||||
'foo4: ' => 'bar',
|
||||
'foo5' => array(
|
||||
'foo " bar: ' => 'bar',
|
||||
'foo \' bar: ' => 'bar',
|
||||
),
|
||||
)
|
||||
|
|
@ -0,0 +1,145 @@
|
|||
--- %YAML:1.0
|
||||
test: Multiple quoted string on one line
|
||||
brief: >
|
||||
Multiple quoted string on one line
|
||||
yaml: |
|
||||
stripped_title: { name: "foo bar", help: "bar foo" }
|
||||
php: |
|
||||
array('stripped_title' => array('name' => 'foo bar', 'help' => 'bar foo'))
|
||||
---
|
||||
test: Empty sequence
|
||||
yaml: |
|
||||
foo: [ ]
|
||||
php: |
|
||||
array('foo' => array())
|
||||
---
|
||||
test: Empty value
|
||||
yaml: |
|
||||
foo:
|
||||
php: |
|
||||
array('foo' => null)
|
||||
---
|
||||
test: Inline string parsing
|
||||
brief: >
|
||||
Inline string parsing
|
||||
yaml: |
|
||||
test: ['complex: string', 'another [string]']
|
||||
php: |
|
||||
array('test' => array('complex: string', 'another [string]'))
|
||||
---
|
||||
test: Boolean
|
||||
brief: >
|
||||
Boolean
|
||||
yaml: |
|
||||
- false
|
||||
- -
|
||||
- off
|
||||
- no
|
||||
- true
|
||||
- +
|
||||
- on
|
||||
- yes
|
||||
- null
|
||||
- ~
|
||||
- 'false'
|
||||
- '-'
|
||||
- 'off'
|
||||
- 'no'
|
||||
- 'true'
|
||||
- '+'
|
||||
- 'on'
|
||||
- 'yes'
|
||||
- 'null'
|
||||
- '~'
|
||||
php: |
|
||||
array(
|
||||
false,
|
||||
false,
|
||||
false,
|
||||
false,
|
||||
true,
|
||||
true,
|
||||
true,
|
||||
true,
|
||||
null,
|
||||
null,
|
||||
'false',
|
||||
'-',
|
||||
'off',
|
||||
'no',
|
||||
'true',
|
||||
'+',
|
||||
'on',
|
||||
'yes',
|
||||
'null',
|
||||
'~',
|
||||
)
|
||||
---
|
||||
test: Empty lines in folded blocks
|
||||
brief: >
|
||||
Empty lines in folded blocks
|
||||
yaml: |
|
||||
foo:
|
||||
bar: |
|
||||
foo
|
||||
|
||||
|
||||
|
||||
bar
|
||||
php: |
|
||||
array('foo' => array('bar' => "foo\n\n\n \nbar\n"))
|
||||
---
|
||||
test: IP addresses
|
||||
brief: >
|
||||
IP addresses
|
||||
yaml: |
|
||||
foo: 10.0.0.2
|
||||
php: |
|
||||
array('foo' => '10.0.0.2')
|
||||
---
|
||||
test: A sequence with an embedded mapping
|
||||
brief: >
|
||||
A sequence with an embedded mapping
|
||||
yaml: |
|
||||
- foo
|
||||
- bar: { bar: foo }
|
||||
php: |
|
||||
array('foo', array('bar' => array('bar' => 'foo')))
|
||||
---
|
||||
test: A sequence with an unordered array
|
||||
brief: >
|
||||
A sequence with an unordered array
|
||||
yaml: |
|
||||
1: foo
|
||||
0: bar
|
||||
php: |
|
||||
array(1 => 'foo', 0 => 'bar')
|
||||
---
|
||||
test: Octal
|
||||
brief: as in spec example 2.19, octal value is converted
|
||||
yaml: |
|
||||
foo: 0123
|
||||
php: |
|
||||
array('foo' => 83)
|
||||
---
|
||||
test: Octal strings
|
||||
brief: Octal notation in a string must remain a string
|
||||
yaml: |
|
||||
foo: "0123"
|
||||
php: |
|
||||
array('foo' => '0123')
|
||||
---
|
||||
test: Octal strings
|
||||
brief: Octal notation in a string must remain a string
|
||||
yaml: |
|
||||
foo: '0123'
|
||||
php: |
|
||||
array('foo' => '0123')
|
||||
---
|
||||
test: Octal strings
|
||||
brief: Octal notation in a string must remain a string
|
||||
yaml: |
|
||||
foo: |
|
||||
0123
|
||||
php: |
|
||||
array('foo' => "0123\n")
|
||||
|
|
@ -0,0 +1,27 @@
|
|||
<?php
|
||||
|
||||
/*
|
||||
* This file is part of the symfony package.
|
||||
* (c) Fabien Potencier <fabien.potencier@symfony-project.com>
|
||||
*
|
||||
* For the full copyright and license information, please view the LICENSE
|
||||
* file that was distributed with this source code.
|
||||
*/
|
||||
|
||||
require_once(dirname(__FILE__).'/lime/lime.php');
|
||||
|
||||
$h = new lime_harness(array(
|
||||
'force_colors' => isset($argv) && in_array('--color', $argv),
|
||||
'verbose' => isset($argv) && in_array('--verbose', $argv),
|
||||
));
|
||||
$h->base_dir = realpath(dirname(__FILE__));
|
||||
|
||||
foreach (new RecursiveIteratorIterator(new RecursiveDirectoryIterator(dirname(__FILE__)), RecursiveIteratorIterator::LEAVES_ONLY) as $file)
|
||||
{
|
||||
if (preg_match('/Test\.php$/', $file))
|
||||
{
|
||||
$h->register($file->getRealPath());
|
||||
}
|
||||
}
|
||||
|
||||
exit($h->run() ? 0 : 1);
|
||||
|
|
@ -0,0 +1,152 @@
|
|||
<?php
|
||||
|
||||
/*
|
||||
* This file is part of the symfony package.
|
||||
* (c) Fabien Potencier <fabien.potencier@symfony-project.com>
|
||||
*
|
||||
* For the full copyright and license information, please view the LICENSE
|
||||
* file that was distributed with this source code.
|
||||
*/
|
||||
|
||||
require_once(dirname(__FILE__).'/lime/lime.php');
|
||||
require_once(dirname(__FILE__).'/../lib/sfYaml.php');
|
||||
require_once(dirname(__FILE__).'/../lib/sfYamlParser.php');
|
||||
require_once(dirname(__FILE__).'/../lib/sfYamlDumper.php');
|
||||
|
||||
sfYaml::setSpecVersion('1.1');
|
||||
|
||||
$t = new lime_test(152);
|
||||
|
||||
$parser = new sfYamlParser();
|
||||
$dumper = new sfYamlDumper();
|
||||
|
||||
$path = dirname(__FILE__).'/fixtures';
|
||||
$files = $parser->parse(file_get_contents($path.'/index.yml'));
|
||||
foreach ($files as $file)
|
||||
{
|
||||
$t->diag($file);
|
||||
|
||||
$yamls = file_get_contents($path.'/'.$file.'.yml');
|
||||
|
||||
// split YAMLs documents
|
||||
foreach (preg_split('/^---( %YAML\:1\.0)?/m', $yamls) as $yaml)
|
||||
{
|
||||
if (!$yaml)
|
||||
{
|
||||
continue;
|
||||
}
|
||||
|
||||
$test = $parser->parse($yaml);
|
||||
if (isset($test['dump_skip']) && $test['dump_skip'])
|
||||
{
|
||||
continue;
|
||||
}
|
||||
else if (isset($test['todo']) && $test['todo'])
|
||||
{
|
||||
$t->todo($test['test']);
|
||||
}
|
||||
else
|
||||
{
|
||||
$expected = eval('return '.trim($test['php']).';');
|
||||
|
||||
$t->is_deeply($parser->parse($dumper->dump($expected, 10)), $expected, $test['test']);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// inline level
|
||||
$array = array(
|
||||
'' => 'bar',
|
||||
'foo' => '#bar',
|
||||
'foo\'bar' => array(),
|
||||
'bar' => array(1, 'foo'),
|
||||
'foobar' => array(
|
||||
'foo' => 'bar',
|
||||
'bar' => array(1, 'foo'),
|
||||
'foobar' => array(
|
||||
'foo' => 'bar',
|
||||
'bar' => array(1, 'foo'),
|
||||
),
|
||||
),
|
||||
);
|
||||
|
||||
$expected = <<<EOF
|
||||
{ '': bar, foo: '#bar', 'foo''bar': { }, bar: [1, foo], foobar: { foo: bar, bar: [1, foo], foobar: { foo: bar, bar: [1, foo] } } }
|
||||
EOF;
|
||||
$t->is($dumper->dump($array, -10), $expected, '->dump() takes an inline level argument');
|
||||
$t->is($dumper->dump($array, 0), $expected, '->dump() takes an inline level argument');
|
||||
|
||||
$expected = <<<EOF
|
||||
'': bar
|
||||
foo: '#bar'
|
||||
'foo''bar': { }
|
||||
bar: [1, foo]
|
||||
foobar: { foo: bar, bar: [1, foo], foobar: { foo: bar, bar: [1, foo] } }
|
||||
|
||||
EOF;
|
||||
$t->is($dumper->dump($array, 1), $expected, '->dump() takes an inline level argument');
|
||||
|
||||
$expected = <<<EOF
|
||||
'': bar
|
||||
foo: '#bar'
|
||||
'foo''bar': { }
|
||||
bar:
|
||||
- 1
|
||||
- foo
|
||||
foobar:
|
||||
foo: bar
|
||||
bar: [1, foo]
|
||||
foobar: { foo: bar, bar: [1, foo] }
|
||||
|
||||
EOF;
|
||||
$t->is($dumper->dump($array, 2), $expected, '->dump() takes an inline level argument');
|
||||
|
||||
$expected = <<<EOF
|
||||
'': bar
|
||||
foo: '#bar'
|
||||
'foo''bar': { }
|
||||
bar:
|
||||
- 1
|
||||
- foo
|
||||
foobar:
|
||||
foo: bar
|
||||
bar:
|
||||
- 1
|
||||
- foo
|
||||
foobar:
|
||||
foo: bar
|
||||
bar: [1, foo]
|
||||
|
||||
EOF;
|
||||
$t->is($dumper->dump($array, 3), $expected, '->dump() takes an inline level argument');
|
||||
|
||||
$expected = <<<EOF
|
||||
'': bar
|
||||
foo: '#bar'
|
||||
'foo''bar': { }
|
||||
bar:
|
||||
- 1
|
||||
- foo
|
||||
foobar:
|
||||
foo: bar
|
||||
bar:
|
||||
- 1
|
||||
- foo
|
||||
foobar:
|
||||
foo: bar
|
||||
bar:
|
||||
- 1
|
||||
- foo
|
||||
|
||||
EOF;
|
||||
$t->is($dumper->dump($array, 4), $expected, '->dump() takes an inline level argument');
|
||||
$t->is($dumper->dump($array, 10), $expected, '->dump() takes an inline level argument');
|
||||
|
||||
// objects
|
||||
$t->diag('Objects support');
|
||||
class A
|
||||
{
|
||||
public $a = 'foo';
|
||||
}
|
||||
$a = array('foo' => new A(), 'bar' => 1);
|
||||
$t->is($dumper->dump($a), '{ foo: !!php/object:O:1:"A":1:{s:1:"a";s:3:"foo";}, bar: 1 }', '->dump() is able to dump objects');
|
||||
|
|
@ -0,0 +1,147 @@
|
|||
<?php
|
||||
|
||||
/*
|
||||
* This file is part of the symfony package.
|
||||
* (c) Fabien Potencier <fabien.potencier@symfony-project.com>
|
||||
*
|
||||
* For the full copyright and license information, please view the LICENSE
|
||||
* file that was distributed with this source code.
|
||||
*/
|
||||
|
||||
require_once(dirname(__FILE__).'/lime/lime.php');
|
||||
require_once(dirname(__FILE__).'/../lib/sfYaml.php');
|
||||
require_once(dirname(__FILE__).'/../lib/sfYamlInline.php');
|
||||
|
||||
sfYaml::setSpecVersion('1.1');
|
||||
|
||||
$t = new lime_test(124);
|
||||
|
||||
// ::load()
|
||||
$t->diag('::load()');
|
||||
|
||||
$testsForLoad = array(
|
||||
'' => '',
|
||||
'null' => null,
|
||||
'false' => false,
|
||||
'true' => true,
|
||||
'12' => 12,
|
||||
'"quoted string"' => 'quoted string',
|
||||
"'quoted string'" => 'quoted string',
|
||||
'12.30e+02' => 12.30e+02,
|
||||
'0x4D2' => 0x4D2,
|
||||
'02333' => 02333,
|
||||
'.Inf' => -log(0),
|
||||
'-.Inf' => log(0),
|
||||
'123456789123456789' => '123456789123456789',
|
||||
'"foo\r\nbar"' => "foo\r\nbar",
|
||||
"'foo#bar'" => 'foo#bar',
|
||||
"'foo # bar'" => 'foo # bar',
|
||||
"'#cfcfcf'" => '#cfcfcf',
|
||||
|
||||
'2007-10-30' => mktime(0, 0, 0, 10, 30, 2007),
|
||||
'2007-10-30T02:59:43Z' => gmmktime(2, 59, 43, 10, 30, 2007),
|
||||
'2007-10-30 02:59:43 Z' => gmmktime(2, 59, 43, 10, 30, 2007),
|
||||
|
||||
'"a \\"string\\" with \'quoted strings inside\'"' => 'a "string" with \'quoted strings inside\'',
|
||||
"'a \"string\" with ''quoted strings inside'''" => 'a "string" with \'quoted strings inside\'',
|
||||
|
||||
// sequences
|
||||
// urls are no key value mapping. see #3609. Valid yaml "key: value" mappings require a space after the colon
|
||||
'[foo, http://urls.are/no/mappings, false, null, 12]' => array('foo', 'http://urls.are/no/mappings', false, null, 12),
|
||||
'[ foo , bar , false , null , 12 ]' => array('foo', 'bar', false, null, 12),
|
||||
'[\'foo,bar\', \'foo bar\']' => array('foo,bar', 'foo bar'),
|
||||
|
||||
// mappings
|
||||
'{foo:bar,bar:foo,false:false,null:null,integer:12}' => array('foo' => 'bar', 'bar' => 'foo', 'false' => false, 'null' => null, 'integer' => 12),
|
||||
'{ foo : bar, bar : foo, false : false, null : null, integer : 12 }' => array('foo' => 'bar', 'bar' => 'foo', 'false' => false, 'null' => null, 'integer' => 12),
|
||||
'{foo: \'bar\', bar: \'foo: bar\'}' => array('foo' => 'bar', 'bar' => 'foo: bar'),
|
||||
'{\'foo\': \'bar\', "bar": \'foo: bar\'}' => array('foo' => 'bar', 'bar' => 'foo: bar'),
|
||||
'{\'foo\'\'\': \'bar\', "bar\"": \'foo: bar\'}' => array('foo\'' => 'bar', "bar\"" => 'foo: bar'),
|
||||
'{\'foo: \': \'bar\', "bar: ": \'foo: bar\'}' => array('foo: ' => 'bar', "bar: " => 'foo: bar'),
|
||||
|
||||
// nested sequences and mappings
|
||||
'[foo, [bar, foo]]' => array('foo', array('bar', 'foo')),
|
||||
'[foo, {bar: foo}]' => array('foo', array('bar' => 'foo')),
|
||||
'{ foo: {bar: foo} }' => array('foo' => array('bar' => 'foo')),
|
||||
'{ foo: [bar, foo] }' => array('foo' => array('bar', 'foo')),
|
||||
|
||||
'[ foo, [ bar, foo ] ]' => array('foo', array('bar', 'foo')),
|
||||
|
||||
'[{ foo: {bar: foo} }]' => array(array('foo' => array('bar' => 'foo'))),
|
||||
|
||||
'[foo, [bar, [foo, [bar, foo]], foo]]' => array('foo', array('bar', array('foo', array('bar', 'foo')), 'foo')),
|
||||
|
||||
'[foo, {bar: foo, foo: [foo, {bar: foo}]}, [foo, {bar: foo}]]' => array('foo', array('bar' => 'foo', 'foo' => array('foo', array('bar' => 'foo'))), array('foo', array('bar' => 'foo'))),
|
||||
|
||||
'[foo, bar: { foo: bar }]' => array('foo', '1' => array('bar' => array('foo' => 'bar'))),
|
||||
);
|
||||
|
||||
foreach ($testsForLoad as $yaml => $value)
|
||||
{
|
||||
$t->is_deeply(sfYamlInline::load($yaml), $value, sprintf('::load() converts an inline YAML to a PHP structure (%s)', $yaml));
|
||||
}
|
||||
|
||||
$testsForDump = array(
|
||||
'null' => null,
|
||||
'false' => false,
|
||||
'true' => true,
|
||||
'12' => 12,
|
||||
"'quoted string'" => 'quoted string',
|
||||
'12.30e+02' => 12.30e+02,
|
||||
'1234' => 0x4D2,
|
||||
'1243' => 02333,
|
||||
'.Inf' => -log(0),
|
||||
'-.Inf' => log(0),
|
||||
'"foo\r\nbar"' => "foo\r\nbar",
|
||||
"'foo#bar'" => 'foo#bar',
|
||||
"'foo # bar'" => 'foo # bar',
|
||||
"'#cfcfcf'" => '#cfcfcf',
|
||||
|
||||
"'a \"string\" with ''quoted strings inside'''" => 'a "string" with \'quoted strings inside\'',
|
||||
|
||||
// sequences
|
||||
'[foo, bar, false, null, 12]' => array('foo', 'bar', false, null, 12),
|
||||
'[\'foo,bar\', \'foo bar\']' => array('foo,bar', 'foo bar'),
|
||||
|
||||
// mappings
|
||||
'{ foo: bar, bar: foo, \'false\': false, \'null\': null, integer: 12 }' => array('foo' => 'bar', 'bar' => 'foo', 'false' => false, 'null' => null, 'integer' => 12),
|
||||
'{ foo: bar, bar: \'foo: bar\' }' => array('foo' => 'bar', 'bar' => 'foo: bar'),
|
||||
|
||||
// nested sequences and mappings
|
||||
'[foo, [bar, foo]]' => array('foo', array('bar', 'foo')),
|
||||
|
||||
'[foo, [bar, [foo, [bar, foo]], foo]]' => array('foo', array('bar', array('foo', array('bar', 'foo')), 'foo')),
|
||||
|
||||
'{ foo: { bar: foo } }' => array('foo' => array('bar' => 'foo')),
|
||||
|
||||
'[foo, { bar: foo }]' => array('foo', array('bar' => 'foo')),
|
||||
|
||||
'[foo, { bar: foo, foo: [foo, { bar: foo }] }, [foo, { bar: foo }]]' => array('foo', array('bar' => 'foo', 'foo' => array('foo', array('bar' => 'foo'))), array('foo', array('bar' => 'foo'))),
|
||||
);
|
||||
|
||||
// ::dump()
|
||||
$t->diag('::dump()');
|
||||
foreach ($testsForDump as $yaml => $value)
|
||||
{
|
||||
$t->is(sfYamlInline::dump($value), $yaml, sprintf('::dump() converts a PHP structure to an inline YAML (%s)', $yaml));
|
||||
}
|
||||
|
||||
foreach ($testsForLoad as $yaml => $value)
|
||||
{
|
||||
if ($value == 1230)
|
||||
{
|
||||
continue;
|
||||
}
|
||||
|
||||
$t->is_deeply(sfYamlInline::load(sfYamlInline::dump($value)), $value, 'check consistency');
|
||||
}
|
||||
|
||||
foreach ($testsForDump as $yaml => $value)
|
||||
{
|
||||
if ($value == 1230)
|
||||
{
|
||||
continue;
|
||||
}
|
||||
|
||||
$t->is_deeply(sfYamlInline::load(sfYamlInline::dump($value)), $value, 'check consistency');
|
||||
}
|
||||
|
|
@ -0,0 +1,91 @@
|
|||
<?php
|
||||
|
||||
/*
|
||||
* This file is part of the symfony package.
|
||||
* (c) Fabien Potencier <fabien.potencier@symfony-project.com>
|
||||
*
|
||||
* For the full copyright and license information, please view the LICENSE
|
||||
* file that was distributed with this source code.
|
||||
*/
|
||||
|
||||
require_once(dirname(__FILE__).'/lime/lime.php');
|
||||
require_once(dirname(__FILE__).'/../lib/sfYaml.php');
|
||||
require_once(dirname(__FILE__).'/../lib/sfYamlParser.php');
|
||||
|
||||
sfYaml::setSpecVersion('1.1');
|
||||
|
||||
$t = new lime_test(153);
|
||||
|
||||
$parser = new sfYamlParser();
|
||||
|
||||
$path = dirname(__FILE__).'/fixtures';
|
||||
$files = $parser->parse(file_get_contents($path.'/index.yml'));
|
||||
foreach ($files as $file)
|
||||
{
|
||||
$t->diag($file);
|
||||
|
||||
$yamls = file_get_contents($path.'/'.$file.'.yml');
|
||||
|
||||
// split YAMLs documents
|
||||
foreach (preg_split('/^---( %YAML\:1\.0)?/m', $yamls) as $yaml)
|
||||
{
|
||||
if (!$yaml)
|
||||
{
|
||||
continue;
|
||||
}
|
||||
|
||||
$test = $parser->parse($yaml);
|
||||
if (isset($test['todo']) && $test['todo'])
|
||||
{
|
||||
$t->todo($test['test']);
|
||||
}
|
||||
else
|
||||
{
|
||||
$expected = var_export(eval('return '.trim($test['php']).';'), true);
|
||||
|
||||
$t->is(var_export($parser->parse($test['yaml']), true), $expected, $test['test']);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// test tabs in YAML
|
||||
$yamls = array(
|
||||
"foo:\n bar",
|
||||
"foo:\n bar",
|
||||
"foo:\n bar",
|
||||
"foo:\n bar",
|
||||
);
|
||||
|
||||
foreach ($yamls as $yaml)
|
||||
{
|
||||
try
|
||||
{
|
||||
$content = $parser->parse($yaml);
|
||||
$t->fail('YAML files must not contain tabs');
|
||||
}
|
||||
catch (InvalidArgumentException $e)
|
||||
{
|
||||
$t->pass('YAML files must not contain tabs');
|
||||
}
|
||||
}
|
||||
|
||||
$yaml = <<<EOF
|
||||
--- %YAML:1.0
|
||||
foo
|
||||
...
|
||||
EOF;
|
||||
|
||||
$t->is('foo', $parser->parse($yaml));
|
||||
|
||||
// objects
|
||||
$t->diag('Objects support');
|
||||
class A
|
||||
{
|
||||
public $a = 'foo';
|
||||
}
|
||||
$a = array('foo' => new A(), 'bar' => 1);
|
||||
$t->is($parser->parse(<<<EOF
|
||||
foo: !!php/object:O:1:"A":1:{s:1:"a";s:3:"foo";}
|
||||
bar: 1
|
||||
EOF
|
||||
), $a, '->parse() is able to dump objects');
|
||||
Loading…
Reference in New Issue