Merge pull request #2548 from rcsheets/doc_improvements

[civicrm-core.git] / templates / CRM / Group / Form / Search.tpl

{*
 +--------------------------------------------------------------------+
 | CiviCRM version 4.4                                                |
 +--------------------------------------------------------------------+
 | Copyright CiviCRM LLC (c) 2004-2013                                |
 +--------------------------------------------------------------------+
 | This file is a part of CiviCRM.                                    |
 |                                                                    |
 | CiviCRM is free software; you can copy, modify, and distribute it  |
 | under the terms of the GNU Affero General Public License           |
 | Version 3, 19 November 2007 and the CiviCRM Licensing Exception.   |
 |                                                                    |
 | CiviCRM is distributed in the hope that it will be useful, but     |
 | WITHOUT ANY WARRANTY; without even the implied warranty of         |
 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.               |
 | See the GNU Affero General Public License for more details.        |
 |                                                                    |
 | You should have received a copy of the GNU Affero General Public   |
 | License and the CiviCRM Licensing Exception along                  |
 | with this program; if not, contact CiviCRM LLC                     |
 | at info[AT]civicrm[DOT]org. If you have questions about the        |
 | GNU Affero General Public License or the licensing of CiviCRM,     |
 | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
 +--------------------------------------------------------------------+
*}
<div class="crm-block crm-form-block crm-group-search-form-block">

<h3>{ts}Find Groups{/ts}</h3>
<table class="form-layout">
  <tr>
    <td>
      {$form.title.label}<br />
      {$form.title.html}<br />
      <span class="description font-italic">
          {ts}Complete OR partial group name.{/ts}
      </span>
    </td>
    <td>
      {$form.created_by.label}<br />
      {$form.created_by.html}<br />
      <span class="description font-italic">
          {ts}Complete OR partial creator name.{/ts}
      </span>
    </td>
    <td id="group_type-block">
      {$form.group_type.label}<br />
      {$form.group_type.html}<br />
      <span class="description font-italic">
          {ts}Filter search by group type(s).{/ts}
      </span>
    </td>
    <td>
      {$form.visibility.label}<br />
      {$form.visibility.html}<br />
      <span class="description font-italic">
          {ts}Filter search by visibility.{/ts}
      </span>
    </td>
    <td>
      {$form.group_status.label}<br />
      {$form.group_status.html}
    </td>
  </tr>
  <tr>
     <td>{$form.buttons.html}</td><td colspan="2">
  </tr>
</table>
</div>
<br/>
<table id="crm-group-selector">
  <thead>
    <tr>
      <th class='crm-group-name'>{ts}Name{/ts}</th>
      <th class='crm-group-group_id'>{ts}ID{/ts}</th>
      <th class='crm-group-created_by'>{ts}Created By{/ts}</th>
      <th class='crm-group-description'>{ts}Description{/ts}</th>
      <th class='crm-group-group_type'>{ts}Group Type{/ts}</th>
      <th class='crm-group-visibility'>{ts}Visibility{/ts}</th>
      {if $showOrgInfo}
      <th class='crm-group-org_info'>{ts}Organization{/ts}</th>
      {/if}
      <th class='crm-group-group_links nosort'>&nbsp;</th>
      <th class='hiddenElement'>&nbsp;</th>
    </tr>
  </thead>
</table>

{* handle enable/disable actions*}
{include file="CRM/common/enableDisableApi.tpl"}
{include file="CRM/common/crmeditable.tpl"}

{literal}
<script type="text/javascript">
cj(function($) {
  // for CRM-11310 and CRM-10635 : processing just parent groups on initial display
  // passing '1' for parentsOnlyArg to show parent child heirarchy structure display
  // on initial load of manage group page and
  // also to handle search filtering for initial load of same page.
  buildGroupSelector(true, 1);
  $('#_qf_Search_refresh').click( function() {
    buildGroupSelector( true );
  });
  // Add livePage functionality
  $('#crm-container').on('click', 'a.button, a.action-item[href*="action=update"], a.action-item[href*="action=delete"]', function() {
    CRM.loadForm($(this).attr('href'))
      .on('crmFormSuccess', function(e, data) {
        // Refresh datatable when form completes
        $('#crm-group-selector').dataTable().fnDraw();
      });
    return false;
  });
});

