File views/helpers/be_html.php | BEdita API doc

  1   2   3   4   5   6   7   8   9  10  11  12  13  14  15  16  17  18  19  20  21  22  23  24  25  26  27  28  29  30  31  32  33  34  35  36  37  38  39  40  41  42  43  44  45  46  47  48  49  50  51  52  53  54  55  56  57  58  59  60  61  62  63  64  65  66  67  68  69  70  71  72  73  74  75  76  77  78  79  80  81  82  83  84  85  86  87  88  89  90  91  92  93  94  95  96  97  98  99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211

<?php
/*-----8<--------------------------------------------------------------------
 *
 * BEdita - a semantic content management framework
 *
 * Copyright 2015 ChannelWeb Srl, Chialab Srl
 *
 * This file is part of BEdita: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published
 * by the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 * BEdita is distributed WITHOUT ANY WARRANTY; without even the implied
 * warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
 * See the GNU Lesser General Public License for more details.
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with BEdita (see LICENSE.LGPL).
 * If not, see <http://gnu.org/licenses/lgpl-3.0.html>.
 *
 *------------------------------------------------------------------->8-----
 */

App::import('Helper', 'Html');

/**
 * BeHtmlHelper class.
 * Extends CakePHP HtmlHelper adding some functionality
 */
class BeHtmlHelper extends HtmlHelper {
    /**
     * Current language.
     *
     * @var string
     */
    protected $currLang = null;

    /**
     * Class constructor.
     */
    public function __construct(array $options = array()) {
        if (!empty($options['currLang'])) {
            $this->currLang = $options['currLang'];
        }
    }

    /**
     * Parses a URL involving Router.
     *
     * @see Router::parse()
     * @param mixed $url URL.
     * @param array $mergeParams Array of URL parameters to be merged to URL.
     * @return mixed Parsed URL.
     */
    private function parse ($url = null, array $mergeParams = null) {
        if (!is_array($url) && !preg_match('/^(https?|mailto|s?ftps?)/i', $url)) {
            $url = Router::parse($url);
            if (array_key_exists('named', $url) && is_array($url['named'])) {
                foreach ($url['named'] as $key => $val) {
                    array_push($url, $key . ':' . urlencode($val));
                }
                unset($url['named']);
            }
            if (array_key_exists('pass', $url)) {
                $url = array_merge($url, $url['pass']);
                unset($url['pass']);
            }
            unset($url['plugin']);
        }
        if (is_array($url) && !empty($mergeParams)) {
            $url = array_merge($url, $mergeParams);
        }
        if ((!empty($url['lang']) ? $url['lang'] : $this->currLang) == Configure::read('frontendLang')) {
            $url['lang'] = '';
        }
        return $url;
    }

    /**
     * Returns a formatted link, forcing Router to be involved in URL generation.
     *
     * @see HtmlHelper::link()
     * @param string $title Text to be wrapped within `<a>` tags.
     * @param mixed $url URL.
     * @param array $options Additional HTML attributes.
     * @param mixed $confirmMessage JS confirm message.
     * @param array $mergeParams Array of URL parameters to be merged to URL.
     * @return string HTML tag `<a>`.
     */
    public function link ($title, $url = null, array $options = null, $confirmMessage = false, array $mergeParams = null) {
        return parent::link($title, $this->parse($url, $mergeParams), $options, $confirmMessage);
    }

    /**
     * Returns a URL for the given action, forcing Router to be involved.
     *
     * @see Helper::url()
     * @param mixed $url URL.
     * @param boolean $full Full URL.
     * @param array $mergeParams Array of URL parameters to be merged to URL.
     * @return string URL.
     */
    public function url ($url = null, $full = false, array $mergeParams = null) {
        return parent::url($this->parse($url, $mergeParams), $full);
    }

