<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[BuddyPress][10491] trunk/src/bp-core: Emails: move static token replacement function into its own function.</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta" style="font-size: 105%">
<dt style="float: left; width: 6em; font-weight: bold">Revision</dt> <dd><a style="font-weight: bold" href="http://buddypress.trac.wordpress.org/changeset/10491">10491</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"http://buddypress.trac.wordpress.org/changeset/10491","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>djpaul</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2016-02-01 19:44:36 +0000 (Mon, 01 Feb 2016)</dd>
</dl>
<pre style='padding-left: 1em; margin: 2em 0; border-left: 2px solid #ccc; line-height: 1.25; font-size: 105%; font-family: sans-serif'>Emails: move static token replacement function into its own function.
The token replacement, while intended for `BP_Email`, in theory could be used anywhere else, and having a common function would allow consistent filtering.
It also helps by reducing the amount of code in the `BP_Email` class, and therefore overall complexity.
See <a href="http://buddypress.trac.wordpress.org/ticket/6592">#6592</a></pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcbpcorebpcorefunctionsphp">trunk/src/bp-core/bp-core-functions.php</a></li>
<li><a href="#trunksrcbpcoreclassesclassbpemailphp">trunk/src/bp-core/classes/class-bp-email.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcbpcorebpcorefunctionsphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/bp-core/bp-core-functions.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/bp-core/bp-core-functions.php 2016-02-01 19:25:42 UTC (rev 10490)
+++ trunk/src/bp-core/bp-core-functions.php 2016-02-01 19:44:36 UTC (rev 10491)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -3047,3 +3047,46 @@
</span><span class="cx" style="display: block; padding: 0 10px"> "assets/emails/{$single}.php",
</span><span class="cx" style="display: block; padding: 0 10px"> ), $object );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+/**
+ * Replace all tokens in the input text with appropriate values.
+ *
+ * Intended for use with the email system introduced in BuddyPress 2.5.0.
+ *
+ * @since 2.5.0
+ *
+ * @param string $text
+ * @param array $tokens Token names and replacement values for the $text.
+ * @return string
+ */
+function bp_core_replace_tokens_in_text( $text, $tokens ) {
+ $unescaped = array();
+ $escaped = array();
+
+ foreach ( $tokens as $token => $value ) {
+ if ( is_callable( $value ) ) {
+ $value = call_user_func( $value );
+ }
+
+ // Tokens could be objects or arrays.
+ if ( ! is_scalar( $value ) ) {
+ continue;
+ }
+
+ $unescaped[ '{{{' . $token . '}}}' ] = $value;
+ $escaped[ '{{' . $token . '}}' ] = esc_html( $value );
+ }
+
+ $text = strtr( $text, $unescaped ); // Do first.
+ $text = strtr( $text, $escaped );
+
+ /**
+ * Filters text that has had tokens replaced.
+ *
+ * @since 2.5.0
+ *
+ * @param string $text
+ * @param array $tokens Token names and replacement values for the $text.
+ */
+ return apply_filters( 'bp_core_replace_tokens_in_text', $text, $tokens );
+}
</ins></span></pre></div>
<a id="trunksrcbpcoreclassesclassbpemailphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/bp-core/classes/class-bp-email.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/bp-core/classes/class-bp-email.php 2016-02-01 19:25:42 UTC (rev 10490)
+++ trunk/src/bp-core/classes/class-bp-email.php 2016-02-01 19:44:36 UTC (rev 10491)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -243,7 +243,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> // Fall through.
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> case 'replace-tokens':
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $retval = self::replace_tokens( $retval, $this->get_tokens( 'raw' ) );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $retval = bp_core_replace_tokens_in_text( $retval, $this->get_tokens( 'raw' ) );
</ins><span class="cx" style="display: block; padding: 0 10px"> // Fall through.
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> case 'raw':
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -948,54 +948,4 @@
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> return apply_filters( 'bp_email_validate', $retval, $this );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-
-
- /*
- * Utility functions.
- *
- * Unlike other methods in this class, utility functions are not chainable.
- */
-
- /**
- * Replace all tokens in the input with appropriate values.
- *
- * Unlike most other methods in this class, this one is not chainable.
- *
- * @since 2.5.0
- *
- * @param string $text
- * @param array $tokens Token names and replacement values for the $text.
- * @return string
- */
- public static function replace_tokens( $text, $tokens ) {
- $unescaped = array();
- $escaped = array();
-
- foreach ( $tokens as $token => $value ) {
- if ( is_callable( $value ) ) {
- $value = call_user_func( $value );
- }
-
- // Some tokens are objects or arrays for backwards compatibilty. See bp_core_deprecated_email_filters().
- if ( ! is_scalar( $value ) ) {
- continue;
- }
-
- $unescaped[ '{{{' . $token . '}}}' ] = $value;
- $escaped[ '{{' . $token . '}}' ] = esc_html( $value );
- }
-
- $text = strtr( $text, $unescaped ); // Do first.
- $text = strtr( $text, $escaped );
-
- /**
- * Filters text that has had tokens replaced.
- *
- * @since 2.5.0
- *
- * @param string $text
- * @param array $tokens Token names and replacement values for the $text.
- */
- return apply_filters( 'bp_email_replace_tokens', $text, $tokens );
- }
</del><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre>
</div>
</div>
</body>
</html>