Yaml.php

Go to the documentation of this file.

<?php
/*
 You may not change or alter any portion of this comment or credits
 of supporting developers from this source code or any supporting source code
 which is considered copyrighted (c) material of the original comment or credit authors.

 This program is distributed in the hope that it will be useful,
 but WITHOUT ANY WARRANTY; without even the implied warranty of
 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
 */

namespace Xoops\Core;

use Symfony\Component\Yaml\Yaml as VendorYaml;

class Yaml
{

    public static function dump($var, $inline = 4, $indent = 4)
    {
        try {
            $ret = VendorYaml::dump($var, $inline, $indent);
        } catch (\Exception $e) {
            \Xoops::getInstance()->events()->triggerEvent('core.exception', $e);
            $ret = false;
        }
        return $ret;
    }

    public static function load($yamlString)
    {
        try {
            $ret = VendorYaml::parse($yamlString);
        } catch (\Exception $e) {
            \Xoops::getInstance()->events()->triggerEvent('core.exception', $e);
            $ret = false;
        }
        return $ret;
    }

    public static function read($yamlFile)
    {
        try {
            $yamlString = file_get_contents($yamlFile);
            $ret = VendorYaml::parse($yamlString);
        } catch (\Exception $e) {
            \Xoops::getInstance()->events()->triggerEvent('core.exception', $e);
            $ret = false;
        }
        return $ret;
    }

    public static function save($var, $yamlFile, $inline = 4, $indent = 4)
    {
        try {
            $yamlString = VendorYaml::dump($var, $inline, $indent);
            $ret = file_put_contents($yamlFile, $yamlString);
        } catch (\Exception $e) {
            \Xoops::getInstance()->events()->triggerEvent('core.exception', $e);
            $ret = false;
        }
        return $ret;
    }

    public static function dumpWrapped($var, $inline = 4, $indent = 4)
    {
        try {
            $yamlString = VendorYaml::dump($var, $inline, $indent);
            $ret = empty($yamlString) ? false : "<?php\n/*\n---\n" . $yamlString . "\n...\n*/\n";
        } catch (\Exception $e) {
            \Xoops::getInstance()->events()->triggerEvent('core.exception', $e);
            $ret = false;
        }
        return $ret;
    }

    public static function loadWrapped($yamlString)
    {
        try {
            $match = array();
            $matched = preg_match('/(---.*\.\.\.)/s', $yamlString, $match);
            $unwrapped = $matched ? $match[1] : $yamlString;
            $ret = VendorYaml::parse($unwrapped);
        } catch (\Exception $e) {
            \Xoops::getInstance()->events()->triggerEvent('core.exception', $e);
            $ret = false;
        }
        return $ret;
    }

    public static function readWrapped($yamlFile)
    {
        try {
            $yamlString = file_get_contents($yamlFile);
            $ret = self::loadWrapped($yamlString);
        } catch (\Exception $e) {
            \Xoops::getInstance()->events()->triggerEvent('core.exception', $e);
            $ret = false;
        }
        return $ret;
    }

    public static function saveWrapped($var, $yamlFile, $inline = 4, $indent = 4)
    {
        try {
            $yamlString = self::dumpWrapped($var, $inline, $indent);
            $ret = file_put_contents($yamlFile, $yamlString);
        } catch (\Exception $e) {
            \Xoops::getInstance()->events()->triggerEvent('core.exception', $e);
            $ret = false;
        }
        return $ret;
    }
}