    /**
     * Hyphenate a string.
     *
     * @param string $text Text to be hyphenated.
     * @param string|null $lang Text language.
     * @param string[] $excludeSelectors CSS selectors of elements to be skipped when hyphenating.
     * @param string[] $excludeSelectorsDefault Same as above, but by default. (???)
     * @return string Hyphenated string.
     */
    public function hyphen($text, $lang = null, $excludeSelectors = array('.formula'), $excludeSelectorDefaults = array('pre', 'code', 'embed', 'object', 'iframe', 'img', 'svg', 'video', 'audio', 'script', 'style', 'head', 'sub', 'sup')) {
        if (empty($lang)) {
            $lang = Configure::read('defaultLang');
        }

        App::Import('Vendor', 'simple_html_dom');
        App::import('Vendor', 'Hyphenator', array('file' => 'hyphenator' . DS . 'Hyphenator.php'));

        $hyphenator = ClassRegistry::getObject('Hyphenator');
        if (!$hyphenator) {
            $hyphenator = new Hyphenator();
            ClassRegistry::addObject('Hyphenator', $hyphenator);
        }

        $excludeSelectors = array_merge($excludeSelectorDefaults, $excludeSelectors);
        $restore = array();
        if (!empty($excludeSelectors)) {
            $html = str_get_html('<html><body>' . $text . '</body></html>');
            $body = $html->find('body', 0);
            $badsSelectors = implode(', ', $excludeSelectors);
            $bads = $body->find($badsSelectors);
            foreach ($bads as $bad) {
                if (empty($bad->beNotHyphen)) {
                    $innerBads = $bad->find($badsSelectors);
                    foreach ($innerBads as $innerBad) {
                        $innerBad->beNotHyphen = true;
                    }
                    $restore[] = $bad->innertext;
                    $bad->innertext = '<!-- be-not-hyphen-' . (count($restore) - 1) . ' -->';
                }
            }
            $text = $body->innertext;
        }

        $text = $hyphenator->hyphenate($text, $lang);

        foreach ($restore as $key => $value) {
            $text = str_replace('<!-- be-not-hyphen-' . $key . ' -->', $value, $text);
        }

        return $text;
    }

    /**
     * Append timestamp to an asset to help invalidate browsers' cache.
     *
     * @param string $path File path.
     * @return string
     */
    public function assetTimestamp($path) {
        $timestampMode = Configure::read('Asset.timestamp');
        if (($timestampMode !== 'force' && ($timestampMode !== true || Configure::read('debug') === 0)) || strpos($path, '?') !== false) {
            return $path;
        }

        $timestampAlg = Configure::read('Asset.algorithm');
        $hashMethod = function($path) use ($timestampAlg) {
            switch ($timestampAlg) {
                case 'md5':
                    return @md5_file($path);
                case 'md5-short':
                    return substr(@md5_file($path), 0, 7);
                case 'sha1':
                    return @sha1_file($path);
                case 'sha1-short':
                    return substr(@md5_file($path), 0, 7);
                case 'git':
                    return @shell_exec(sprintf('git -C %s rev-parse HEAD', escapeshellarg(basename($path))));
                case 'git-short':
                    return @shell_exec(sprintf('git -C %s rev-parse --short HEAD', escapeshellarg(basename($path))));
                default:
                    return @filemtime($path);
            }
        };

        $filepath = preg_replace('/^' . preg_quote($this->webroot, '/') . '/', '', $path);
        $webrootPath = WWW_ROOT . str_replace('/', DS, $filepath);
        if (file_exists($webrootPath)) {
            return $path . '?' . $hashMethod($webrootPath);
        }

        $segments = explode('/', ltrim($filepath, '/'));
        if ($segments[0] === 'theme') {
            $theme = $segments[1];
            unset($segments[0], $segments[1]);
            $themePath = App::themePath($theme) . 'webroot' . DS . implode(DS, $segments);

            return $path . '?' . $hashMethod($themePath);
        }

        $plugin = $segments[0];
        unset($segments[0]);
        $pluginPath = App::pluginPath($plugin) . 'webroot' . DS . implode(DS, $segments);

        return $path . '?' . $hashMethod($pluginPath);
    }
}

Classes

Interfaces

Exceptions