2016-01-30 20:28:43 +00:00
< ? php
/*--------------------------------------------------------------------------------------------------------| www . vdm . io |------/
__ __ _ _____ _ _ __ __ _ _ _
\ \ / / | | | __ \ | | | | | \ / | | | | | | |
\ \ / / _ _ ___ | | _ | | | | _____ _____ | | ___ _ __ _ __ ___ ___ _ __ | | _ | \ / | ___ | | _ | | __ ___ __ | |
\ \ / / _ ` / __| __| | | | |/ _ \ \ / / _ \ |/ _ \| '_ \| '_ ` _ \ / _ \ '_ \| __| | |\/| |/ _ \ __| ' _ \ / _ \ / _ ` |
\ / ( _ | \__ \ | _ | | __ | | __ / \ V / __ / | ( _ ) | | _ ) | | | | | | __ / | | | | _ | | | | __ / | _ | | | | ( _ ) | ( _ | |
\ / \__ , _ | ___ / \__ | | _____ / \___ | \_ / \___ | _ | \___ /| . __ /| _ | | _ | | _ | \___ | _ | | _ | \__ | | _ | | _ | \___ | \__ | _ | | _ | \___ / \__ , _ |
| |
| _ |
/-------------------------------------------------------------------------------------------------------------------------------/
2017-02-01 13:17:04 +00:00
@ version @ update number 6 of this MVC
2017-05-08 08:09:24 +00:00
@ build 17 th October , 2016
2017-02-01 13:17:04 +00:00
@ created 4 th March , 2016
2016-01-30 20:28:43 +00:00
@ package Component Builder
@ subpackage help_documents . php
2016-12-22 21:32:13 +00:00
@ author Llewellyn van der Merwe < http :// vdm . bz / component - builder >
2016-01-30 20:28:43 +00:00
@ copyright Copyright ( C ) 2015. All Rights Reserved
@ license GNU / GPL Version 2 or later - http :// www . gnu . org / licenses / gpl - 2.0 . html
Builds Complex Joomla Components
/-----------------------------------------------------------------------------------------------------------------------------*/
// No direct access to this file
defined ( '_JEXEC' ) or die ( 'Restricted access' );
// import the Joomla modellist library
jimport ( 'joomla.application.component.modellist' );
/**
* Help_documents Model
*/
class ComponentbuilderModelHelp_documents extends JModelList
{
public function __construct ( $config = array ())
{
if ( empty ( $config [ 'filter_fields' ]))
{
$config [ 'filter_fields' ] = array (
'a.id' , 'id' ,
'a.published' , 'published' ,
'a.ordering' , 'ordering' ,
'a.created_by' , 'created_by' ,
'a.modified_by' , 'modified_by' ,
'a.title' , 'title' ,
'a.type' , 'type' ,
'a.location' , 'location' ,
'a.admin_view' , 'admin_view' ,
'a.site_view' , 'site_view'
);
}
parent :: __construct ( $config );
}
/**
* Method to auto - populate the model state .
*
* @ return void
*/
protected function populateState ( $ordering = null , $direction = null )
{
$app = JFactory :: getApplication ();
// Adjust the context to support modal layouts.
if ( $layout = $app -> input -> get ( 'layout' ))
{
$this -> context .= '.' . $layout ;
}
$title = $this -> getUserStateFromRequest ( $this -> context . '.filter.title' , 'filter_title' );
$this -> setState ( 'filter.title' , $title );
$type = $this -> getUserStateFromRequest ( $this -> context . '.filter.type' , 'filter_type' );
$this -> setState ( 'filter.type' , $type );
$location = $this -> getUserStateFromRequest ( $this -> context . '.filter.location' , 'filter_location' );
$this -> setState ( 'filter.location' , $location );
$admin_view = $this -> getUserStateFromRequest ( $this -> context . '.filter.admin_view' , 'filter_admin_view' );
$this -> setState ( 'filter.admin_view' , $admin_view );
$site_view = $this -> getUserStateFromRequest ( $this -> context . '.filter.site_view' , 'filter_site_view' );
$this -> setState ( 'filter.site_view' , $site_view );
$sorting = $this -> getUserStateFromRequest ( $this -> context . '.filter.sorting' , 'filter_sorting' , 0 , 'int' );
$this -> setState ( 'filter.sorting' , $sorting );
$access = $this -> getUserStateFromRequest ( $this -> context . '.filter.access' , 'filter_access' , 0 , 'int' );
$this -> setState ( 'filter.access' , $access );
$search = $this -> getUserStateFromRequest ( $this -> context . '.filter.search' , 'filter_search' );
$this -> setState ( 'filter.search' , $search );
$published = $this -> getUserStateFromRequest ( $this -> context . '.filter.published' , 'filter_published' , '' );
$this -> setState ( 'filter.published' , $published );
$created_by = $this -> getUserStateFromRequest ( $this -> context . '.filter.created_by' , 'filter_created_by' , '' );
$this -> setState ( 'filter.created_by' , $created_by );
$created = $this -> getUserStateFromRequest ( $this -> context . '.filter.created' , 'filter_created' );
$this -> setState ( 'filter.created' , $created );
// List state information.
parent :: populateState ( $ordering , $direction );
}
/**
* Method to get an array of data items .
*
* @ return mixed An array of data items on success , false on failure .
*/
public function getItems ()
{
// check in items
$this -> checkInNow ();
// load parent items
$items = parent :: getItems ();
// set values to display correctly.
if ( ComponentbuilderHelper :: checkArray ( $items ))
{
// get user object.
$user = JFactory :: getUser ();
foreach ( $items as $nr => & $item )
{
$access = ( $user -> authorise ( 'help_document.access' , 'com_componentbuilder.help_document.' . ( int ) $item -> id ) && $user -> authorise ( 'help_document.access' , 'com_componentbuilder' ));
if ( ! $access )
{
unset ( $items [ $nr ]);
continue ;
}
// decode groups
$groupsArray = json_decode ( $item -> groups , true );
if ( ComponentbuilderHelper :: checkArray ( $groupsArray ))
{
$groupsNames = '' ;
$counter = 0 ;
foreach ( $groupsArray as $groups )
{
if ( $counter == 0 )
{
$groupsNames .= ComponentbuilderHelper :: getGroupName ( $groups );
}
else
{
$groupsNames .= ', ' . ComponentbuilderHelper :: getGroupName ( $groups );
}
$counter ++ ;
}
$item -> groups = $groupsNames ;
}
}
}
// set selection value to a translatable value
if ( ComponentbuilderHelper :: checkArray ( $items ))
{
foreach ( $items as $nr => & $item )
{
// convert type
$item -> type = $this -> selectionTranslation ( $item -> type , 'type' );
// convert location
$item -> location = $this -> selectionTranslation ( $item -> location , 'location' );
}
}
2016-09-03 21:44:47 +00:00
2016-01-30 20:28:43 +00:00
// return items
return $items ;
}
/**
* Method to convert selection values to translatable string .
*
* @ return translatable string
*/
2016-02-29 11:05:37 +00:00
public function selectionTranslation ( $value , $name )
2016-01-30 20:28:43 +00:00
{
// Array of type language strings
2017-02-01 13:17:04 +00:00
if ( $name === 'type' )
2016-01-30 20:28:43 +00:00
{
$typeArray = array (
0 => 'COM_COMPONENTBUILDER_HELP_DOCUMENT_SELECT_AN_OPTION' ,
1 => 'COM_COMPONENTBUILDER_HELP_DOCUMENT_JOOMLA_ARTICLE' ,
2 => 'COM_COMPONENTBUILDER_HELP_DOCUMENT_TEXT' ,
3 => 'COM_COMPONENTBUILDER_HELP_DOCUMENT_URL'
);
// Now check if value is found in this array
if ( isset ( $typeArray [ $value ]) && ComponentbuilderHelper :: checkString ( $typeArray [ $value ]))
{
return $typeArray [ $value ];
}
}
// Array of location language strings
2017-02-01 13:17:04 +00:00
if ( $name === 'location' )
2016-01-30 20:28:43 +00:00
{
$locationArray = array (
1 => 'COM_COMPONENTBUILDER_HELP_DOCUMENT_ADMIN' ,
2 => 'COM_COMPONENTBUILDER_HELP_DOCUMENT_SITE'
);
// Now check if value is found in this array
if ( isset ( $locationArray [ $value ]) && ComponentbuilderHelper :: checkString ( $locationArray [ $value ]))
{
return $locationArray [ $value ];
}
}
return $value ;
}
/**
* Method to build an SQL query to load the list data .
*
* @ return string An SQL query
*/
protected function getListQuery ()
{
// Get the user object.
$user = JFactory :: getUser ();
// Create a new query object.
$db = JFactory :: getDBO ();
$query = $db -> getQuery ( true );
// Select some fields
$query -> select ( 'a.*' );
// From the componentbuilder_item table
$query -> from ( $db -> quoteName ( '#__componentbuilder_help_document' , 'a' ));
// Filter by published state
$published = $this -> getState ( 'filter.published' );
if ( is_numeric ( $published ))
{
$query -> where ( 'a.published = ' . ( int ) $published );
}
elseif ( $published === '' )
{
$query -> where ( '(a.published = 0 OR a.published = 1)' );
}
// Filter by search.
$search = $this -> getState ( 'filter.search' );
if ( ! empty ( $search ))
{
if ( stripos ( $search , 'id:' ) === 0 )
{
$query -> where ( 'a.id = ' . ( int ) substr ( $search , 3 ));
}
else
{
2016-10-23 22:48:26 +00:00
$search = $db -> quote ( '%' . $db -> escape ( $search ) . '%' );
$query -> where ( '(a.title LIKE ' . $search . ' OR a.type LIKE ' . $search . ' OR a.location LIKE ' . $search . ' OR a.admin_view LIKE ' . $search . ' OR g. LIKE ' . $search . ' OR a.site_view LIKE ' . $search . ' OR h. LIKE ' . $search . ')' );
2016-01-30 20:28:43 +00:00
}
}
// Filter by Type.
if ( $type = $this -> getState ( 'filter.type' ))
{
2016-10-23 22:48:26 +00:00
$query -> where ( 'a.type = ' . $db -> quote ( $db -> escape ( $type )));
2016-01-30 20:28:43 +00:00
}
// Filter by Location.
if ( $location = $this -> getState ( 'filter.location' ))
{
2016-10-23 22:48:26 +00:00
$query -> where ( 'a.location = ' . $db -> quote ( $db -> escape ( $location )));
2016-01-30 20:28:43 +00:00
}
2016-10-23 22:48:26 +00:00
// Filter by admin_view.
2016-01-30 20:28:43 +00:00
if ( $admin_view = $this -> getState ( 'filter.admin_view' ))
{
2016-10-23 22:48:26 +00:00
$query -> where ( 'a.admin_view = ' . $db -> quote ( $db -> escape ( $admin_view )));
2016-01-30 20:28:43 +00:00
}
2016-10-23 22:48:26 +00:00
// Filter by site_view.
2016-01-30 20:28:43 +00:00
if ( $site_view = $this -> getState ( 'filter.site_view' ))
{
2016-10-23 22:48:26 +00:00
$query -> where ( 'a.site_view = ' . $db -> quote ( $db -> escape ( $site_view )));
2016-01-30 20:28:43 +00:00
}
// Add the list ordering clause.
$orderCol = $this -> state -> get ( 'list.ordering' , 'a.id' );
$orderDirn = $this -> state -> get ( 'list.direction' , 'asc' );
if ( $orderCol != '' )
{
$query -> order ( $db -> escape ( $orderCol . ' ' . $orderDirn ));
}
return $query ;
}
/**
* Method to get list export data .
*
* @ return mixed An array of data items on success , false on failure .
*/
public function getExportData ( $pks )
{
// setup the query
if ( ComponentbuilderHelper :: checkArray ( $pks ))
{
2016-06-03 06:28:32 +00:00
// Set a value to know this is exporting method.
$_export = true ;
2016-01-30 20:28:43 +00:00
// Get the user object.
$user = JFactory :: getUser ();
// Create a new query object.
$db = JFactory :: getDBO ();
$query = $db -> getQuery ( true );
// Select some fields
$query -> select ( 'a.*' );
// From the componentbuilder_help_document table
$query -> from ( $db -> quoteName ( '#__componentbuilder_help_document' , 'a' ));
$query -> where ( 'a.id IN (' . implode ( ',' , $pks ) . ')' );
// Order the results by ordering
$query -> order ( 'a.ordering ASC' );
// Load the items
$db -> setQuery ( $query );
$db -> execute ();
if ( $db -> getNumRows ())
{
$items = $db -> loadObjectList ();
// set values to display correctly.
if ( ComponentbuilderHelper :: checkArray ( $items ))
{
// get user object.
$user = JFactory :: getUser ();
foreach ( $items as $nr => & $item )
{
$access = ( $user -> authorise ( 'help_document.access' , 'com_componentbuilder.help_document.' . ( int ) $item -> id ) && $user -> authorise ( 'help_document.access' , 'com_componentbuilder' ));
if ( ! $access )
{
unset ( $items [ $nr ]);
continue ;
}
// unset the values we don't want exported.
unset ( $item -> asset_id );
unset ( $item -> checked_out );
unset ( $item -> checked_out_time );
}
}
// Add headers to items array.
$headers = $this -> getExImPortHeaders ();
if ( ComponentbuilderHelper :: checkObject ( $headers ))
{
array_unshift ( $items , $headers );
}
return $items ;
}
}
return false ;
}
/**
* Method to get header .
*
* @ return mixed An array of data items on success , false on failure .
*/
public function getExImPortHeaders ()
{
// Get a db connection.
$db = JFactory :: getDbo ();
// get the columns
$columns = $db -> getTableColumns ( " #__componentbuilder_help_document " );
if ( ComponentbuilderHelper :: checkArray ( $columns ))
{
// remove the headers you don't import/export.
unset ( $columns [ 'asset_id' ]);
unset ( $columns [ 'checked_out' ]);
unset ( $columns [ 'checked_out_time' ]);
$headers = new stdClass ();
foreach ( $columns as $column => $type )
{
$headers -> { $column } = $column ;
}
return $headers ;
}
return false ;
}
/**
* Method to get a store id based on model configuration state .
*
* @ return string A store id .
*
*/
protected function getStoreId ( $id = '' )
{
// Compile the store id.
$id .= ':' . $this -> getState ( 'filter.id' );
$id .= ':' . $this -> getState ( 'filter.search' );
$id .= ':' . $this -> getState ( 'filter.published' );
$id .= ':' . $this -> getState ( 'filter.ordering' );
$id .= ':' . $this -> getState ( 'filter.created_by' );
$id .= ':' . $this -> getState ( 'filter.modified_by' );
$id .= ':' . $this -> getState ( 'filter.title' );
$id .= ':' . $this -> getState ( 'filter.type' );
$id .= ':' . $this -> getState ( 'filter.location' );
$id .= ':' . $this -> getState ( 'filter.admin_view' );
$id .= ':' . $this -> getState ( 'filter.site_view' );
return parent :: getStoreId ( $id );
}
/**
* Build an SQL query to checkin all items left checked out longer then a set time .
*
* @ return a bool
*
*/
2016-02-26 12:46:15 +00:00
protected function checkInNow ()
2016-01-30 20:28:43 +00:00
{
// Get set check in time
$time = JComponentHelper :: getParams ( 'com_componentbuilder' ) -> get ( 'check_in' );
if ( $time )
{
// Get a db connection.
$db = JFactory :: getDbo ();
// reset query
$query = $db -> getQuery ( true );
$query -> select ( '*' );
$query -> from ( $db -> quoteName ( '#__componentbuilder_help_document' ));
$db -> setQuery ( $query );
$db -> execute ();
if ( $db -> getNumRows ())
{
// Get Yesterdays date
$date = JFactory :: getDate () -> modify ( $time ) -> toSql ();
// reset query
$query = $db -> getQuery ( true );
// Fields to update.
$fields = array (
$db -> quoteName ( 'checked_out_time' ) . '=\'0000-00-00 00:00:00\'' ,
$db -> quoteName ( 'checked_out' ) . '=0'
);
// Conditions for which records should be updated.
$conditions = array (
$db -> quoteName ( 'checked_out' ) . '!=0' ,
$db -> quoteName ( 'checked_out_time' ) . '<\'' . $date . '\''
);
// Check table
$query -> update ( $db -> quoteName ( '#__componentbuilder_help_document' )) -> set ( $fields ) -> where ( $conditions );
$db -> setQuery ( $query );
$db -> execute ();
}
}
return false ;
}
}