opencart/docs/api/source-system.helper.bbcode.html

183 lines
18 KiB
HTML

<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width">
<title>File system\helper\bbcode.php | OpenCart API API</title>
<link rel="stylesheet" href="http://localhost\opencart-master/docs/api/assets/main.css">
<script src="http://localhost\opencart-master/docs/api/assets/main.js" defer></script>
</head>
<body class="layout">
<div class="layout-aside">
<div class="menu">
<div class="menu-section">
<h3>Namespaces</h3>
<ul>
<li class="menuGroup-item">
<a href="http://localhost\opencart-master/docs/api/namespace-Opencart.html">Opencart</a>
<ul>
<li class="menuGroup-item">
<a href="http://localhost\opencart-master/docs/api/namespace-Opencart.Admin.html">Admin</a>
</li>
<li class="menuGroup-item">
<a href="http://localhost\opencart-master/docs/api/namespace-Opencart.Catalog.html">Catalog</a>
</li>
<li class="menuGroup-item">
<a href="http://localhost\opencart-master/docs/api/namespace-Opencart.System.html">System</a>
</li>
</ul>
</li>
<li class="menuGroup-item active">
<a href="http://localhost\opencart-master/docs/api/namespace-none.html">none</a>
</li>
</ul>
</div>
<div class="menu-section">
<h3>Functions</h3>
<ul>
<li class="active">
<a href="http://localhost\opencart-master/docs/api/function-oc_bbcode_decode.html">
oc_bbcode_decode
</a>
</li>
<li>
<a href="http://localhost\opencart-master/docs/api/function-oc_validate_length.html">
oc_validate_length
</a>
</li>
<li>
<a href="http://localhost\opencart-master/docs/api/function-oc_validate_email.html">
oc_validate_email
</a>
</li>
<li>
<a href="http://localhost\opencart-master/docs/api/function-oc_validate_ip.html">
oc_validate_ip
</a>
</li>
<li>
<a href="http://localhost\opencart-master/docs/api/function-oc_validate_filename.html">
oc_validate_filename
</a>
</li>
<li>
<a href="http://localhost\opencart-master/docs/api/function-oc_validate_url.html">
oc_validate_url
</a>
</li>
<li>
<a href="http://localhost\opencart-master/docs/api/function-oc_validate_seo_url.html">
oc_validate_seo_url
</a>
</li>
<li>
<a href="http://localhost\opencart-master/docs/api/function-oc_strlen.html">
oc_strlen
</a>
</li>
<li>
<a href="http://localhost\opencart-master/docs/api/function-oc_strpos.html">
oc_strpos
</a>
</li>
<li>
<a href="http://localhost\opencart-master/docs/api/function-oc_strrpos.html">
oc_strrpos
</a>
</li>
<li>
<a href="http://localhost\opencart-master/docs/api/function-oc_substr.html">
oc_substr
</a>
</li>
<li>
<a href="http://localhost\opencart-master/docs/api/function-oc_strtoupper.html">
oc_strtoupper
</a>
</li>
<li>
<a href="http://localhost\opencart-master/docs/api/function-oc_strtolower.html">
oc_strtolower
</a>
</li>
<li>
<a href="http://localhost\opencart-master/docs/api/function-oc_token.html">
oc_token
</a>
</li>
<li>
<a href="http://localhost\opencart-master/docs/api/function-str_starts_with.html">
str_starts_with
</a>
</li>
<li>
<a href="http://localhost\opencart-master/docs/api/function-str_ends_with.html">
str_ends_with
</a>
</li>
<li>
<a href="http://localhost\opencart-master/docs/api/function-oc_filter_keyword.html">
oc_filter_keyword
</a>
</li>
<li>
<a href="http://localhost\opencart-master/docs/api/function-oc_db_create.html">
oc_db_create
</a>
</li>
<li>
<a href="http://localhost\opencart-master/docs/api/function-oc_db_schema.html">
oc_db_schema
</a>
</li>
</ul>
</div>
</div>
</div>
<div class="layout-main">
<div class="layout-navbar">
<nav class="navbar">
<div class="navbar-left">
<ul class="navbar-links">
<li>
<a href="http://localhost\opencart-master/docs/api/index.html">Overview</a>
</li>
<li>
<a href="http://localhost\opencart-master/docs/api/namespace-none.html">Namespace</a>
</li>
<li class="active"><a href="http://localhost\opencart-master/docs/api/function-oc_bbcode_decode.html">Function</a></li> <li>
<a href="http://localhost\opencart-master/docs/api/tree.html">Tree</a>
</li>
</ul>
</div>
<div class="navbar-right">
<div class="search" data-elements="http://localhost\opencart-master/docs/api/assets/elements.js">
<input class="search-input" placeholder="Search class, function or namespace" autofocus>
<ul class="search-results"></ul>
</div>
</div>
</nav>
</div>
<div class="layout-content">
<table class="source"><tr id="1" class="source-line"><td><a class="source-lineNum" href="#1"> 1: </a></td><td><span class="php-tag">&lt;?php
</span></td></tr><tr id="2" class="source-line"><td><a class="source-lineNum" href="#2"> 2: </a></td><td><span class="php-tag"></span><span class="php-comment">// BBCode Converter that converts BBCode written for OpenCart</span>
</td></tr><tr id="3" class="source-line"><td><a class="source-lineNum" href="#3"> 3: </a></td><td><span class="php-kw">function</span> oc_bbcode_decode(string <span class="php-var">$string</span>): string {
</td></tr><tr id="4" class="source-line"><td><a class="source-lineNum" href="#4"> 4: </a></td><td> <span class="php-var">$pattern</span> = [];
</td></tr><tr id="5" class="source-line"><td><a class="source-lineNum" href="#5"> 5: </a></td><td> <span class="php-var">$replace</span> = [];
</td></tr><tr id="6" class="source-line"><td><a class="source-lineNum" href="#6"> 6: </a></td><td>
</td></tr><tr id="7" class="source-line"><td><a class="source-lineNum" href="#7"> 7: </a></td><td> <span class="php-comment">// Bold</span>
</td></tr><tr id="8" class="source-line"><td><a class="source-lineNum" href="#8"> 8: </a></td><td> <span class="php-var">$pattern</span>[<span class="php-num">0</span>] = <span class="php-str">&#039;/\[b\](.*?)\[\/b\]/is&#039;</span>;
</td></tr><tr id="9" class="source-line"><td><a class="source-lineNum" href="#9"> 9: </a></td><td> <span class="php-var">$replace</span>[<span class="php-num">0</span>] = <span class="php-str">&#039;&lt;strong&gt;$1&lt;/strong&gt;&#039;</span>;
</td></tr><tr id="10" class="source-line"><td><a class="source-lineNum" href="#10">10: </a></td><td>
</td></tr><tr id="11" class="source-line"><td><a class="source-lineNum" href="#11">11: </a></td><td> <span class="php-comment">// Italic</span>
</td></tr><tr id="12" class="source-line"><td><a class="source-lineNum" href="#12">12: </a></td><td> <span class="php-var">$pattern</span>[<span class="php-num">1</span>] = <span class="php-str">&#039;/\[i\](.*?)\[\/i\]/is&#039;</span>;
</td></tr><tr id="13" class="source-line"><td><a class="source-lineNum" href="#13">13: </a></td><td> <span class="php-var">$replace</span>[<span class="php-num">1</span>] = <span class="php-str">&#039;&lt;em&gt;$1&lt;/em&gt;&#039;</span>;
</td></tr><tr id="14" class="source-line"><td><a class="source-lineNum" href="#14">14: </a></td><td>
</td></tr><tr id="15" class="source-line"><td><a class="source-lineNum" href="#15">15: </a></td><td> <span class="php-comment">// Underlined</span>
</td></tr><tr id="16" class="source-line"><td><a class="source-lineNum" href="#16">16: </a></td><td> <span class="php-var">$pattern</span>[<span class="php-num">2</span>] = <span class="php-str">&#039;/\[u\](.*?)\[\/u\]/is&#039;</span>;
</td></tr><tr id="17" class="source-line"><td><a class="source-lineNum" href="#17">17: </a></td><td> <span class="php-var">$replace</span>[<span class="php-num">2</span>] = <span class="php-str">&#039;&lt;u&gt;$1&lt;/u&gt;&#039;</span>;
</td></tr><tr id="18" class="source-line"><td><a class="source-lineNum" href="#18">18: </a></td><td>
</td></tr><tr id="19" class="source-line"><td><a class="source-lineNum" href="#19">19: </a></td><td> <span class="php-comment">// Quote</span>
</td></tr><tr id="20" class="source-line"><td><a class="source-lineNum" href="#20">20: </a></td><td> <span class="php-var">$pattern</span>[<span class="php-num">3</span>] = <span class="php-str">&#039;/\[quote\](.*?)\[\/quote]/is&#039;</span>;
</td></tr><tr id="21" class="source-line"><td><a class="source-lineNum" href="#21">21: </a></td><td> <span class="php-var">$replace</span>[<span class="php-num">3</span>] = <span class="php-str">&#039;&lt;blockquote&gt;$1&lt;/blockquote&gt;&#039;</span>;
</td></tr><tr id="22" class="source-line"><td><a class="source-lineNum" href="#22">22: </a></td><td>
</td></tr><tr id="23" class="source-line"><td><a class="source-lineNum" href="#23">23: </a></td><td> <span class="php-comment">// Code</span>
</td></tr><tr id="24" class="source-line"><td><a class="source-lineNum" href="#24">24: </a></td><td> <span class="php-var">$pattern</span>[<span class="php-num">4</span>] = <span class="php-str">&#039;/\[code\](.*?)\[\/code\]/is&#039;</span>;
</td></tr><tr id="25" class="source-line"><td><a class="source-lineNum" href="#25">25: </a></td><td> <span class="php-var">$replace</span>[<span class="php-num">4</span>] = <span class="php-str">&#039;&lt;code&gt;$1&lt;/code&gt;&#039;</span>;
</td></tr><tr id="26" class="source-line"><td><a class="source-lineNum" href="#26">26: </a></td><td>
</td></tr><tr id="27" class="source-line"><td><a class="source-lineNum" href="#27">27: </a></td><td> <span class="php-comment">// Strikethrough</span>
</td></tr><tr id="28" class="source-line"><td><a class="source-lineNum" href="#28">28: </a></td><td> <span class="php-var">$pattern</span>[<span class="php-num">16</span>] = <span class="php-str">&#039;/\[s\](.*?)\[\/s\]/is&#039;</span>;
</td></tr><tr id="29" class="source-line"><td><a class="source-lineNum" href="#29">29: </a></td><td> <span class="php-var">$replace</span>[<span class="php-num">16</span>] = <span class="php-str">&#039;&lt;s&gt;$1&lt;/s&gt;&#039;</span>;
</td></tr><tr id="30" class="source-line"><td><a class="source-lineNum" href="#30">30: </a></td><td>
</td></tr><tr id="31" class="source-line"><td><a class="source-lineNum" href="#31">31: </a></td><td> <span class="php-comment">// List Item</span>
</td></tr><tr id="32" class="source-line"><td><a class="source-lineNum" href="#32">32: </a></td><td> <span class="php-var">$pattern</span>[<span class="php-num">7</span>] = <span class="php-str">&#039;/\[\*\]([\w\W]+?)\n?(?=(?:(?:\[\*\])|(?:\[\/list\])))/&#039;</span>;
</td></tr><tr id="33" class="source-line"><td><a class="source-lineNum" href="#33">33: </a></td><td> <span class="php-var">$replace</span>[<span class="php-num">7</span>] = <span class="php-str">&#039;&lt;li&gt;$1&lt;/li&gt;&#039;</span>;
</td></tr><tr id="34" class="source-line"><td><a class="source-lineNum" href="#34">34: </a></td><td>
</td></tr><tr id="35" class="source-line"><td><a class="source-lineNum" href="#35">35: </a></td><td> <span class="php-comment">// List</span>
</td></tr><tr id="36" class="source-line"><td><a class="source-lineNum" href="#36">36: </a></td><td> <span class="php-var">$pattern</span>[<span class="php-num">5</span>] = <span class="php-str">&#039;/\[list\](.*?)\[\/list\]/is&#039;</span>;
</td></tr><tr id="37" class="source-line"><td><a class="source-lineNum" href="#37">37: </a></td><td> <span class="php-var">$replace</span>[<span class="php-num">5</span>] = <span class="php-str">&#039;&lt;ul&gt;$1&lt;/ul&gt;&#039;</span>;
</td></tr><tr id="38" class="source-line"><td><a class="source-lineNum" href="#38">38: </a></td><td>
</td></tr><tr id="39" class="source-line"><td><a class="source-lineNum" href="#39">39: </a></td><td> <span class="php-comment">// Ordered List</span>
</td></tr><tr id="40" class="source-line"><td><a class="source-lineNum" href="#40">40: </a></td><td> <span class="php-var">$pattern</span>[<span class="php-num">6</span>] = <span class="php-str">&#039;/\[list\=(1|A|a|I|i)\](.*?)\[\/list\]/is&#039;</span>;
</td></tr><tr id="41" class="source-line"><td><a class="source-lineNum" href="#41">41: </a></td><td> <span class="php-var">$replace</span>[<span class="php-num">6</span>] = <span class="php-str">&#039;&lt;ol type=&quot;$1&quot;&gt;$2&lt;/ol&gt;&#039;</span>;
</td></tr><tr id="42" class="source-line"><td><a class="source-lineNum" href="#42">42: </a></td><td>
</td></tr><tr id="43" class="source-line"><td><a class="source-lineNum" href="#43">43: </a></td><td> <span class="php-comment">// Image</span>
</td></tr><tr id="44" class="source-line"><td><a class="source-lineNum" href="#44">44: </a></td><td> <span class="php-var">$pattern</span>[<span class="php-num">8</span>] = <span class="php-str">&#039;/\[img\](.*?)\[\/img\]/is&#039;</span>;
</td></tr><tr id="45" class="source-line"><td><a class="source-lineNum" href="#45">45: </a></td><td> <span class="php-var">$replace</span>[<span class="php-num">8</span>] = <span class="php-str">&#039;&lt;img src=&quot;$1&quot; alt=&quot;&quot; class=&quot;img-fluid&quot; /&gt;&#039;</span>;
</td></tr><tr id="46" class="source-line"><td><a class="source-lineNum" href="#46">46: </a></td><td>
</td></tr><tr id="47" class="source-line"><td><a class="source-lineNum" href="#47">47: </a></td><td> <span class="php-comment">// URL</span>
</td></tr><tr id="48" class="source-line"><td><a class="source-lineNum" href="#48">48: </a></td><td> <span class="php-var">$pattern</span>[<span class="php-num">9</span>] = <span class="php-str">&#039;/\[url\](.*?)\[\/url\]/is&#039;</span>;
</td></tr><tr id="49" class="source-line"><td><a class="source-lineNum" href="#49">49: </a></td><td> <span class="php-var">$replace</span>[<span class="php-num">9</span>] = <span class="php-str">&#039;&lt;a href=&quot;$1&quot; rel=&quot;nofollow&quot; target=&quot;_blank&quot;&gt;$1&lt;/a&gt;&#039;</span>;
</td></tr><tr id="50" class="source-line"><td><a class="source-lineNum" href="#50">50: </a></td><td>
</td></tr><tr id="51" class="source-line"><td><a class="source-lineNum" href="#51">51: </a></td><td> <span class="php-comment">// URL (named)</span>
</td></tr><tr id="52" class="source-line"><td><a class="source-lineNum" href="#52">52: </a></td><td> <span class="php-var">$pattern</span>[<span class="php-num">10</span>] = <span class="php-str">&#039;/\[url\=([^\[]+?)\](.*?)\[\/url\]/is&#039;</span>;
</td></tr><tr id="53" class="source-line"><td><a class="source-lineNum" href="#53">53: </a></td><td> <span class="php-var">$replace</span>[<span class="php-num">10</span>] = <span class="php-str">&#039;&lt;a href=&quot;$1&quot; rel=&quot;nofollow&quot; target=&quot;_blank&quot;&gt;$2&lt;/a&gt;&#039;</span>;
</td></tr><tr id="54" class="source-line"><td><a class="source-lineNum" href="#54">54: </a></td><td>
</td></tr><tr id="55" class="source-line"><td><a class="source-lineNum" href="#55">55: </a></td><td> <span class="php-comment">// Font Size</span>
</td></tr><tr id="56" class="source-line"><td><a class="source-lineNum" href="#56">56: </a></td><td> <span class="php-var">$pattern</span>[<span class="php-num">11</span>] = <span class="php-str">&#039;/\[size\=([\-\+]?\d+)\](.*?)\[\/size\]/is&#039;</span>;
</td></tr><tr id="57" class="source-line"><td><a class="source-lineNum" href="#57">57: </a></td><td> <span class="php-var">$replace</span>[<span class="php-num">11</span>] = <span class="php-str">&#039;&lt;span style=&quot;font-size: $1%;&quot;&gt;$2&lt;/span&gt;&#039;</span>;
</td></tr><tr id="58" class="source-line"><td><a class="source-lineNum" href="#58">58: </a></td><td>
</td></tr><tr id="59" class="source-line"><td><a class="source-lineNum" href="#59">59: </a></td><td> <span class="php-comment">// Font Color</span>
</td></tr><tr id="60" class="source-line"><td><a class="source-lineNum" href="#60">60: </a></td><td> <span class="php-var">$pattern</span>[<span class="php-num">12</span>] = <span class="php-str">&#039;/\[color\=(#[0-9a-f]{3}|#[0-9a-f]{6}|[a-z\-]+)\](.*?)\[\/color\]/is&#039;</span>;
</td></tr><tr id="61" class="source-line"><td><a class="source-lineNum" href="#61">61: </a></td><td> <span class="php-var">$replace</span>[<span class="php-num">12</span>] = <span class="php-str">&#039;&lt;span style=&quot;color: $1;&quot;&gt;$2&lt;/span&gt;&#039;</span>;
</td></tr><tr id="62" class="source-line"><td><a class="source-lineNum" href="#62">62: </a></td><td>
</td></tr><tr id="63" class="source-line"><td><a class="source-lineNum" href="#63">63: </a></td><td> <span class="php-comment">// YouTube</span>
</td></tr><tr id="64" class="source-line"><td><a class="source-lineNum" href="#64">64: </a></td><td> <span class="php-var">$pattern</span>[<span class="php-num">13</span>] = <span class="php-str">&#039;/\[youtube\](.*?)\[\/youtube\]/is&#039;</span>;
</td></tr><tr id="65" class="source-line"><td><a class="source-lineNum" href="#65">65: </a></td><td> <span class="php-var">$replace</span>[<span class="php-num">13</span>] = <span class="php-str">&#039;&lt;iframe width=&quot;560&quot; height=&quot;315&quot; src=&quot;http://www.youtube.com/embed/$1&quot; allowfullscreen&gt;&lt;/iframe&gt;&#039;</span>;
</td></tr><tr id="66" class="source-line"><td><a class="source-lineNum" href="#66">66: </a></td><td>
</td></tr><tr id="67" class="source-line"><td><a class="source-lineNum" href="#67">67: </a></td><td> <span class="php-kw">return</span> preg_replace(<span class="php-var">$pattern</span>, <span class="php-var">$replace</span>, <span class="php-var">$string</span>);
</td></tr><tr id="68" class="source-line"><td><a class="source-lineNum" href="#68">68: </a></td><td>}
</td></tr><tr id="69" class="source-line"><td><a class="source-lineNum" href="#69">69: </a></td><td></td></tr></table>
</div>
<div class="layout-footer">
OpenCart API API documentation generated by <a href="https://www.apigen.org">ApiGen dev-master</a>
</div>
</div>
<div class="layout-rest">
<div class="navbar"></div>
</div>
</body>
</html>