{"id":1681,"date":"2014-12-03T22:24:13","date_gmt":"2014-12-03T21:24:13","guid":{"rendered":"https:\/\/plainviewplugins.com\/?page_id=1681"},"modified":"2015-12-21T21:14:46","modified_gmt":"2015-12-21T20:14:46","slug":"getting-started","status":"publish","type":"page","link":"https:\/\/plainviewplugins.com\/sdk\/getting-started\/","title":{"rendered":"Getting started"},"content":{"rendered":"

This page assumes that you have cloned the WordPress plugin SVN structure (assets, tags, trunk) and are ready to begin installing the SDK in the trunk<\/em> directory.<\/p>\n

Installation is done in the following steps:<\/p>\n

    \n
  1. Download the SDK into a source directory<\/li>\n
  2. Rename the SDK namespace<\/li>\n
  3. Add the SDK namespace into your Composer<\/li>\n<\/ol>\n

    1. Download the SDK into a source directory<\/h2>\n

    Good coding practise says we should keep our code in a separate directory. Let’s say src\/<\/code><\/p>\n

    git clone https:\/\/bitbucket.org\/edward_electric\/plainview-sdk.git<\/code><\/p>\n

    In src\/sdk<\/code> you should now have the files base.php<\/code>, composer.json<\/code>, and the directory wordpress<\/code>, amongst others. Download is complete.<\/p>\n

    2. Rename the SDK namespace (optional, but a good idea)<\/h2>\n

    The SDK has the namespace plainview\\sdk<\/code>. This is fine, but if you plan to release your plugin it could be installed together with another plugin that uses the Plainview SDK. Class autoloading will load one of the SDK’s, and there is no knowing whether it will be your or the other plugin’s version. This is a conflict that must be avoided by renaming your SDK namespace.<\/p>\n

    In the scripts\/<\/code> directory you will find a script called sdk_rename.sh<\/code>. This file runs a search and replace using Perl to rename the namespace to something more unique.<\/p>\n

    .\/rename_sdk.sh SUFFIX<\/code><\/p>\n

    This will rename all of the namespaces in the SDK to plainview\\sdkSUFFIX<\/em><\/code>. Your plugin should now use this namespace instead of the default.<\/p>\n

    3. Add the SDK namespace into your Composer (also optional)<\/h2>\n

    Using Composer for its class autoloading is a good idea. Add the SDK’s customized namespace into your composer.json<\/code>. Here is the autoload portion of ThreeWP Broadcast’s<\/a> composer.json.<\/p>\n

    \"autoload\":\r\n{\r\n\t\"psr-4\":\r\n\t{\r\n\t\t\"threewp_broadcast\\\\\": \"src\/\",\r\n\t\t\"plainview\\\\sdk_broadcast\\\\\": \"src\/sdk\/\"\r\n\t}\r\n}\r\n<\/code><\/pre>\n
    Run composer dump<\/code> and the SDK should now be autoloaded in your plugin!<\/p>\n
    Updating the SDK<\/h2>\n
    If you wish to update the SDK, either due to new features or perhaps a bug being fixed, go to the scripts directory and run<\/p>\n
    .\/sdk_update.sh
    \n<\/code><\/p>\n
    This will restore the SDK to its original state, download the newest version via Git, and then rename the namespace again.<\/p>\n
     <\/p>\n","protected":false},"excerpt":{"rendered":"
    Explains how to install and prepare the SDK for use in your plugin.<\/p>\n","protected":false},"author":1,"featured_media":0,"parent":1676,"menu_order":0,"comment_status":"open","ping_status":"closed","template":"","meta":{"footnotes":""},"class_list":["post-1681","page","type-page","status-publish","hentry"],"_links":{"self":[{"href":"https:\/\/plainviewplugins.com\/wp-json\/wp\/v2\/pages\/1681","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/plainviewplugins.com\/wp-json\/wp\/v2\/pages"}],"about":[{"href":"https:\/\/plainviewplugins.com\/wp-json\/wp\/v2\/types\/page"}],"author":[{"embeddable":true,"href":"https:\/\/plainviewplugins.com\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/plainviewplugins.com\/wp-json\/wp\/v2\/comments?post=1681"}],"version-history":[{"count":8,"href":"https:\/\/plainviewplugins.com\/wp-json\/wp\/v2\/pages\/1681\/revisions"}],"predecessor-version":[{"id":1684,"href":"https:\/\/plainviewplugins.com\/wp-json\/wp\/v2\/pages\/1681\/revisions\/1684"}],"up":[{"embeddable":true,"href":"https:\/\/plainviewplugins.com\/wp-json\/wp\/v2\/pages\/1676"}],"wp:attachment":[{"href":"https:\/\/plainviewplugins.com\/wp-json\/wp\/v2\/media?parent=1681"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}