append comments for each php function / minor code clean up

Author: lukethacoder

netlify-webhook-deploy.php

@@ -7,7 +7,7 @@
 Plugin Name: Webhook Netlify Deploy
 Plugin URI: http://github.com/lukethacoder/wp-webhook-netlify-deploy
 Description: Adds a Build Website button that sends a webhook request to build a netlify hosted website when clicked
-Version: 1.0.0
+Version: 1.1.0
 Author: Luke Secomb
 Author URI: https://lukesecomb.digital
 License: GPLv3 or later
@@ -33,6 +33,11 @@
 
 class deployWebhook {
 
+ /**
+ * Constructor
+ *
+ * @since 1.0.0
+ **/
  public function __construct() {
  // Hook into the admin menu
  add_action( 'admin_menu', array( $this, 'create_plugin_settings_page' ) );
@@ -44,6 +49,11 @@ public function __construct() {
  add_action( 'admin_bar_menu', array( $this, 'add_to_admin_bar' ), 90 );
  }
 
+ /**
+ * Main Plugin Page markup
+ *
+ * @since 1.0.0
+ **/
  public function plugin_settings_page_content() {?>
 	<div class="wrap">
 	<h2>Webhook Netlify Deploy</h2>
@@ -60,21 +70,18 @@ public function plugin_settings_page_content() {?>
  <button id="status_button" class="button button-primary" name="submit" type="submit" style="margin: 0 0 16px;">Get Deploys Status</button>
 
  <div style="margin: 0 0 16px;">
- <a id="build_img_link" href="https://app.netlify.com/sites/dvlp-haus/deploys">
+ <a id="build_img_link" href="">
  <img id="build_img" src=""/>
  </a>
  </div>
  <div>
  <!-- <p id="deploy_status"></p> -->
  <p id="deploy_id"></p>
- <!-- <p id="deploy_current_time"></p> -->
  <div style="display: flex;"><p id="deploy_finish_time"></p><p id="deploy_loading"></p></div>
  <p id="deploy_ssl_url"></p>
  </div>
 
- <div id="deploy_preview">
-
- </div>
+ <div id="deploy_preview"></div>
 
  <hr>
 
@@ -84,6 +91,11 @@ public function plugin_settings_page_content() {?>
 	</div> <?php
  }
 
+ /**
+ * Developer Settings (subpage) markup
+ *
+ * @since 1.0.0
+ **/
  public function plugin_settings_subpage_content() {?>
 	<div class="wrap">
 	<h1>Developer Settings</h1>
@@ -111,9 +123,21 @@ public function plugin_settings_subpage_content() {?>
 	</div> <?php
  }
 
+ 
+ /**
+ * The Mighty JavaScript
+ *
+ * @since 1.0.0
+ **/
  public function run_the_mighty_javascript() {
+ // TODO: split up javascript to allow to be dynamically imported as needed
+ // $screen = get_current_screen();
+ // if ( $screen && $screen->parent_base != 'deploy_webhook_fields' && $screen->parent_base != 'deploy_webhook_fields_sub' ) {
+ // return;
+ // }
  ?>
  <script type="text/javascript" >
+ console.log('run_the_mighty_javascript');
  jQuery(document).ready(function($) {
  var _this = this;
  $( ".webhook-deploy_page_deploy_webhook_fields_sub td > input" ).css( "width", "100%");
@@ -152,7 +176,7 @@ function getAllPreviousBuilds() {
  deploy_preview_url = data.deploy_url
  }
  $('#previous_deploys_container').append(
- '<li style="margin: 0 auto 16px"><hr><h3>No: ' + buildNo + ' - ' + item.name + '</h3><h4>Created at: ' + item.created_at + '</h4><h4>' + item.title + '</h4><p>Id: ' + item.id + '</p><p>Deploy Time: ' + item.deploy_time + '</p><p>Branch: ' + item.branch + '</p><a href="' + item.deploy_preview_url + '">Preview Build</a></li>'
+ '<li style="margin: 0 auto 16px"><hr><h3>No: ' + buildNo + ' - ' + item.name + '</h3><h4>Created at: ' +  new Date(item.created_at.toString()).toLocaleString() + '</h4><h4>' + item.title + '</h4><p>Id: ' + item.id + '</p><p>Deploy Time: ' + item.deploy_time + '</p><p>Branch: ' + item.branch + '</p><a href="' + item.deploy_preview_url + '">Preview Build</a></li>'
  );
  buildNo++;
  })
@@ -163,7 +187,6 @@ function getAllPreviousBuilds() {
  }
 
  function runSecondFunc() {
-
  $.ajax({
  type: "GET",
  url: req_url
@@ -184,15 +207,11 @@ function appendStatusData(data) {
  var yo = new Date(data.created_at);
  var created = yo.toLocaleString();
  var current_state = data.state;
+
  if (data.state === 'ready') {
  current_state = "Success"
  }
 
- // $( "#deploy_id" ).html( "ID: " + data.id + "" );
- // $( "#build_img_link" ).attr("href", data.admin_url);
- // $( "#build_img" ).attr("src", data.admin_url);
- // $( "#deploy_status" ).html( "Status: " + current_state );
- // $( "#deploy_current_time" ).html( "Current Date/Time: " + p );
  if (data.state !== 'ready') {
  $( "#deploy_finish_time" ).html( "Building Site" );
  $( "#build_img" ).attr("src", `https://api.netlify.com/api/v1/badges/${ netlify_site_id }/deploy-status`);
@@ -208,11 +227,13 @@ function appendStatusData(data) {
  500);
  } else {
  var deploy_preview_url = '';
+
  if (data.deploy_ssl_url) {
  deploy_preview_url = data.deploy_ssl_url
  } else {
  deploy_preview_url = data.deploy_url
  }
+
  $( "#deploy_id" ).html( "ID: " + data.id + "" );
  $( "#deploy_finish_time" ).html( "Build Completed: " + created );
  $( "#build_img" ).attr("src", `https://api.netlify.com/api/v1/badges/${ netlify_site_id }/deploy-status`);
@@ -307,77 +328,110 @@ function netlifyDeploy() {
  </script> <?php
  }
 
+ /**
+ * Plugin Menu Items Setup
+ *
+ * @since 1.0.0
+ **/
  public function create_plugin_settings_page() {
- // Add the menu item and page
- $page_title = 'Deploy to Netlify';
- $menu_title = 'Webhook Deploy';
- $capability = 'manage_options';
- $slug = 'deploy_webhook_fields';
- $callback = array( $this, 'plugin_settings_page_content' );
- $icon = 'dashicons-admin-plugins';
- $position = 100;
-
- $sub_page_title = 'Developer Settings';
- $sub_menu_title = 'Developer Settings';
- $sub_capability = 'manage_options';
- $sub_slug = 'deploy_webhook_fields_sub';
- $sub_callback = array( $this, 'plugin_settings_subpage_content' );
- $sub_icon = 'dashicons-admin-plugins';
- $sub_position = 100;
-
-
- add_menu_page( $page_title, $menu_title, $capability, $slug, $callback, $icon, $position );
- add_submenu_page( $slug, $sub_page_title, $sub_menu_title, $sub_capability, $sub_slug, $sub_callback, $sub_icon, $sub_position );
+ $run_deploys = apply_filters( 'netlify_deploy_capability', 'manage_options' );
+ $adjust_settings = apply_filters( 'netlify_adjust_settings_capability', 'manage_options' );
+
+ if ( current_user_can( $run_deploys ) ) {
+ $page_title = 'Deploy to Netlify';
+ $menu_title = 'Webhook Deploy';
+ $capability = 'manage_options';
+ $slug = 'deploy_webhook_fields';
+ $callback = array( $this, 'plugin_settings_page_content' );
+ $icon = 'dashicons-admin-plugins';
+ $position = 100;
+
+ add_menu_page( $page_title, $menu_title, $capability, $slug, $callback, $icon, $position );
+ }
+ if ( current_user_can( $adjust_settings ) ) {
+ $sub_page_title = 'Developer Settings';
+ $sub_menu_title = 'Developer Settings';
+ $sub_capability = 'manage_options';
+ $sub_slug = 'deploy_webhook_fields_sub';
+ $sub_callback = array( $this, 'plugin_settings_subpage_content' );
+ $sub_icon = 'dashicons-admin-plugins';
+ $sub_position = 100;
+
+ add_submenu_page( $slug, $sub_page_title, $sub_menu_title, $sub_capability, $sub_slug, $sub_callback, $sub_icon, $sub_position );
+
+ }
+
+
  }
 
+ /**
+ * Notify Admin on Successful Update
+ *
+ * @since 1.0.0
+ **/
  public function admin_notice() { ?>
  <div class="notice notice-success is-dismissible">
  <p>Your settings have been updated!</p>
  </div><?php
  }
 
+ /**
+ * Setup Sections
+ *
+ * @since 1.0.0
+ **/
  public function setup_sections() {
- add_settings_section( 'our_first_section', 'Webhook Settings', array( $this, 'section_callback' ), 'deploy_webhook_fields' );
+ add_settings_section( 'main_section', 'Webhook Settings', array( $this, 'section_callback' ), 'deploy_webhook_fields' );
  }
-
+ 
+ /**
+ * Check it wont break on build and deploy 
+ *
+ * @since 1.0.0
+ **/
  public function section_callback( $arguments ) {
  switch( $arguments['id'] ){
- case 'our_first_section':
+ case 'main_section':
  echo 'The build and deploy status will not work without these fields entered corrently';
  break;
 	}
  }
-
+ 
+ /**
+ * Fields used for developer input data
+ *
+ * @since 1.0.0
+ **/
  public function setup_fields() {
  $fields = array(
  array(
  'uid' => 'webhook_address',
  'label' => 'Webhook Build URL',
- 'section' => 'our_first_section',
+ 'section' => 'main_section',
  'type' => 'text',
  'placeholder' => 'https://',
  'default' => '',
  ),
  array(
  'uid' => 'netlify_site_id',
  'label' => 'Netlify site_id',
- 'section' => 'our_first_section',
+ 'section' => 'main_section',
  'type' => 'text',
  'placeholder' => 'e.g. 5b8e927e-82e1-4786-4770-a9a8321yes43',
  'default' => '',
  ),
  array(
  'uid' => 'netlify_api_key',
  'label' => 'Netlify API Key',
- 'section' => 'our_first_section',
+ 'section' => 'main_section',
  'type' => 'text',
  'placeholder' => 'GET O-AUTH TOKEN',
  'default' => '',
 	),
  array(
  'uid' => 'netlify_user_agent',
  'label' => 'User-Agent Site Value',
- 'section' => 'our_first_section',
+ 'section' => 'main_section',
  'type' => 'text',
  'placeholder' => 'Website Name (and-website-url.netlify.com)',
  'default' => '',
@@ -389,11 +443,17 @@ public function setup_fields() {
 	}
  }
 
+ /**
+ * Field callback for handling multiple field types
+ *
+ * @since 1.0.0
+ * @param $arguments
+ **/
  public function field_callback( $arguments ) {
 
  $value = get_option( $arguments['uid'] );
 
- if( ! $value ) {
+ if ( !$value ) {
  $value = $arguments['default'];
  }
 
@@ -435,6 +495,11 @@ public function field_callback( $arguments ) {
  }
  }
 
+ /**
+ * Add Deploy Button and Deployment Status to admin bar
+ *
+ * @since 1.1.0
+ **/
  public function add_to_admin_bar( $admin_bar ) {
 
  $see_deploy_status = apply_filters( 'netlify_status_capability', 'manage_options' );