{"id":5771,"date":"2012-11-15T17:35:30","date_gmt":"2012-11-15T17:35:30","guid":{"rendered":"http:\/\/www.oik-plugins.com\/oik_shortcodes\/bw_api\/"},"modified":"2012-11-16T14:11:45","modified_gmt":"2012-11-16T14:11:45","slug":"bw_api","status":"publish","type":"oik_shortcodes","link":"https:\/\/www.oik-plugins.com\/oik_shortcodes\/bw_api\/","title":{"rendered":"bw_api – Dynamic API syntax help<\/span>"},"content":{"rendered":"Dynamic API syntax help\r\n

Syntax<\/p>[bw_api<\/a>
funcname<\/a><\/span>=\"<\/b>| function<\/i> - Name of the function\"<\/span>
sourcefile<\/a><\/span>=\"<\/b>| sourcefile<\/i> - Sourcefile containing the function\"<\/span>
plugin<\/a><\/span>=\"<\/b>| plugin<\/i> - Implementing plugin slug\"<\/span>]<\/code>\r\n\r\n[bw_api funcname=oikai_apiref sourcefile=”shortcodes\/oik-api-importer.php” plugin=oik-shortcodes]\r\n\r\n

Description<\/h2>Implement the [bw_api] shortcode

When coded as [bw_api]some php code[\/bw_api] then this shortcode produces dynamic API documentation When the funcname parameter is not specified then we assume this is being invoked for current post – which is an API If we find the funcname (and sourcefile and plugin) then we can build the apiref including the callers and callees <\/p>

Usage<\/h2>
$string = oikai_apiref( $atts, $content, $tag );<\/pre>
Parameters<\/h2>
$atts<\/dt>
( array ) optional<\/i>  – { shortcode parameters  <\/dd>
$funcname<\/dt>
( string ) optional<\/i>  – the API function name which may be class::method ?  <\/dd>
$sourcefile<\/dt>
( string ) optional<\/i>  – the implementing sourcefile  <\/dd>
$plugin<\/dt>
( string ) optional<\/i>  – the implementing plugin }  <\/dd><\/dl>
$content<\/dt>
( string ) optional<\/i>  – PHP source to be dynamically documented  <\/dd>
$tag<\/dt>
( string ) optional<\/i>  – the shortcode name  <\/dd><\/dl>
Returns<\/h2>string<\/i> generated HTML  
Source<\/h2>File name: oik-shortcodes\/shortcodes\/oik-api-importer.php
Lines: 
1 to 65 of 65<\/div>
function<\/span> <\/span>oikai_apiref<\/a><\/span>(<\/span> <\/span>$atts<\/span>=<\/span>null<\/span>,<\/span> <\/span>$content<\/span>=<\/span>null<\/span>,<\/span> <\/span>$tag<\/span>=<\/span>null<\/span> <\/span>)<\/span> <\/span>{<\/span>\r\n\r\n  <\/span>$is_bot_maybe<\/span> <\/span>=<\/span> <\/span>oiksc_is_bot_maybe<\/span>(<\/span>)<\/span>;<\/span>\r\n  \r\n  <\/span>if<\/span> <\/span>(<\/span> <\/span>$is_bot_maybe<\/span> <\/span>)<\/span> <\/span>{<\/span>\r\n    <\/span>p<\/a><\/span>(<\/span> <\/span>\"You appear to be a bot. Output may be restricted\"<\/span> <\/span>)<\/span>;<\/span>\r\n  <\/span>}<\/span>\r\n  \r\n  <\/span>oiksc_autoload<\/a><\/span>(<\/span>)<\/span>;<\/span>\r\n\r\n  <\/span>$funcname<\/span> <\/span>=<\/span> <\/span>bw_array_get<\/a><\/span>(<\/span> <\/span>$atts<\/span>,<\/span> <\/span>\"funcname\"<\/span>,<\/span> <\/span>null<\/span> <\/span>)<\/span>;<\/span>\r\n  <\/span>$sourcefile<\/span> <\/span>=<\/span> <\/span>bw_array_get<\/a><\/span>(<\/span> <\/span>$atts<\/span>,<\/span> <\/span>\"sourcefile\"<\/span>,<\/span> <\/span>null<\/span> <\/span>)<\/span>;<\/span>\r\n  <\/span>$plugin<\/span> <\/span>=<\/span> <\/span>bw_array_get<\/a><\/span>(<\/span> <\/span>$atts<\/span>,<\/span> <\/span>\"plugin\"<\/span>,<\/span> <\/span>null<\/span> <\/span>)<\/span>;<\/span>\r\n  <\/span>$classname<\/span> <\/span>=<\/span> <\/span>null<\/span>;<\/span>\r\n  <\/span>$post_id<\/span> <\/span>=<\/span> <\/span>null<\/span>;<\/span>\r\n  <\/span>if<\/span> <\/span>(<\/span> <\/span>$content<\/span> <\/span>)<\/span> <\/span>{<\/span>\r\n    <\/span>oikai_build_dynamic_docs<\/a><\/span>(<\/span> <\/span>$content<\/span> <\/span>)<\/span>;<\/span>\r\n  <\/span>}<\/span> <\/span>else<\/span> <\/span>{<\/span> \r\n    <\/span>if<\/span> <\/span>(<\/span> <\/span>!<\/span>$funcname<\/span> <\/span>)<\/span> <\/span>{<\/span>\r\n      <\/span>oik_require<\/a><\/span>(<\/span> <\/span>\"includes\/bw_posts.php\"<\/span> <\/span>)<\/span>;<\/span> \r\n      <\/span>$post_id<\/span> <\/span>=<\/span> <\/span>bw_global_post_id<\/a><\/span>(<\/span>)<\/span>;<\/span> \r\n      <\/span>bw_trace2<\/a><\/span>(<\/span> <\/span>$post_id<\/span>,<\/span> <\/span>\"post_id\"<\/span>,<\/span> <\/span>true<\/span>,<\/span> <\/span>BW_TRACE_VERBOSE<\/span> <\/span>)<\/span>;<\/span> \r\n      <\/span>$sourcefile<\/span> <\/span>=<\/span> <\/span>get_post_meta<\/a><\/span>(<\/span> <\/span>$post_id<\/span>,<\/span> <\/span>\"_oik_api_source\"<\/span>,<\/span> <\/span>true<\/span> <\/span>)<\/span>;<\/span>\r\n      <\/span>if<\/span> <\/span>(<\/span> <\/span>$sourcefile<\/span> <\/span>)<\/span> <\/span>{<\/span>\r\n        <\/span>$plugin_id<\/span> <\/span>=<\/span> <\/span>get_post_meta<\/a><\/span>(<\/span> <\/span>$post_id<\/span>,<\/span> <\/span>\"_oik_api_plugin\"<\/span>,<\/span> <\/span>true<\/span> <\/span>)<\/span>;<\/span>\r\n        \r\n        <\/span>if<\/span> <\/span>(<\/span> <\/span>$plugin_id<\/span> <\/span>)<\/span> <\/span>{<\/span>\r\n          <\/span>$plugin<\/span> <\/span>=<\/span> <\/span>get_post_meta<\/a><\/span>(<\/span> <\/span>$plugin_id<\/span>,<\/span> <\/span>\"_oikp_slug\"<\/span>,<\/span> <\/span>true<\/span> <\/span>)<\/span>;<\/span>\r\n          <\/span>\/\/ It may be a theme so try for _oikth_slug<\/span>\r\n          <\/span>if<\/span> <\/span>(<\/span> <\/span>!<\/span>$plugin<\/span> <\/span>)<\/span> <\/span>{<\/span>\r\n            <\/span>$plugin<\/span> <\/span>=<\/span> <\/span>get_post_meta<\/a><\/span>(<\/span> <\/span>$plugin_id<\/span>,<\/span> <\/span>\"_oikth_slug\"<\/span>,<\/span> <\/span>true<\/span> <\/span>)<\/span>;<\/span>\r\n          <\/span>}<\/span>\r\n          <\/span>if<\/span> <\/span>(<\/span> <\/span>$plugin<\/span> <\/span>)<\/span> <\/span>{<\/span> \r\n            <\/span>$funcname<\/span> <\/span>=<\/span> <\/span>get_post_meta<\/a><\/span>(<\/span> <\/span>$post_id<\/span>,<\/span> <\/span>\"_oik_api_name\"<\/span>,<\/span> <\/span>true<\/span> <\/span>)<\/span>;<\/span>\r\n            <\/span>$classname<\/span> <\/span>=<\/span> <\/span>oikai_get_noderef_value<\/a><\/span>(<\/span> <\/span>$post_id<\/span>,<\/span> <\/span>\"_oik_api_class\"<\/span>,<\/span> <\/span>\"_oik_class_name\"<\/span> <\/span>)<\/span>;<\/span>              \r\n            <\/span>\/\/$title = get_the_title();<\/span>\r\n            <\/span>\/\/$title = str_replace( \"(\", \" \", $title );<\/span>\r\n            <\/span>\/\/$title = str_replace( \")\", \" \", $title );<\/span>\r\n            <\/span>\/\/$title = str_replace( array( \"(\",\")\",\"-\"), \" \", $title );<\/span>\r\n            <\/span>\/\/list( $funcname, $rest) = explode( \" \", $title. \" .\", 2 );<\/span>\r\n          <\/span>}<\/span> <\/span>else<\/span> <\/span>{<\/span>\r\n            <\/span>e<\/a><\/span>(<\/span> <\/span>\"Plugin not found for oik_api\"<\/span> <\/span>)<\/span>;<\/span>\r\n          <\/span>}<\/span>\r\n        <\/span>}<\/span> <\/span>else<\/span> <\/span>{<\/span>\r\n          <\/span>e<\/a><\/span>(<\/span> <\/span>\"Plugin not defined for this API\"<\/span> <\/span>)<\/span>;<\/span>\r\n        <\/span>}<\/span>  \r\n      <\/span>}<\/span> <\/span>else<\/span> <\/span>{<\/span>\r\n        <\/span>e<\/a><\/span>(<\/span> <\/span>\"<\/span>Sourcefile not defined for <\/span>$post_id<\/span>\"<\/span> <\/span>)<\/span>;<\/span>\r\n      <\/span>}<\/span>  \r\n    <\/span>}<\/span>  \r\n    <\/span>if<\/span> <\/span>(<\/span> <\/span>$funcname<\/span> <\/span>)<\/span> <\/span>{<\/span>\r\n      <\/span>oikai_build_apiref<\/a><\/span>(<\/span> <\/span>$funcname<\/span>,<\/span> <\/span>$sourcefile<\/span>,<\/span> <\/span>$plugin<\/span>,<\/span> <\/span>$classname<\/span>,<\/span> <\/span>$post_id<\/span>,<\/span> <\/span>true<\/span>,<\/span> <\/span>$plugin_id<\/span> <\/span>)<\/span>;<\/span>\r\n      <\/span>if<\/span> <\/span>(<\/span> <\/span>$post_id<\/span> <\/span>)<\/span> <\/span>{<\/span> \r\n        <\/span>oik_require<\/a><\/span>(<\/span> <\/span>\"shortcodes\/oik-apilink.php\"<\/span>,<\/span> <\/span>\"oik-shortcodes\"<\/span> <\/span>)<\/span>;<\/span>\r\n        <\/span>if<\/span> <\/span>(<\/span> <\/span>!<\/span>$is_bot_maybe<\/span> <\/span>)<\/span> <\/span>{<\/span>\r\n          <\/span>oikai_list_callers_callees<\/a><\/span>(<\/span> <\/span>$post_id<\/span> <\/span>)<\/span>;<\/span>\r\n          <\/span>do_action<\/a><\/span>(<\/span> <\/span>\"bw_metadata\"<\/a><\/span>,<\/span> <\/span>$post_id<\/span> <\/span>)<\/span>;<\/span>\r\n        <\/span>}<\/span>\r\n      <\/span>}<\/span>  \r\n    <\/span>}<\/span> <\/span>else<\/span> <\/span>{<\/span>\r\n      <\/span>e<\/a><\/span>(<\/span> <\/span>\"bw_api cannot determine the funcname\"<\/span> <\/span>)<\/span>;<\/span>\r\n    <\/span>}<\/span>\r\n  <\/span>}<\/span>\r\n  <\/span>return<\/span>(<\/span> <\/span>bw_ret<\/a><\/span>(<\/span>)<\/span> <\/span>)<\/span>;<\/span>  \r\n<\/span>}<\/span>\r\n<\/span> <\/pre>
<\/div> View on Trac<\/a>\r\n\r\nNote: For the oik_api post type, when the [bw_api] shortcode is omitted then it is automatically generated at the end of the content.  ","protected":false},"author":1,"template":"","letters":[],"class_list":{"0":"post-5771","1":"oik_shortcodes","2":"type-oik_shortcodes","3":"status-publish","5":"entry"},"acf":[],"yoast_head":"\nbw_api - Dynamic API syntax help - [oik] plugins.com<\/title>\n<meta name=\"robots\" content=\"index, follow, max-snippet:-1, max-image-preview:large, max-video-preview:-1\" \/>\n<link rel=\"canonical\" href=\"https:\/\/www.oik-plugins.com\/oik_shortcodes\/bw_api\/\" \/>\n<meta property=\"og:locale\" content=\"en_US\" \/>\n<meta property=\"og:type\" content=\"article\" \/>\n<meta property=\"og:title\" content=\"bw_api - Dynamic API syntax help - [oik] plugins.com\" \/>\n<meta property=\"og:description\" content=\"Dynamic API syntax help\" \/>\n<meta property=\"og:url\" content=\"https:\/\/www.oik-plugins.com\/oik_shortcodes\/bw_api\/\" \/>\n<meta property=\"og:site_name\" content=\"[oik] plugins.com\" \/>\n<meta property=\"article:modified_time\" content=\"2012-11-16T14:11:45+00:00\" \/>\n<script type=\"application\/ld+json\" class=\"yoast-schema-graph\">{\"@context\":\"https:\/\/schema.org\",\"@graph\":[{\"@type\":\"WebPage\",\"@id\":\"https:\/\/www.oik-plugins.com\/oik_shortcodes\/bw_api\/\",\"url\":\"https:\/\/www.oik-plugins.com\/oik_shortcodes\/bw_api\/\",\"name\":\"bw_api - Dynamic API syntax help - [oik] plugins.com\",\"isPartOf\":{\"@id\":\"https:\/\/www.oik-plugins.com\/#website\"},\"datePublished\":\"2012-11-15T17:35:30+00:00\",\"dateModified\":\"2012-11-16T14:11:45+00:00\",\"breadcrumb\":{\"@id\":\"https:\/\/www.oik-plugins.com\/oik_shortcodes\/bw_api\/#breadcrumb\"},\"inLanguage\":\"en-US\",\"potentialAction\":[{\"@type\":\"ReadAction\",\"target\":[\"https:\/\/www.oik-plugins.com\/oik_shortcodes\/bw_api\/\"]}]},{\"@type\":\"BreadcrumbList\",\"@id\":\"https:\/\/www.oik-plugins.com\/oik_shortcodes\/bw_api\/#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Shortcodes\",\"item\":\"https:\/\/www.oik-plugins.com\/oik_shortcodes\/\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"bw_api – Dynamic API syntax help\"}]},{\"@type\":\"WebSite\",\"@id\":\"https:\/\/www.oik-plugins.com\/#website\",\"url\":\"https:\/\/www.oik-plugins.com\/\",\"name\":\"[oik] plugins.com\",\"description\":\"WordPress plugins and themes\",\"potentialAction\":[{\"@type\":\"SearchAction\",\"target\":{\"@type\":\"EntryPoint\",\"urlTemplate\":\"https:\/\/www.oik-plugins.com\/?s={search_term_string}\"},\"query-input\":{\"@type\":\"PropertyValueSpecification\",\"valueRequired\":true,\"valueName\":\"search_term_string\"}}],\"inLanguage\":\"en-US\"}]}<\/script>\n<!-- \/ Yoast SEO plugin. -->","yoast_head_json":{"title":"bw_api - Dynamic API syntax help - [oik] plugins.com","robots":{"index":"index","follow":"follow","max-snippet":"max-snippet:-1","max-image-preview":"max-image-preview:large","max-video-preview":"max-video-preview:-1"},"canonical":"https:\/\/www.oik-plugins.com\/oik_shortcodes\/bw_api\/","og_locale":"en_US","og_type":"article","og_title":"bw_api - Dynamic API syntax help - [oik] plugins.com","og_description":"Dynamic API syntax help","og_url":"https:\/\/www.oik-plugins.com\/oik_shortcodes\/bw_api\/","og_site_name":"[oik] plugins.com","article_modified_time":"2012-11-16T14:11:45+00:00","schema":{"@context":"https:\/\/schema.org","@graph":[{"@type":"WebPage","@id":"https:\/\/www.oik-plugins.com\/oik_shortcodes\/bw_api\/","url":"https:\/\/www.oik-plugins.com\/oik_shortcodes\/bw_api\/","name":"bw_api - Dynamic API syntax help - [oik] plugins.com","isPartOf":{"@id":"https:\/\/www.oik-plugins.com\/#website"},"datePublished":"2012-11-15T17:35:30+00:00","dateModified":"2012-11-16T14:11:45+00:00","breadcrumb":{"@id":"https:\/\/www.oik-plugins.com\/oik_shortcodes\/bw_api\/#breadcrumb"},"inLanguage":"en-US","potentialAction":[{"@type":"ReadAction","target":["https:\/\/www.oik-plugins.com\/oik_shortcodes\/bw_api\/"]}]},{"@type":"BreadcrumbList","@id":"https:\/\/www.oik-plugins.com\/oik_shortcodes\/bw_api\/#breadcrumb","itemListElement":[{"@type":"ListItem","position":1,"name":"Shortcodes","item":"https:\/\/www.oik-plugins.com\/oik_shortcodes\/"},{"@type":"ListItem","position":2,"name":"bw_api – Dynamic API syntax help"}]},{"@type":"WebSite","@id":"https:\/\/www.oik-plugins.com\/#website","url":"https:\/\/www.oik-plugins.com\/","name":"[oik] plugins.com","description":"WordPress plugins and themes","potentialAction":[{"@type":"SearchAction","target":{"@type":"EntryPoint","urlTemplate":"https:\/\/www.oik-plugins.com\/?s={search_term_string}"},"query-input":{"@type":"PropertyValueSpecification","valueRequired":true,"valueName":"search_term_string"}}],"inLanguage":"en-US"}]}},"_links":{"self":[{"href":"https:\/\/www.oik-plugins.com\/wp-json\/wp\/v2\/oik_shortcodes\/5771","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/www.oik-plugins.com\/wp-json\/wp\/v2\/oik_shortcodes"}],"about":[{"href":"https:\/\/www.oik-plugins.com\/wp-json\/wp\/v2\/types\/oik_shortcodes"}],"author":[{"embeddable":true,"href":"https:\/\/www.oik-plugins.com\/wp-json\/wp\/v2\/users\/1"}],"version-history":[{"count":1,"href":"https:\/\/www.oik-plugins.com\/wp-json\/wp\/v2\/oik_shortcodes\/5771\/revisions"}],"predecessor-version":[{"id":6088,"href":"https:\/\/www.oik-plugins.com\/wp-json\/wp\/v2\/oik_shortcodes\/5771\/revisions\/6088"}],"wp:attachment":[{"href":"https:\/\/www.oik-plugins.com\/wp-json\/wp\/v2\/media?parent=5771"}],"wp:term":[{"taxonomy":"letters","embeddable":true,"href":"https:\/\/www.oik-plugins.com\/wp-json\/wp\/v2\/letters?post=5771"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}