function buildGroupSelector( filterSearch, parentsOnlyArg ) {
    if ( filterSearch ) {
        if (typeof crmGroupSelector !== 'undefined') {
          crmGroupSelector.fnDestroy();
        }
        var parentsOnly = 0;
        var ZeroRecordText = '<div class="status messages">{/literal}{ts escape="js"}No matching Groups found for your search criteria. Suggestions:{/ts}{literal}<div class="spacer"></div><ul><li>{/literal}{ts escape="js"}Check your spelling.{/ts}{literal}</li><li>{/literal}{ts escape="js"}Try a different spelling or use fewer letters.{/ts}{literal}</li><li>{/literal}{ts escape="js"}Make sure you have enough privileges in the access control system.{/ts}{literal}</li></ul></div>';
    } else {
        var parentsOnly = 1;
        var ZeroRecordText = {/literal}'{ts escape="js"}<div class="status messages">No Groups have been created for this site.{/ts}</div>'{literal};
    }

    // this argument should only be used on initial display i.e onPageLoad
    if (typeof parentsOnlyArg !== 'undefined') {
      parentsOnly = parentsOnlyArg;
    }

    var columns = '';
    var sourceUrl = {/literal}'{crmURL p="civicrm/ajax/grouplist" h=0 q="snippet=4"}'{literal};
    var showOrgInfo = {/literal}"{$showOrgInfo}"{literal};

    crmGroupSelector = cj('#crm-group-selector').dataTable({
        "bFilter"    : false,
        "bAutoWidth" : false,
        "aaSorting"  : [],
        "aoColumns"  : [
                        {sClass:'crm-group-name'},
                        {sClass:'crm-group-group_id'},
                        {sClass:'crm-group-created_by'},
                        {sClass:'crm-group-description', bSortable:false},
                        {sClass:'crm-group-group_type'},
                        {sClass:'crm-group-visibility'},
                        {sClass:'crm-group-group_links', bSortable:false},
                        {/literal}{if $showOrgInfo}{literal}
                        {sClass:'crm-group-org_info', bSortable:false},
                        {/literal}{/if}{literal}
                        {sClass:'hiddenElement', bSortable:false}
                       ],
        "bProcessing": true,
        "asStripClasses" : [ "odd-row", "even-row" ],
        "sPaginationType": "full_numbers",
        "sDom"       : '<"crm-datatable-pager-top"lfp>rt<"crm-datatable-pager-bottom"ip>',
        "bServerSide": true,
        "bJQueryUI": true,
        "sAjaxSource": sourceUrl,
        "iDisplayLength": 25,
        "oLanguage": { "sZeroRecords":  ZeroRecordText,
                       "sProcessing":    {/literal}"{ts escape='js'}Processing...{/ts}"{literal},
                       "sLengthMenu":    {/literal}"{ts escape='js'}Show _MENU_ entries{/ts}"{literal},
                       "sInfo":          {/literal}"{ts escape='js'}Showing _START_ to _END_ of _TOTAL_ entries{/ts}"{literal},
                       "sInfoEmpty":     {/literal}"{ts escape='js'}Showing 0 to 0 of 0 entries{/ts}"{literal},
                       "sInfoFiltered":  {/literal}"{ts escape='js'}(filtered from _MAX_ total entries){/ts}"{literal},
                       "sSearch":        {/literal}"{ts escape='js'}Search:{/ts}"{literal},
                       "oPaginate": {
                            "sFirst":    {/literal}"{ts escape='js'}First{/ts}"{literal},
                            "sPrevious": {/literal}"{ts escape='js'}Previous{/ts}"{literal},
                            "sNext":     {/literal}"{ts escape='js'}Next{/ts}"{literal},
                            "sLast":     {/literal}"{ts escape='js'}Last{/ts}"{literal}
                        }
                    },
        "fnRowCallback": function(nRow, aData, iDisplayIndex, iDisplayIndexFull) {
          var id = cj('td:eq(1)', nRow).text();
          cj(nRow).addClass('crm-entity').attr('data-entity', 'group').attr('data-id', id);
          cj('td:eq(0)', nRow).wrapInner('<span class="crm-editable crmf-name" />');
          cj('td:eq(3)', nRow).wrapInner('<span class="crm-editable crmf-description" data-type="textarea" />');
          return nRow;
        },
        "fnDrawCallback": function() {
          setSelectorClass( parentsOnly, showOrgInfo );
          cj('.crm-editable').crmEditable();
        },
        "fnServerData": function ( sSource, aoData, fnCallback ) {
            aoData.push( {name:'showOrgInfo', value: showOrgInfo },
                         {name:'parentsOnly', value: parentsOnly }
                       );
            if ( filterSearch ) {
                var groupTypes = '';
                cj('#group_type-block input').each(function(index) {
                if (cj(this).prop('checked')) {
                  if (groupTypes) {
                    groupTypes = groupTypes + ',' + cj(this).attr('id').substr(11);
                  }
                  else {
                    groupTypes = cj(this).attr('id').substr(11);
                  }
                }
                });

                var groupStatus = '';
                if ( cj('.crm-group-search-form-block #group_status_1').prop('checked') ) {
                    groupStatus = '1';
                }

                if ( cj('.crm-group-search-form-block #group_status_2').prop('checked') ) {
                    if ( groupStatus ) {
                        groupStatus = '3';
                    } else {
                        groupStatus = '2';
                    }
                }

                aoData.push(
                    {name:'title', value: cj('.crm-group-search-form-block #title').val()},
                    {name:'created_by', value: cj('.crm-group-search-form-block #created_by').val()},
                    {name:'group_type', value: groupTypes },
                    {name:'visibility', value: cj('.crm-group-search-form-block #visibility').val()},
                    {name:'status', value: groupStatus }
                );
            }
            cj.ajax( {
                "dataType": 'json',
                "type": "POST",
                "url": sSource,
                "data": aoData,
                "success": fnCallback
            } );
        }
    });
}

