<!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>[5935] sites/trunk/api.wordpress.org/public_html/core/browse-happy/1.0: Browse Happy API: Add missing docblocks and improve the existing ones.</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://meta.trac.wordpress.org/changeset/5935">5935</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"http://meta.trac.wordpress.org/changeset/5935","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>coffee2code</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2017-09-18 20:21:04 +0000 (Mon, 18 Sep 2017)</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'>Browse Happy API: Add missing docblocks and improve the existing ones.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#sitestrunkapiwordpressorgpublic_htmlcorebrowsehappy10browsersphp">sites/trunk/api.wordpress.org/public_html/core/browse-happy/1.0/browsers.php</a></li>
<li><a href="#sitestrunkapiwordpressorgpublic_htmlcorebrowsehappy10indexphp">sites/trunk/api.wordpress.org/public_html/core/browse-happy/1.0/index.php</a></li>
<li><a href="#sitestrunkapiwordpressorgpublic_htmlcorebrowsehappy10parsephp">sites/trunk/api.wordpress.org/public_html/core/browse-happy/1.0/parse.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="sitestrunkapiwordpressorgpublic_htmlcorebrowsehappy10browsersphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: sites/trunk/api.wordpress.org/public_html/core/browse-happy/1.0/browsers.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- sites/trunk/api.wordpress.org/public_html/core/browse-happy/1.0/browsers.php 2017-09-18 19:53:25 UTC (rev 5934)
+++ sites/trunk/api.wordpress.org/public_html/core/browse-happy/1.0/browsers.php 2017-09-18 20:21:04 UTC (rev 5935)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -7,10 +7,13 @@
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Browser current version numbers.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Returns current version numbers for all browsers.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * These are for major release branches, not full build numbers.
</span><span class="cx" style="display: block; padding: 0 10px"> * Firefox 3.6, 4, etc., not Chrome 11.0.696.65.
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ *
+ * @return array Associative array of browser names with their respective
+ * current (or somewhat current) version number.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function get_browser_current_versions() {
</span><span class="cx" style="display: block; padding: 0 10px"> return array(
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -22,6 +25,23 @@
</span><span class="cx" style="display: block; padding: 0 10px"> );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+/**
+ * Returns browser data for a given browser.
+ *
+ * @param string|false $browser The name of the browser. Default false.
+ * @return false|array {
+ * Array of data about the browser. False if the browser is unknown.
+ *
+ * @type string $name Name of the browser.
+ * @type string $wikipedia Wikipedia name for the browser.
+ * @type int|float $normalized How should browser version number be
+ * normalized? 1 == just first number, else
+ * include second number (i.e. decimal value)
+ * @type string $url The home URL for the browser.
+ * @type string $img_src The non-HTTPs URL for the browser's logo image.
+ * @type string $img_src_ssl The HTTPS URL for the browser's logo image.
+ * }
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> function browsehappy_api_get_browser_data( $browser = false ) {
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $http = 'http://s.wordpress.org/images/browsers/';
</span></span></pre></div>
<a id="sitestrunkapiwordpressorgpublic_htmlcorebrowsehappy10indexphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: sites/trunk/api.wordpress.org/public_html/core/browse-happy/1.0/index.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- sites/trunk/api.wordpress.org/public_html/core/browse-happy/1.0/index.php 2017-09-18 19:53:25 UTC (rev 5934)
+++ sites/trunk/api.wordpress.org/public_html/core/browse-happy/1.0/index.php 2017-09-18 20:21:04 UTC (rev 5935)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -32,6 +32,12 @@
</span><span class="cx" style="display: block; padding: 0 10px"> echo serialize( $data );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+/**
+ * Logs anonymized user-agent data.
+ *
+ * @param string $ua The user-agent string.
+ * @param array $data Parsed user-agent data.
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> function bh_record_data( $ua, $data ) {
</span><span class="cx" style="display: block; padding: 0 10px"> global $wpdb;
</span><span class="cx" style="display: block; padding: 0 10px">
</span></span></pre></div>
<a id="sitestrunkapiwordpressorgpublic_htmlcorebrowsehappy10parsephp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: sites/trunk/api.wordpress.org/public_html/core/browse-happy/1.0/parse.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- sites/trunk/api.wordpress.org/public_html/core/browse-happy/1.0/parse.php 2017-09-18 19:53:25 UTC (rev 5934)
+++ sites/trunk/api.wordpress.org/public_html/core/browse-happy/1.0/parse.php 2017-09-18 20:21:04 UTC (rev 5935)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -6,12 +6,23 @@
</span><span class="cx" style="display: block; padding: 0 10px"> require dirname( __FILE__ ) . '/browsers.php';
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-* Parses a user agent string into its important parts
-*
-* @param string $user_agent
-*
-* @return array containing platform, name, and version
-*/
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Parses a user agent string into its important parts.
+ *
+ * @param string $user_agent The user agent string for a browser.
+ * @return array {
+ * Array containing data based on the parsing of the user agent.
+ *
+ * @type string $platform The platform running the browser.
+ * @type string $name The name of the browser.
+ * @type string $version The reported version of the browser.
+ * @type string $update_url The URL to obtain the update for the browser.
+ * @type string $img_src The non-HTTPS URL for the browser's logo image.
+ * @type string $img_src_ssl The HTTPS URL for the browser's logo image.
+ * @type string $current_version The current latest version of the browser.
+ * @type bool $upgrade Is there an update available for the browser?
+ * @type bool $insecure Is the browser insecure?
+ * }
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> function browsehappy_parse_user_agent( $user_agent ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $data = array();
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -103,6 +114,13 @@
</span><span class="cx" style="display: block; padding: 0 10px"> return $data;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+/**
+ * Returns the current version for the given browser.
+ *
+ * @param string $name The name of the browser.
+ * @return string The version for the browser or an empty string if an
+ * unknown browser.
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> function get_browser_version_from_name( $name ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $versions = get_browser_current_versions();
</span><span class="cx" style="display: block; padding: 0 10px">
</span></span></pre>
</div>
</div>
</body>
</html>