Aliyun_Sls_Util.html 13.7 KB
<!DOCTYPE html><html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="viewport" content="width=device-width; initial-scale=1.0; maximum-scale=1.0; user-scalable=0;">
<meta charset="utf-8">
<title>SLS_PHP_SDK » \Aliyun_Log_Util</title>
<meta name="author" content="Mike van Riel">
<meta name="description" content="">
<link href="../css/template.css" rel="stylesheet" media="all">
<script src="../js/jquery-1.7.1.min.js" type="text/javascript"></script><script src="../js/jquery-ui-1.8.2.custom.min.js" type="text/javascript"></script><script src="../js/jquery.mousewheel.min.js" type="text/javascript"></script><script src="../js/bootstrap.js" type="text/javascript"></script><script src="../js/template.js" type="text/javascript"></script><script src="../js/prettify/prettify.min.js" type="text/javascript"></script><link rel="shortcut icon" href="../img/favicon.ico">
<link rel="apple-touch-icon" href="../img/apple-touch-icon.png">
<link rel="apple-touch-icon" sizes="72x72" href="../img/apple-touch-icon-72x72.png">
<link rel="apple-touch-icon" sizes="114x114" href="../img/apple-touch-icon-114x114.png">
</head>
<body>
<div class="navbar navbar-fixed-top">
<div class="navbar-inner"><div class="container">
<a class="btn btn-navbar" data-toggle="collapse" data-target=".nav-collapse"><span class="icon-bar"></span><span class="icon-bar"></span><span class="icon-bar"></span></a><a class="brand" href="../index.html">SLS_PHP_SDK</a><div class="nav-collapse"><ul class="nav">
<li class="dropdown">
<a href="#api" class="dropdown-toggle" data-toggle="dropdown">
                                    API Documentation <b class="caret"></b></a><ul class="dropdown-menu">
<li><a>Packages</a></li>
<li><a href="../packages/SLS_PHP_SDK.html"><i class="icon-folder-open"></i> SLS_PHP_SDK</a></li>
</ul>
</li>
<li class="dropdown" id="charts-menu">
<a href="#charts" class="dropdown-toggle" data-toggle="dropdown">
                                    Charts <b class="caret"></b></a><ul class="dropdown-menu"><li><a href="../graph_class.html"><i class="icon-list-alt"></i> Class hierarchy diagram</a></li></ul>
</li>
<li class="dropdown" id="reports-menu">
<a href="#reports" class="dropdown-toggle" data-toggle="dropdown">
                                    Reports <b class="caret"></b></a><ul class="dropdown-menu">
<li><a href="../errors.html"><i class="icon-remove-sign"></i> Errors 
                <span class="label label-info">290</span></a></li>
<li><a href="../markers.html"><i class="icon-map-marker"></i> Markers 
                <ul></ul></a></li>
<li><a href="../deprecated.html"><i class="icon-stop"></i> Deprecated elements 
                <span class="label label-info">0</span></a></li>
</ul>
</li>
</ul></div>
</div></div>
<div class="go_to_top"><a href="#___" style="color: inherit">Back to top  <i class="icon-upload icon-white"></i></a></div>
</div>
<div id="___" class="container">
<noscript><div class="alert alert-warning">
                            Javascript is disabled; several features are only available
                            if Javascript is enabled.
                        </div></noscript>
<div class="row">
<div class="span4">
<div xmlns:php="http://php.net/xsl" class="btn-toolbar">
<div class="btn-group visibility" data-toggle="buttons-checkbox">
<button class="btn public active" title="Show public elements">Public</button><button class="btn protected" title="Show protected elements">Protected</button><button class="btn private" title="Show private elements">Private</button><button class="btn inherited active" title="Show inherited elements">Inherited</button>
</div>
<div class="btn-group view pull-right" data-toggle="buttons-radio">
<button class="btn details" title="Show descriptions and method names"><i class="icon-list"></i></button><button class="btn simple" title="Show only method names"><i class="icon-align-justify"></i></button>
</div>
</div>
<ul xmlns:php="http://php.net/xsl" class="side-nav nav nav-list"><li class="nav-header">
<i title="Methods" class="icon-custom icon-method"></i> Methods
                    <ul>