function setSelectorClass( parentsOnly, showOrgInfo ) {
  cj('#crm-group-selector tr').each( function( ) {
    var className = cj(this).find('td:last-child').text();
    cj(this).addClass( className );
    var rowID = cj(this).find('td:nth-child(2)').text();
    cj(this).prop( 'id', 'row_' + rowID );
    if (parentsOnly) {
      if ( cj(this).hasClass('crm-group-parent') ) {
        cj(this).find('td:first').prepend('{/literal}<span class="collapsed show-children" title="{ts}show child groups{/ts}"/></span>{literal}');
      }
    }
  });
}

// show hide children
cj('#crm-group-selector').on( 'click', 'span.show-children', function(){
  var showOrgInfo = {/literal}"{$showOrgInfo}"{literal};
  var rowID = cj(this).parents('tr').prop('id');
  var parentRow = rowID.split('_');
  var parent_id = parentRow[1];
  var group_id = '';
  if ( parentRow[2]) {
    group_id = parentRow[2];
  }
  var levelClass = 'level_2';
  // check enclosing td if already at level 2
  if ( cj(this).parent().hasClass('level_2') ) {
    levelClass = 'level_3';
  }
  if ( cj(this).hasClass('collapsed') ) {
    cj(this).removeClass("collapsed").addClass("expanded").attr("title",{/literal}"{ts escape='js'}hide child groups{/ts}"{literal});
    showChildren( parent_id, showOrgInfo, group_id, levelClass );
  }
  else {
    cj(this).removeClass("expanded").addClass("collapsed").attr("title",{/literal}"{ts escape='js'}show child groups{/ts}"{literal});
    cj('.parent_is_' + parent_id).find('.show-children').removeClass("expanded").addClass("collapsed").attr("title",{/literal}"{ts escape='js'}show child groups{/ts}"{literal});
    cj('.parent_is_' + parent_id).hide();
    cj('.parent_is_' + parent_id).each(function(i, obj) {
      // also hide children of children
      var gID = cj(this).find('td:nth-child(2)').text();
      cj('.parent_is_' + gID).hide();
    });
  }
});

function showChildren( parent_id, showOrgInfo, group_id, levelClass) {
  var rowID = '#row_' + parent_id;
  if ( group_id ) {
    rowID = '#row_' + parent_id + '_' + group_id;
  }
  if ( cj(rowID).next().hasClass('parent_is_' + parent_id ) ) {
    // child rows for this parent have already been retrieved so just show them
    cj('.parent_is_' + parent_id ).show();
  } else {
    var sourceUrl = {/literal}'{crmURL p="civicrm/ajax/grouplist" h=0 q="snippet=4"}'{literal};
    cj.ajax( {
        "dataType": 'json',
        "url": sourceUrl,
        "data": {'parent_id': parent_id, 'showOrgInfo': showOrgInfo},
        "success": function(response){
          var appendHTML = '';
          cj.each( response, function( i, val ) {
            appendHTML += '<tr id="row_'+ val.group_id +'_'+parent_id+'" data-entity="group" data-id="'+ val.group_id +'" class="crm-entity parent_is_' + parent_id + ' crm-row-child ' + val.class + '">';
            if ( val.is_parent ) {
              appendHTML += '<td class="crm-group-name ' + levelClass + '">' + '{/literal}<span class="collapsed show-children" title="{ts}show child groups{/ts}"/></span>{literal}<span class="crm-editable crmf-name">' + val.group_name + '</span></td>';
            }
            else {
              appendHTML += '<td class="crm-group-name ' + levelClass + '"><span class="crm-no-children"></span><span class="crm-editable crmf-name">' + val.group_name + '</span></td>';
            }
            appendHTML += "<td>" + val.group_id + "</td>";
            appendHTML += "<td>" + val.created_by + "</td>";
            appendHTML += '<td><span class="crm-editable crmf-description" data-type="textarea">' + (val.group_description || '') + "</span></td>";
            appendHTML += "<td>" + val.group_type + "</td>";
            appendHTML += "<td>" + val.visibility + "</td>";
						if (showOrgInfo) {
							appendHTML += "<td>" + val.org_info + "</td>";
						}
            appendHTML += "<td>" + val.links + "</td>";
            appendHTML += "</tr>";
          });
          cj( rowID ).after( appendHTML );
          cj('.crm-editable').crmEditable();
        }
    } );
  }
}

</script>
{/literal}