GravityKit/codex
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Folders and files
| Name | Name | Last commit message | Last commit date | |
|---|---|---|---|---|
Sorry, we had to truncate this directory to 1,000 files. 882 entries were omitted from the list. | ||||
Repository files navigation
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml"> <head> <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> <meta http-equiv="X-UA-Compatible" content="IE=9"/> <meta name="generator" content="Doxygen 1.8.13"/> <meta name="viewport" content="width=device-width, initial-scale=1"/> <title>GravityView: EDD Class Reference</title> <link href="tabs.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="jquery.js"></script> <script type="text/javascript" src="dynsections.js"></script> <link href="search/search.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="search/searchdata.js"></script> <script type="text/javascript" src="search/search.js"></script> <link href="doxygen.css" rel="stylesheet" type="text/css" /> <link href="custom-doxygen.css" rel="stylesheet" type="text/css"/> </head> <body> <div id="top"><!-- do not remove this div, it is closed by doxygen! --> <div id="titlearea"> <table cellspacing="0" cellpadding="0"> <tbody> <tr style="height: 56px;"> <td id="projectlogo"><img alt="Logo" src="logo.png"/></td> <td id="projectalign" style="padding-left: 0.5em;"> <div id="projectname">GravityView  <span id="projectnumber">2.17</span> </div> <div id="projectbrief">The best, easiest way to display Gravity Forms entries on your website.</div> </td> </tr> </tbody> </table> </div> <!-- end header part --> <!-- Generated by Doxygen 1.8.13 --> <script type="text/javascript"> var searchBox = new SearchBox("searchBox", "search",false,'Search'); </script> <script type="text/javascript" src="menudata.js"></script> <script type="text/javascript" src="menu.js"></script> <script type="text/javascript"> $(function() { initMenu('',true,false,'search.php','Search'); $(document).ready(function() { init_search(); }); }); </script> <div id="main-nav"></div> <!-- window showing the filter options --> <div id="MSearchSelectWindow" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()" onkeydown="return searchBox.OnSearchSelectKey(event)"> </div> <!-- iframe showing the search results (closed by default) --> <div id="MSearchResultsWindow"> <iframe src="javascript:void(0)" frameborder="0" name="MSearchResults" id="MSearchResults"> </iframe> </div> <div id="nav-path" class="navpath"> <ul> <li class="navelem"><a class="el" href="namespace_gravity_kit.html">GravityKit</a></li><li class="navelem"><a class="el" href="namespace_gravity_kit_1_1_gravity_view.html">GravityView</a></li><li class="navelem"><a class="el" href="namespace_gravity_kit_1_1_gravity_view_1_1_foundation.html">Foundation</a></li><li class="navelem"><a class="el" href="namespace_gravity_kit_1_1_gravity_view_1_1_foundation_1_1_licenses.html">Licenses</a></li><li class="navelem"><a class="el" href="class_gravity_kit_1_1_gravity_view_1_1_foundation_1_1_licenses_1_1_e_d_d.html">EDD</a></li> </ul> </div> </div><!-- top --> <div class="header"> <div class="summary"> <a href="#pub-methods">Public Member Functions</a> | <a href="#pub-static-methods">Static Public Member Functions</a> | <a href="#pri-static-attribs">Static Private Attributes</a> </div> <div class="headertitle"> <div class="title">EDD Class Reference</div> </div> </div><!--header--> <div class="contents"> <table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a> Public Member Functions</h2></td></tr> <tr class="memitem:a32d6a992827979c06075f7c7c817406a"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_gravity_kit_1_1_gravity_view_1_1_foundation_1_1_licenses_1_1_e_d_d.html#a32d6a992827979c06075f7c7c817406a">check_for_product_updates</a> ( $transient_data, $skip_cache=false)</td></tr> <tr class="memdesc:a32d6a992827979c06075f7c7c817406a"><td class="mdescLeft"> </td><td class="mdescRight">Checks for product updates and modifies the 'update_plugins' transient. <a href="#a32d6a992827979c06075f7c7c817406a">More...</a><br /></td></tr> <tr class="separator:a32d6a992827979c06075f7c7c817406a"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:adf1829a60ee2ef5177ab9945c9928839"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_gravity_kit_1_1_gravity_view_1_1_foundation_1_1_licenses_1_1_e_d_d.html#adf1829a60ee2ef5177ab9945c9928839">disable_legacy_edd_updater</a> ()</td></tr> <tr class="memdesc:adf1829a60ee2ef5177ab9945c9928839"><td class="mdescLeft"> </td><td class="mdescRight">Disables <a class="el" href="class_gravity_kit_1_1_gravity_view_1_1_foundation_1_1_licenses_1_1_e_d_d.html">EDD</a> updater that's included with <a class="el" href="namespace_gravity_kit.html">GravityKit</a> products. <a href="#adf1829a60ee2ef5177ab9945c9928839">More...</a><br /></td></tr> <tr class="separator:adf1829a60ee2ef5177ab9945c9928839"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:adc599e7c17d795fbfb089f0c6dc89fcd"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_gravity_kit_1_1_gravity_view_1_1_foundation_1_1_licenses_1_1_e_d_d.html#adc599e7c17d795fbfb089f0c6dc89fcd">display_product_information</a> ( $result, $action, $args)</td></tr> <tr class="memdesc:adc599e7c17d795fbfb089f0c6dc89fcd"><td class="mdescLeft"> </td><td class="mdescRight">Returns product information for display on the Plugins page. <a href="#adc599e7c17d795fbfb089f0c6dc89fcd">More...</a><br /></td></tr> <tr class="separator:adc599e7c17d795fbfb089f0c6dc89fcd"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a2c66e849a9328f6fa7fcdc84e01a5453"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_gravity_kit_1_1_gravity_view_1_1_foundation_1_1_licenses_1_1_e_d_d.html#a2c66e849a9328f6fa7fcdc84e01a5453">format_product_data</a> ( $product)</td></tr> <tr class="memdesc:a2c66e849a9328f6fa7fcdc84e01a5453"><td class="mdescLeft"> </td><td class="mdescRight">Returns a product object formatted according to what <a class="el" href="namespace_gravity_kit_1_1_gravity_view_1_1_foundation_1_1_licenses_1_1_w_p.html" title="GPL-2.0-or-later ">WP</a> expects in order to display changelog/store plugin update data. <a href="#a2c66e849a9328f6fa7fcdc84e01a5453">More...</a><br /></td></tr> <tr class="separator:a2c66e849a9328f6fa7fcdc84e01a5453"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a4be4055f3361d4800e16bc2e2e38cda6"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_gravity_kit_1_1_gravity_view_1_1_foundation_1_1_licenses_1_1_e_d_d.html#a4be4055f3361d4800e16bc2e2e38cda6">init</a> ()</td></tr> <tr class="memdesc:a4be4055f3361d4800e16bc2e2e38cda6"><td class="mdescLeft"> </td><td class="mdescRight">Initializes the class. <a href="#a4be4055f3361d4800e16bc2e2e38cda6">More...</a><br /></td></tr> <tr class="separator:a4be4055f3361d4800e16bc2e2e38cda6"><td class="memSeparator" colspan="2"> </td></tr> </table><table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a> Static Public Member Functions</h2></td></tr> <tr class="memitem:aeeb76432d095288ac056df22cca56d16"><td class="memItemLeft" align="right" valign="top">static </td><td class="memItemRight" valign="bottom"><a class="el" href="class_gravity_kit_1_1_gravity_view_1_1_foundation_1_1_licenses_1_1_e_d_d.html#aeeb76432d095288ac056df22cca56d16">get_instance</a> ()</td></tr> <tr class="memdesc:aeeb76432d095288ac056df22cca56d16"><td class="mdescLeft"> </td><td class="mdescRight">Returns class instance. <a href="#aeeb76432d095288ac056df22cca56d16">More...</a><br /></td></tr> <tr class="separator:aeeb76432d095288ac056df22cca56d16"><td class="memSeparator" colspan="2"> </td></tr> </table><table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pri-static-attribs"></a> Static Private Attributes</h2></td></tr> <tr class="memitem:ac350be23da328a6f5429313efc9b96e4"><td class="memItemLeft" align="right" valign="top">static </td><td class="memItemRight" valign="bottom"><a class="el" href="class_gravity_kit_1_1_gravity_view_1_1_foundation_1_1_licenses_1_1_e_d_d.html#ac350be23da328a6f5429313efc9b96e4">$_instance</a></td></tr> <tr class="separator:ac350be23da328a6f5429313efc9b96e4"><td class="memSeparator" colspan="2"> </td></tr> </table> <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> <div class="textblock"> <p class="definition">Definition at line <a class="el" href="_e_d_d_8php_source.html#l00015">15</a> of file <a class="el" href="_e_d_d_8php_source.html">EDD.php</a>.</p> </div><h2 class="groupheader">Member Function Documentation</h2> <a id="a32d6a992827979c06075f7c7c817406a"></a> <h2 class="memtitle"><span class="permalink"><a href="#a32d6a992827979c06075f7c7c817406a">◆ </a></span>check_for_product_updates()</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">check_for_product_updates </td> <td>(</td> <td class="paramtype"> </td> <td class="paramname"><em>$transient_data</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype"> </td> <td class="paramname"><em>$skip_cache</em> = <code>false</code> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div><div class="memdoc"> <p>Checks for product updates and modifies the 'update_plugins' transient. </p> <dl class="section since"><dt>Since</dt><dd>1.0.0</dd></dl> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramtype">object</td><td class="paramname">$transient_data</td><td></td></tr> <tr><td class="paramtype">bool</td><td class="paramname">$skip_cache</td><td>(optional) Whether to skip cache when getting products data. Default: false.</td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd>object </dd></dl> <p class="definition">Definition at line <a class="el" href="_e_d_d_8php_source.html#l00110">110</a> of file <a class="el" href="_e_d_d_8php_source.html">EDD.php</a>.</p> <p class="reference">References <a class="el" href="_e_d_d_8php_source.html#l00164">EDD\format_product_data()</a>, <a class="el" href="_arr_8php_source.html#l00099">Arr\get()</a>, and <a class="el" href="_product_manager_8php_source.html#l00041">ProductManager\get_instance()</a>.</p> </div> </div> <a id="adf1829a60ee2ef5177ab9945c9928839"></a> <h2 class="memtitle"><span class="permalink"><a href="#adf1829a60ee2ef5177ab9945c9928839">◆ </a></span>disable_legacy_edd_updater()</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">disable_legacy_edd_updater </td> <td>(</td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p>Disables <a class="el" href="class_gravity_kit_1_1_gravity_view_1_1_foundation_1_1_licenses_1_1_e_d_d.html">EDD</a> updater that's included with <a class="el" href="namespace_gravity_kit.html">GravityKit</a> products. </p> <dl class="section since"><dt>Since</dt><dd>1.0.0</dd></dl> <dl class="section return"><dt>Returns</dt><dd>void </dd></dl> <p class="definition">Definition at line <a class="el" href="_e_d_d_8php_source.html#l00058">58</a> of file <a class="el" href="_e_d_d_8php_source.html">EDD.php</a>.</p> </div> </div> <a id="adc599e7c17d795fbfb089f0c6dc89fcd"></a> <h2 class="memtitle"><span class="permalink"><a href="#adc599e7c17d795fbfb089f0c6dc89fcd">◆ </a></span>display_product_information()</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">display_product_information </td> <td>(</td> <td class="paramtype"> </td> <td class="paramname"><em>$result</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype"> </td> <td class="paramname"><em>$action</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype"> </td> <td class="paramname"><em>$args</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div><div class="memdoc"> <p>Returns product information for display on the Plugins page. </p> <p>This short-circuits the WordPress.org API request by returning product information from the <a class="el" href="class_gravity_kit_1_1_gravity_view_1_1_foundation_1_1_licenses_1_1_e_d_d.html">EDD</a> API that we store in the database.</p> <dl class="section since"><dt>Since</dt><dd>1.0.0</dd></dl> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramtype">false | object | array</td><td class="paramname">$result</td><td>Product information. </td></tr> <tr><td class="paramtype">string</td><td class="paramname">$action</td><td>Plugin Installation API action. </td></tr> <tr><td class="paramtype">object</td><td class="paramname">$args</td><td>Request arguments.</td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd>false|object|array </dd></dl> <p class="definition">Definition at line <a class="el" href="_e_d_d_8php_source.html#l00218">218</a> of file <a class="el" href="_e_d_d_8php_source.html">EDD.php</a>.</p> <p class="reference">References <a class="el" href="search-field-submit_8php_source.html#l00015">$args</a>, <a class="el" href="_e_d_d_8php_source.html#l00164">EDD\format_product_data()</a>, <a class="el" href="_arr_8php_source.html#l00099">Arr\get()</a>, and <a class="el" href="_product_manager_8php_source.html#l00041">ProductManager\get_instance()</a>.</p> </div> </div> <a id="a2c66e849a9328f6fa7fcdc84e01a5453"></a> <h2 class="memtitle"><span class="permalink"><a href="#a2c66e849a9328f6fa7fcdc84e01a5453">◆ </a></span>format_product_data()</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">format_product_data </td> <td>(</td> <td class="paramtype"> </td> <td class="paramname"><em>$product</em></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p>Returns a product object formatted according to what <a class="el" href="namespace_gravity_kit_1_1_gravity_view_1_1_foundation_1_1_licenses_1_1_w_p.html" title="GPL-2.0-or-later ">WP</a> expects in order to display changelog/store plugin update data. </p> <dl class="section since"><dt>Since</dt><dd>1.0.0</dd></dl> <dl class="section see"><dt>See also</dt><dd><a class="el" href="class_gravity_kit_1_1_gravity_view_1_1_foundation_1_1_licenses_1_1_product_manager.html#aa7ed499574a425ef4f5cfd479c2c9427" title="Returns a list of all GravityKit products with associated installation/activation/licensing data...">ProductManager::get_products_data()</a> </dd> <dd> plugins_api()</dd></dl> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramtype">array</td><td class="paramname">$product</td><td>Product data.</td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd>object </dd></dl> <p class="definition">Definition at line <a class="el" href="_e_d_d_8php_source.html#l00164">164</a> of file <a class="el" href="_e_d_d_8php_source.html">EDD.php</a>.</p> <p class="reference">References <a class="el" href="_arr_8php_source.html#l00099">Arr\get()</a>, and <a class="el" href="_license_manager_8php_source.html#l00055">LicenseManager\get_instance()</a>.</p> <p class="reference">Referenced by <a class="el" href="_e_d_d_8php_source.html#l00110">EDD\check_for_product_updates()</a>, and <a class="el" href="_e_d_d_8php_source.html#l00218">EDD\display_product_information()</a>.</p> </div> </div> <a id="aeeb76432d095288ac056df22cca56d16"></a> <h2 class="memtitle"><span class="permalink"><a href="#aeeb76432d095288ac056df22cca56d16">◆ </a></span>get_instance()</h2> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">static get_instance </td> <td>(</td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">static</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Returns class instance. </p> <dl class="section since"><dt>Since</dt><dd>1.0.0</dd></dl> <dl class="section return"><dt>Returns</dt><dd><a class="el" href="class_gravity_kit_1_1_gravity_view_1_1_foundation_1_1_licenses_1_1_e_d_d.html">EDD</a> </dd></dl> <p class="definition">Definition at line <a class="el" href="_e_d_d_8php_source.html#l00030">30</a> of file <a class="el" href="_e_d_d_8php_source.html">EDD.php</a>.</p> <p class="reference">Referenced by <a class="el" href="_licenses_2_framework_8php_source.html#l00113">Framework\init()</a>, and <a class="el" href="_product_manager_8php_source.html#l00345">ProductManager\update_product()</a>.</p> </div> </div> <a id="a4be4055f3361d4800e16bc2e2e38cda6"></a> <h2 class="memtitle"><span class="permalink"><a href="#a4be4055f3361d4800e16bc2e2e38cda6">◆ </a></span>init()</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">init </td> <td>(</td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p>Initializes the class. </p> <dl class="section since"><dt>Since</dt><dd>1.0.0</dd></dl> <dl class="section return"><dt>Returns</dt><dd>void </dd></dl> <p class="definition">Definition at line <a class="el" href="_e_d_d_8php_source.html#l00045">45</a> of file <a class="el" href="_e_d_d_8php_source.html">EDD.php</a>.</p> </div> </div> <h2 class="groupheader">Field Documentation</h2> <a id="ac350be23da328a6f5429313efc9b96e4"></a> <h2 class="memtitle"><span class="permalink"><a href="#ac350be23da328a6f5429313efc9b96e4">◆ </a></span>$_instance</h2> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">$_instance</td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">static</span><span class="mlabel">private</span></span> </td> </tr> </table> </div><div class="memdoc"> <p class="definition">Definition at line <a class="el" href="_e_d_d_8php_source.html#l00021">21</a> of file <a class="el" href="_e_d_d_8php_source.html">EDD.php</a>.</p> </div> </div> <hr/>The documentation for this class was generated from the following file:<ul> <li><a class="el" href="_e_d_d_8php_source.html">EDD.php</a></li> </ul> </div><!-- contents --> <!-- start footer part --> <hr class="footer"/> <script type="text/javascript"> jQuery( document ).ready( function( $ ) { $( 'a.anchor[id^=_filters],a.anchor[id^=_actions]' ).each( function() { $( this ) .text('#') .attr( 'href', function() { return '#' + $( this ).attr( 'id' ); }).prependTo( $( this ).parent('dt' ).next('dd') ); }); }); </script> </body> </html>
About
GravityView developer documentation
Stars
Watchers
Forks
Releases
No releases published
Packages 0
No packages published