CiviCRM Community Forums (archive)

Hey all,

In my latest creation which I hope to get out for testing in the next week, I need to create and call some php scripts that don't need all of the trimmings that come with a page in civiCRM.

1) One is a PHP script that I'm calling with a jQuery ajax call to change a session variable. The code is quite simple and returns a one or a zero

Currently, in order to add this page to civiCRM's routing table, I used civix generate:page which in turn stubbed out the page.php and page.tpl files. I'm not using the tpl file and I stripped the php file of everything except for require_once 'CRM/Core/Page.php';

This actually works fine and the session variable is changed by the ajax call however if I look at the console in Firebug, the page I am requesting errors out with a Page 500 error so I wonder if something is going on than needs to be dealt with in another way.

* If I avoid the civix created URL, add session_start(), remove require_once 'CRM/Core/Page.php' and call the URL directly via a long URL (/sites/all/extensions/my_extension_name/CRM/Civicpd/Page/ReportYear.php) it works without the 500 error but the session variable is not affected so it would appear that in order to work with the session variable that is specific to this session, I must access the URL via the CRM_Utils_System.


2) My second script will be a page that is called via a "Contact Record" tab that I have added using function civicpd_civicrm_tabs( &$tabs, $contactID ); The idea is to provide the ability for Admins to be able to click on the tab and review/edit a member's Continuing Professional Development log. The code I'm using is as follows:

// Adding a tab to the contact record
function civicpd_civicrm_tabs( &$tabs, $contactID ) {
    // let's add a new tab... In the real world, you would create a url which would
    // return an html snippet etc.
    $url = CRM_Utils_System::url('civicrm/civicdp/report');
    $tabs[] = array( 'id'    => 'CDP Activities',
                     'url'   => $url,
                     'title' => 'CDP Activities',
                     'weight' => 300 );
}

This indeed creates my tab but when I click on it it loads a page within a page so that the content area has a full page within it. I just want to be able to load the guts of my page in so I can produce a report that can be edited.

 
I realize that this has gotten into some of the murky details of what I'm doing so hopefully it makes sense and you can provide some direction.

Thanks,
Andrew
 

Thanks Lobo,

$url = CRM_Utils_System::url( 'civicrm/civicpd/report', "reset=1&snippet=2"); works perfectly!

Can I use that to form URLS from within that report so that can link from the report to an editing page that will also be wrapped in the Contact Record? That would be ideal 

Regarding the page with the 500 Error... Here's the details:

On the report page I have a drop-down select tag populated with years (2012, 2011, etc...) When a year is selected it makes the following call:

<script>
var jq = jQuery.noConflict();

jq('#select_year').change(function() {
var reportyear = jq(this).attr('value');

jq.post("/civicrm/civicpd/reportyear",
{ new_year: reportyear }

// At the moment this is posting the report year page
// but the response header returns a 500 Internal Server Error


);

});
</script>
 

In Firebug the actual response HTML message looks correct... It returns a 1 when it is successful and it is returning a 1 in the Response HTML according to the Firebug console. If I call it directly (http://localhost/civicrm/civicpd/reportyear?new_year=2012) it responds just fine and returns a 1 

The code to make it happen is equally as simple:

<?php
require_once 'CRM/Core/Page.php';

if(isset($_REQUEST['new_year'])) {
$new_year = $_REQUEST['new_year'];
$_SESSION["report_year"] = $new_year;
$output = 1;
} else {
$output = 0;
}

print $output;

?>


Thanks Lobo.

I'll keep plugging away at it. It might be something to do with the Apache setup I have on my local machine that's causing the trouble. I'll take it to a hosted test site and see if there's a difference.

Andrew

Well, I think I'm at a good place with this for the moment. I've gotten rid of the Error 500.
 
Since I can't really do this any other way, I've gone back to dealing with the ReportYear.php script as a proper MV page within civiCRM:

ReportYear.php
<?php

require_once 'CRM/Core/Page.php';

class CRM_Civicpd_Page_ReportYear extends CRM_Core_Page {
  function run() {
  
  // This script is called via jQuery.post() and sets the session year variable 
  if(isset($_REQUEST['new_year'])) {
$new_year = $_REQUEST['new_year'];
$_SESSION['report_year'] = $new_year;
$output = 1;
  } else {
$output = 0;
  }

  $this->assign('output', $output);

  parent::run();

}
}

ReportYear.tpl
{$output}

This is called in the jQuery.onchange function as follows:
<script type="text/javascript">
<!--
var jq = jQuery.noConflict();

jQuery(function(){


jq('#select_year').change(function() {
var reportyear = jq(this).attr('value');

jq.post("/civicrm/civicpd/reportyear?new_year=" + reportyear,

jq('.report-year').text(reportyear),

function(data) {
      /**
      * I would like to pull data from the response and then refresh the page content
      * but I can't really post to the page without an error so I'm sending the arguments
      * via the querystring for now and just refreshing the page.
      */
      window.setTimeout('location.reload()', 0);
  }

);

});

});

//-->
</script>

My next trick will be to query the database with ReportYear.php and then grab the updated data from the jQuery call and repopulate the report page without a refresh.

Wish me luck!

Thanks for the reply Totten,

I'm back to using the standard civix templates and have used the print argument in my URL (?reset=1&snippet=2) to reduce the amount of html clutter sent back in the AJAX data. It looks a bit like this:

The jQuery onchange code to call the PHP page that sets the session:
<script type="text/javascript">
<!--
var jq = jQuery.noConflict();

var reportyear = jq(this).attr('value');
 
  jq.ajax({
  type: 'POST',
  url: '/civicrm/civicpd/reportyear?reset=1&snippet=2',
  data: { new_year : reportyear },
  success: function(data){
    // THIS WORKS... I CAN RETRIEVE ANY PROCESSED DATA FROM THE PHP PAGE AT THE URL ABOVE HERE WITH LIMITED CLUTTER
  }
});

//-->
</script>


At the moment I'm just refreshing the page and letting the new Session variable do it's thing but I intend to use my target to re-query the database based on the new report_year and then repopulate the page without a full refresh. Thanks for the examples, I'll have a look at them as I'm sure they will come in handy. I have 3 more modules to build once this one rolls out 

Thanks again!

Andrew