<li class="method public "><a href="#method_calMD5" title="calMD5() :: Calculate string $value MD5."><span class="description">Calculate string $value MD5.</span><pre>calMD5()</pre></a></li>
<li class="method public "><a href="#method_canonicalizedResource" title="canonicalizedResource() :: Get canonicalizedResource string as defined."><span class="description">Get canonicalizedResource string as defined.</span><pre>canonicalizedResource()</pre></a></li>
<li class="method public "><a href="#method_canonicalizedSLSHeaders" title="canonicalizedSLSHeaders() :: Get canonicalizedSLSHeaders string as defined."><span class="description">Get canonicalizedSLSHeaders string as defined.</span><pre>canonicalizedSLSHeaders()</pre></a></li>
<li class="method public "><a href="#method_getLocalIp" title="getLocalIp() :: Get the local machine ip address."><span class="description">Get the local machine ip address.</span><pre>getLocalIp()</pre></a></li>
<li class="method public "><a href="#method_getRequestAuthorization" title="getRequestAuthorization() :: Get request authorization string as defined."><span class="description">Get request authorization string as defined.</span><pre>getRequestAuthorization()</pre></a></li>
<li class="method public "><a href="#method_hmacSHA1" title="hmacSHA1() :: Calculate string $content hmacSHA1 with secret key $key."><span class="description">Calculate string $content hmacSHA1 with secret key $key.</span><pre>hmacSHA1()</pre></a></li>
<li class="method public "><a href="#method_isIp" title="isIp() :: If $gonten is raw IP address, return true."><span class="description">If $gonten is raw IP address, return true.</span><pre>isIp()</pre></a></li>
<li class="method public "><a href="#method_toBytes" title="toBytes() :: Change $logGroup to bytes."><span class="description">Change $logGroup to bytes.</span><pre>toBytes()</pre></a></li>
<li class="method public "><a href="#method_urlEncode" title="urlEncode() :: Get url encode."><span class="description">Get url encode.</span><pre>urlEncode()</pre></a></li>
<li class="method public "><a href="#method_urlEncodeValue" title="urlEncodeValue() :: Get url encode."><span class="description">Get url encode.</span><pre>urlEncodeValue()</pre></a></li>
</ul>
</li></ul>
</div>
<div class="span8">
<a xmlns:php="http://php.net/xsl" id="\Aliyun_Log_Util"></a><ul xmlns:php="http://php.net/xsl" class="breadcrumb">
<li>
<a href="../index.html"><i title="Classes" class="icon-custom icon-class"></i></a><span class="divider">\</span>
</li>
<li class="active">
<span class="divider">\</span><a href="../classes/Aliyun_Log_Util.html">Aliyun_Log_Util</a>
</li>
</ul>
<div xmlns:php="http://php.net/xsl" class="element class">
<p class="short_description">Copyright (C) Alibaba Cloud Computing
All rights reserved</p>
<div class="details">
<div class="long_description"></div>
<table class="table table-bordered"><tr>
<th>package</th>
<td><a href="../packages/SLS_PHP_SDK.html">SLS_PHP_SDK</a></td>
</tr></table>
<h3>
<i title="Methods" class="icon-custom icon-method"></i> Methods</h3>
<a id="method_calMD5"></a><div class="element clickable method public method_calMD5 " data-toggle="collapse" data-target=".method_calMD5 .collapse" title="public">
<h2>Calculate string $value MD5.</h2>
<pre>calMD5($value) : string</pre>
<div class="labels"><span class="label">Static</span></div>
<div class="row collapse"><div class="detail-description">
<div class="long_description"></div>
<h3>Parameters</h3>
<div class="subelement argument"><h4>$value</h4></div>
<h3>Returns</h3>
<div class="subelement response"><code>string</code></div>
</div></div>
</div>
<a id="method_canonicalizedResource"></a><div class="element clickable method public method_canonicalizedResource " data-toggle="collapse" data-target=".method_canonicalizedResource .collapse" title="public">
<h2>Get canonicalizedResource string as defined.</h2>
<pre>canonicalizedResource($resource, $params) : string</pre>
<div class="labels"><span class="label">Static</span></div>
<div class="row collapse"><div class="detail-description">
<div class="long_description"></div>
<h3>Parameters</h3>
<div class="subelement argument"><h4>$resource</h4></div>
<div class="subelement argument"><h4>$params</h4></div>
<h3>Returns</h3>
<div class="subelement response"><code>string</code></div>
</div></div>
</div>
<a id="method_canonicalizedSLSHeaders"></a><div class="element clickable method public method_canonicalizedSLSHeaders " data-toggle="collapse" data-target=".method_canonicalizedSLSHeaders .collapse" title="public">
<h2>Get canonicalizedSLSHeaders string as defined.</h2>
<pre>canonicalizedSLSHeaders($header) : string</pre>
<div class="labels"><span class="label">Static</span></div>
<div class="row collapse"><div class="detail-description">
<div class="long_description"></div>
<h3>Parameters</h3>
<div class="subelement argument"><h4>$header</h4></div>
<h3>Returns</h3>
<div class="subelement response"><code>string</code></div>
</div></div>
</div>
<a id="method_getLocalIp"></a><div class="element clickable method public method_getLocalIp " data-toggle="collapse" data-target=".method_getLocalIp .collapse" title="public">
<h2>Get the local machine ip address.</h2>
<pre>getLocalIp() : string</pre>
<div class="labels"><span class="label">Static</span></div>
<div class="row collapse"><div class="detail-description">
<div class="long_description"></div>
<h3>Returns</h3>
<div class="subelement response"><code>string</code></div>
</div></div>
</div>
<a id="method_getRequestAuthorization"></a><div class="element clickable method public method_getRequestAuthorization " data-toggle="collapse" data-target=".method_getRequestAuthorization .collapse" title="public">
<h2>Get request authorization string as defined.</h2>
<pre>getRequestAuthorization($method, $resource, $key, $params, $headers) : string</pre>
<div class="labels"><span class="label">Static</span></div>
<div class="row collapse"><div class="detail-description">
<div class="long_description"></div>
<h3>Parameters</h3>
<div class="subelement argument"><h4>$method</h4></div>
<div class="subelement argument"><h4>$resource</h4></div>
<div class="subelement argument"><h4>$key</h4></div>
<div class="subelement argument"><h4>$params</h4></div>
<div class="subelement argument"><h4>$headers</h4></div>
<h3>Returns</h3>
<div class="subelement response"><code>string</code></div>
</div></div>
</div>
<a id="method_hmacSHA1"></a><div class="element clickable method public method_hmacSHA1 " data-toggle="collapse" data-target=".method_hmacSHA1 .collapse" title="public">
<h2>Calculate string $content hmacSHA1 with secret key $key.</h2>
<pre>hmacSHA1($content, $key) : string</pre>
<div class="labels"><span class="label">Static</span></div>
<div class="row collapse"><div class="detail-description">
<div class="long_description"></div>
<h3>Parameters</h3>
<div class="subelement argument"><h4>$content</h4></div>
<div class="subelement argument"><h4>$key</h4></div>
<h3>Returns</h3>
<div class="subelement response"><code>string</code></div>
</div></div>
</div>
<a id="method_isIp"></a><div class="element clickable method public method_isIp " data-toggle="collapse" data-target=".method_isIp .collapse" title="public">
<h2>If $gonten is raw IP address, return true.</h2>
<pre>isIp($gonten) : boolean</pre>
<div class="labels"><span class="label">Static</span></div>
<div class="row collapse"><div class="detail-description">
<div class="long_description"></div>
<h3>Parameters</h3>
<div class="subelement argument"><h4>$gonten</h4></div>
<h3>Returns</h3>
<div class="subelement response"><code>boolean</code></div>
</div></div>
</div>
<a id="method_toBytes"></a><div class="element clickable method public method_toBytes " data-toggle="collapse" data-target=".method_toBytes .collapse" title="public">
<h2>Change $logGroup to bytes.</h2>
<pre>toBytes($logGroup) : string</pre>
<div class="labels"><span class="label">Static</span></div>
<div class="row collapse"><div class="detail-description">
<div class="long_description"></div>
<h3>Parameters</h3>
<div class="subelement argument"><h4>$logGroup</h4></div>
<h3>Returns</h3>
<div class="subelement response"><code>string</code></div>
</div></div>
</div>
<a id="method_urlEncode"></a><div class="element clickable method public method_urlEncode " data-toggle="collapse" data-target=".method_urlEncode .collapse" title="public">
<h2>Get url encode.</h2>
<pre>urlEncode($params) : string</pre>
<div class="labels"><span class="label">Static</span></div>
<div class="row collapse"><div class="detail-description">
<div class="long_description"></div>
<h3>Parameters</h3>
<div class="subelement argument"><h4>$params</h4></div>
<h3>Returns</h3>
<div class="subelement response"><code>string</code></div>
</div></div>
</div>
<a id="method_urlEncodeValue"></a><div class="element clickable method public method_urlEncodeValue " data-toggle="collapse" data-target=".method_urlEncodeValue .collapse" title="public">
<h2>Get url encode.</h2>
<pre>urlEncodeValue($value) : string</pre>
<div class="labels"><span class="label">Static</span></div>
<div class="row collapse"><div class="detail-description">
<div class="long_description"></div>
<h3>Parameters</h3>
<div class="subelement argument"><h4>$value</h4></div>
<h3>Returns</h3>
<div class="subelement response"><code>string</code></div>
</div></div>
</div>
</div>
</div>
</div>
</div>
<div class="row"><footer class="span12">
            Template is built using <a href="http://twitter.github.com/bootstrap/">Twitter Bootstrap 2</a> and icons provided by <a href="http://glyphicons.com/">Glyphicons</a>.<br>
            Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor v2.8.0-3-gd2074ac</a> and<br>
            generated on 2015-01-26T01:53:31-08:00.<br></footer></div>
</div>
</body>
</html>