Your IP : 216.73.216.182
<?php
namespace JExtstore\Component\JChat\Administrator\Framework;
/**
*
* @package JCHAT::FRAMEWORK::administrator::components::com_jchat
* @subpackage framework
* @subpackage model
* @author Joomla! Extensions Store
* @copyright (C) 2024 - Joomla! Extensions Store
* @license GNU/GPLv2 http://www.gnu.org/licenses/gpl-2.0.html
*/
defined ( '_JEXEC' ) or die ( 'Restricted access' );
use Joomla\CMS\MVC\Factory\MVCFactoryInterface;
use Joomla\CMS\Table\Table;
use Joomla\CMS\Table\Nested as TableNested;
use Joomla\CMS\MVC\Model\BaseDatabaseModel as JBaseModel;
use Joomla\CMS\Cache\Controller\CallbackController;
use Joomla\Registry\Registry;
use Joomla\CMS\Factory;
use Joomla\CMS\Language\Text;
use Joomla\CMS\HTML\HTMLHelper;
use Joomla\CMS\Component\ComponentHelper;
use JExtstore\Component\JChat\Administrator\Framework\Exception\Exceptions;
use JExtstore\Component\JChat\Administrator\Framework\Helpers\Html as JChatHelpersHtml;
use JExtstore\Component\JChat\Administrator\Framework\Exception as JChatException;
/**
* Base model responsibilities
*
* @package JCHAT::FRAMEWORK::administrator::components::com_jchat
* @subpackage framework
* @subpackage model
* @since 2.0
*/
interface IJChatModel {
/**
* Main get data method
*
* @access public
* @return Object[]
*/
public function getData(): array;
/**
* Counter result set
*
* @access public
* @return int
*/
public function getTotal(): int;
/**
* Load entity from ORM table
*
* @access public
* @param int $id
* @return mixed Object on success or false on failure
*/
public function loadEntity($id);
/**
* Cancel editing entity
*
* @param int $id
* @access public
* @return bool
*/
public function cancelEntity($id): bool;
/**
* Delete entity
*
* @param array $ids
* @access public
* @return mixed May be bool or array based on the inherited models, defined by them case by case
*/
public function deleteEntity($ids);
/**
* Storing entity by ORM table
*
* @access public
* @param bool $updateNulls
* @return mixed Object on success or false on failure
*/
public function storeEntity($updateNulls = false);
/**
* Publishing state changer for entities
*
* @access public
* @param int $idEntity
* @param string $state
* @return bool
*/
public function publishEntities($idEntity, $state): bool;
/**
* Change entities ordering
*
* @access public
* @param int $idEntity
* @param string $state
* @return bool
*/
public function changeOrder($idEntity, $direction): bool;
/**
* Method to move and reorder
*
* @access public
* @return bool
*/
public function saveOrder($cid, $order): bool;
/**
* Copy existing entity
*
* @param int $id
* @access public
* @return bool
*/
public function copyEntity($ids): bool;
/**
* Return select lists used as filter for listEntities
*
* @access public
* @return array
*/
public function getFilters(): array;
/**
* Return select lists used as filter for editEntity
*
* @access public
* @param Object $record
* @return array
*/
public function getLists($record = null): array;
/**
* Get the component params width view override/merge
*
* @access public
* @return Object Registry
*/
public function getComponentParams(): Registry;
}
/**
* Base concrete model for business logic
*
* @package JCHAT::FRAMEWORK::administrator::components::com_jchat
* @subpackage framework
* @subpackage model
* @since 2.0
*/
class Model extends JBaseModel implements IJChatModel {
use Exceptions;
/**
* Application reference
*
* @access protected
* @var Object
*/
protected $app;
/**
* User reference
*
* @access protected
* @var Object
*/
protected $user;
/**
* Database reference
*
* @access protected
* @var Object
*/
protected $dbInstance;
/**
* Component params with view override
*
* @access protected
* @var Object
*/
protected $componentParams;
/**
* Variables in request array
*
* @access protected
* @var Object
*/
protected $requestArray;
/**
* Variables in request array name for files
*
* @access protected
* @var Object
*/
protected $requestFilesName;
/**
* Variables in session array name
*
* @access protected
* @var Object
*/
protected $sessionName;
/**
* Get a cache object specific for this extension models already configured and independant from global config
* The cache handler is always callback to cache functions operations and SQL database queries
*
* @access protected
* @return CallbackController
*/
protected function getExtensionCache(): CallbackController {
// Static cache instance
static $cache;
if (is_object ( $cache )) {
return $cache;
}
$conf = $this->app->getConfig ();
$componentParams = $this->getComponentParams();
$options = array (
'defaultgroup' => $this->option,
'cachebase' => $conf->get ( 'cache_path', JPATH_CACHE ),
'lifetime' => ( int ) $componentParams->get ( 'cache_lifetime', 24 ) * 60, // hours to minutes (core cache multiplies by 60 secs), default 24 hours
'language' => $conf->get ( 'language', 'en-GB' ),
'storage' => $conf->get ( 'cache_handler', 'file' )
);
$cache = Factory::getContainer()->get(\Joomla\CMS\Cache\CacheControllerFactoryInterface::class)->createCacheController( 'callback', $options );
$cache->setCaching ( $componentParams->get ( 'caching', false ) );
return $cache;
}
/**
* Create the filename for a resource
*
* @param string $type
* The resource type to create the filename for.
* @param array $parts
* An associative array of filename information.
*
* @return string The filename
*
* @since 3.0
*/
protected static function _createFileName($type, $parts = array()): string {
$filename = '';
switch ($type) {
case 'model' :
$filename = strtolower ( $parts ['name'] ) . '.php';
break;
}
return $filename;
}
/**
* Main get data method
*
* @access public
* @return Object[]
*/
public function getData(): array {
// Build query
$query = $this->buildListQuery ();
try {
$dbQuery = method_exists ( $this->dbInstance, 'createQuery' ) ? $this->dbInstance->createQuery () : $this->dbInstance->getQuery ( true );
$dbQuery->setQuery ( $query )->setLimit ( $this->getState ( 'limit' ), $this->getState ( 'limitstart' ) );
$this->dbInstance->setQuery ( $dbQuery );
$result = $this->dbInstance->loadObjectList ();
} catch ( JChatException $e ) {
$this->app->enqueueMessage ( $e->getMessage (), $e->getExceptionLevel () );
$result = array ();
} catch ( \Exception $e ) {
$jchatException = new JChatException ( $e->getMessage (), 'error' );
$this->app->enqueueMessage ( $jchatException->getMessage (), $jchatException->getExceptionLevel () );
$result = array ();
}
return $result;
}
/**
* Counter result set
*
* @access public
* @return int
*/
public function getTotal(): int {
// Build query
$result = 0;
$query = $this->buildListQuery ();
try {
$this->dbInstance->setQuery ( $query );
$result = count ( $this->dbInstance->loadColumn () );
} catch ( \Exception $e ) {
$jchatException = new JChatException ( $e->getMessage (), 'error' );
$this->app->enqueueMessage ( $jchatException->getMessage (), $jchatException->getExceptionLevel () );
$result = 0;
}
return $result;
}
/**
* Load entity from ORM table
*
* @access public
* @param int $id
* @return mixed Object on success or false on failure
*/
public function loadEntity($id) {
// load table record
$table = $this->getTable ( $this->getName (), 'Administrator' );
// Check for previously set post data after errors
$context = implode ( '.', array (
$this->getState ( 'option' ),
$this->getName (),
'errordataload'
) );
$sessionData = $this->app->getUserState ( $context );
try {
// Give priority to session recovered data
if (! $sessionData) {
// Load normally from database
if (! $table->load ( $id )) {
throw new JChatException ( Text::_ ( 'COM_JCHAT_ERROR_RECORD_NOT_FOUND' ), 'error' );
}
} else {
// Recover and bind/load from session
$table->bind ( $sessionData, array (), false, true );
// Delete session data for next request
$this->app->setUserState ( $context, null );
}
} catch ( JChatException $e ) {
$this->setException ( $e );
return false;
} catch ( \Exception $e ) {
$jchatException = new JChatException ( $e->getMessage (), 'error' );
$this->setException ( $jchatException );
return false;
}
return $table;
}
/**
* Cancel editing entity
*
* @param int $id
* @access public
* @return bool
*/
public function cancelEntity($id): bool {
// New record - do null e return true subito
if (! $id) {
return true;
}
$table = $this->getTable ( $this->getName (), 'Administrator' );
try {
if (! $table->load ( $id )) {
throw new JChatException ( Text::_ ( 'COM_JCHAT_ERROR_RECORD_NOT_FOUND' ), 'error' );
}
$table->checkin ();
} catch ( JChatException $e ) {
$this->setException ( $e );
return false;
} catch ( \Exception $e ) {
$jchatException = new JChatException ( $e->getMessage (), 'error' );
$this->setException ( $jchatException );
return false;
}
return true;
}
/**
* Delete entity
*
* @param array $ids
* @access public
* @return mixed May be bool or array based on the inherited models, defined by them case by case
*/
public function deleteEntity($ids) {
$table = $this->getTable ( $this->getName (), 'Administrator' );
// Ciclo su ogni entity da cancellare
if (is_array ( $ids ) && count ( $ids )) {
foreach ( $ids as $id ) {
try {
if (! $table->delete ( $id )) {
throw new JChatException ( $table->getException (), 'error' );
}
// Only if table supports ordering
if (property_exists ( $table, 'ordering' )) {
$table->reorder ();
}
} catch ( JChatException $e ) {
$this->setException ( $e );
return false;
} catch ( \Exception $e ) {
$jchatException = new JChatException ( $e->getMessage (), 'error' );
$this->setException ( $jchatException );
return false;
}
}
}
return true;
}
/**
* Storing entity by ORM table
*
* @access public
* @param bool $updateNulls
* @return mixed Object on success or false on failure
*/
public function storeEntity($updateNulls = false) {
$table = $this->getTable ( $this->getName (), 'Administrator' );
try {
// Bind override aware, supports true as second param to distinguish when bind is store/load, has not side effect on original ignore array
$table->bind ( $this->requestArray, array (), true );
// Run validation server side
if (! $table->check ()) {
throw new JChatException ( $table->getException (), 'error' );
}
// By default, never update nulls
if (! $table->store ( $updateNulls )) {
throw new JChatException ( $table->getException (), 'error' );
}
// Only if table supports ordering
if (property_exists ( $table, 'ordering' )) {
$where = null;
$catidOrdering = property_exists ( $table, 'catid' );
if ($catidOrdering) {
$where = 'catid = ' . $table->catid;
}
$table->reorder ( $where );
}
} catch ( JChatException $e ) {
$this->setException ( $e );
return false;
} catch ( \Exception $e ) {
$jchatException = new JChatException ( $e->getMessage (), 'error' );
$this->setException ( $jchatException );
return false;
}
return $table;
}
/**
* Publishing state changer for entities
*
* @access public
* @param int $idEntity
* @param string $state
* @return bool
*/
public function publishEntities($idEntity, $state): bool {
// Table load
$table = $this->getTable ( $this->getName (), 'Administrator' );
if (isset ( $idEntity ) && $idEntity) {
try {
// Ensure treat as array
if (! is_array ( $idEntity )) {
$idEntity = array (
$idEntity
);
}
$state = $state == 'unpublish' ? 0 : 1;
if (! $table->publish ( $idEntity, $state, $this->user->id )) {
throw new JChatException ( $table->getException (), 'notice' );
}
} catch ( JChatException $e ) {
$this->setException ( $e );
return false;
} catch ( \Exception $e ) {
$jchatException = new JChatException ( $e->getMessage (), 'notice' );
$this->setException ( $jchatException );
return false;
}
}
return true;
}
/**
* Change entities ordering
*
* @access public
* @param int $idEntity
* @param int $direction
* @return bool
*/
public function changeOrder($idEntity, $direction): bool {
$where = null;
if (isset ( $idEntity ) && $idEntity) {
try {
$table = $this->getTable ( $this->getName (), 'Administrator' );
if (! $table->load ( ( int ) $idEntity )) {
throw new JChatException ( Text::_ ( 'COM_JCHAT_ERROR_RECORD_NOT_FOUND' ), 'notice' );
}
// Check if ordering where by cats is required
if (property_exists ( $table, 'catid' )) {
$where = 'catid = ' . $table->catid;
}
if (! $table->move ( $direction, $where )) {
throw new JChatException ( $table->getException (), 'notice' );
}
} catch ( JChatException $e ) {
$this->setException ( $e );
return false;
} catch ( \Exception $e ) {
$jchatException = new JChatException ( $e->getMessage (), 'notice' );
$this->setException ( $jchatException );
return false;
}
}
return true;
}
/**
* Method to move and reorder
*
* @access public
* @param array $cid
* @param array $order
* @return bool
*/
public function saveOrder($cid, $order): bool {
if (is_array ( $cid ) && count ( $cid )) {
try {
$table = $this->getTable ( $this->getName (), 'Administrator' );
$singleReorder = ! (property_exists ( $table, 'catid' ));
// If TableNested demand to table class the saveorder algo
if ($table instanceof TableNested) {
if (! $table->saveorder ( $cid, $order )) {
throw new JChatException ( $table->getException (), 'notice' );
}
} else {
// update ordering values
$conditions = array ();
for($i = 0; $i < count ( $cid ); $i ++) {
$table->load ( ( int ) $cid [$i] );
if ($table->ordering != $order [$i]) {
$table->ordering = $order [$i];
if (! $table->store ()) {
throw new JChatException ( $table->getException (), 'notice' );
}
}
if(!$singleReorder) {
// Remember to reorder within position and client_id
$condition = 'catid = ' . @$table->catid;
$found = false;
foreach ( $conditions as $cond ) {
if ($cond [1] == $condition) {
$found = true;
break;
}
}
if (! $found) {
$key = $table->getKeyName ();
$conditions [] = array (
$table->$key,
$condition
);
}
}
}
}
} catch ( JChatException $e ) {
$this->setException ( $e );
return false;
} catch ( \Exception $e ) {
$jchatException = new JChatException ( $e->getMessage (), 'notice' );
$this->setException ( $jchatException );
return false;
}
// All went well
try {
if (! $table instanceof TableNested && ! $singleReorder) {
// Execute reorder for each category.
foreach ( $conditions as $cond ) {
$table->load ( $cond [0] );
$table->reorder ( $cond [1] );
}
} elseif (! $table instanceof TableNested && $singleReorder) {
$table->reorder ();
}
} catch ( \Exception $e ) {
$jchatException = new JChatException ( $e->getMessage (), 'notice' );
$this->setException ( $jchatException );
return false;
}
}
return true;
}
/**
* Copy existing entity
*
* @param int $id
* @access public
* @return bool
*/
public function copyEntity($ids): bool {
if (is_array ( $ids ) && count ( $ids )) {
$table = $this->getTable ( $this->getName (), 'Administrator' );
try {
foreach ( $ids as $id ) {
if ($table->load ( ( int ) $id )) {
$table->id = 0;
$table->name = Text::_ ( 'COM_JCHAT_COPYOF' ) . $table->name;
$table->published = 0;
$table->params = $table->params->toString ();
if (! $table->store ()) {
throw new JChatException ( $table->getException (), 'error' );
}
} else {
throw new JChatException ( Text::_ ( 'COM_JCHAT_ERROR_RECORD_NOT_FOUND' ), 'error' );
}
}
$table->reorder ();
} catch ( JChatException $e ) {
$this->setException ( $e );
return false;
} catch ( \Exception $e ) {
$jchatException = new JChatException ( $e->getMessage (), 'error' );
$this->setException ( $jchatException );
return false;
}
}
return true;
}
/**
* Return select lists used as filter for listEntities
*
* @access public
* @return array
*/
public function getFilters(): array {
$filters = [];
$filters ['state'] = HTMLHelper::_ ( 'grid.state', $this->getState ( 'state' ) );
return $filters;
}
/**
* Return select lists used as filter for editEntity
*
* @access public
* @param Object $record
* @return array
*/
public function getLists($record = null): array {
$lists = [];
// Grid states
$lists ['published'] = JChatHelpersHtml::booleanlist ( 'published', null, $record->published );
return $lists;
}
/**
* Get the component params width view override/merge
*
* @access public
* @return Object Registry
*/
public function getComponentParams(): Registry {
if (is_object ( $this->componentParams )) {
return $this->componentParams;
}
// Manage Site and Admin application instance to call params with view overrides when needed
if (isset($this->app) && $this->app->isClient('site') && $this->option == 'com_jchat') {
$this->componentParams = $this->app->getParams ( 'com_jchat' );
} else {
$this->componentParams = ComponentHelper::getParams ( 'com_jchat' );
}
return $this->componentParams;
}
/**
* Class constructor
*
* @access public
* @param $config array
* @return Object&
*/
public function __construct($config = array(), ?MVCFactoryInterface $factory = null) {
parent::__construct ( $config, $factory );
// Add include paths to the Table class
Table::addIncludePath ( JPATH_ROOT . '/administrator/components/com_jchat/Table' );
$this->app = Factory::getApplication ();
$this->user = $this->app->getIdentity();
$this->requestArray = &$_POST;
$this->requestFilesName = &$_FILES;
$this->sessionName = &$_SESSION;
// Joomla 4.2+
if(method_exists($this, 'getDatabase')) {
$this->dbInstance = $this->getDatabase();
} else {
$this->dbInstance = $this->getDbo();
}
}
}