2022-03-09 23:46:45 +00:00
< ? php
/**
* @ package Joomla . Component . Builder
*
2024-03-02 20:10:30 +00:00
* @ created 4 th September 2022
* @ author Llewellyn van der Merwe < https :// dev . vdm . io >
* @ git Joomla Component Builder < https :// git . vdm . dev / joomla / Component - Builder >
2022-03-09 23:46:45 +00:00
* @ copyright Copyright ( C ) 2015 Vast Development Method . All rights reserved .
* @ license GNU General Public License version 2 or later ; see LICENSE . txt
*/
2024-03-02 20:10:30 +00:00
// No direct access to this JCB template file (EVER)
defined ( '_JCB_TEMPLATE' ) or die ;
2022-03-09 23:46:45 +00:00
?>
###BOM###
2024-03-02 20:10:30 +00:00
namespace ###NAMESPACEPREFIX###\Component\###ComponentNameSpace###\Administrator\Helper;
2022-03-09 23:46:45 +00:00
2024-03-02 20:10:30 +00:00
###ADMIN_POWER_HELPER###
2022-03-09 23:46:45 +00:00
###ADMIN_HELPER_CLASS_HEADER###
2024-03-02 20:10:30 +00:00
// No direct access to this file
\defined ( '_JEXEC' ) or die ;
2022-03-09 23:46:45 +00:00
/**
* ###Component### component helper.
2024-03-02 20:10:30 +00:00
*
* @ since 3.0
2022-03-09 23:46:45 +00:00
*/
abstract class # # # Component ###Helper
{
/**
2024-03-02 20:10:30 +00:00
* Composer Switch
2022-05-16 04:27:50 +00:00
*
2024-03-02 20:10:30 +00:00
* @ var array
2022-05-16 04:27:50 +00:00
*/
2024-03-02 20:10:30 +00:00
protected static $composer = [];
2022-05-16 04:27:50 +00:00
2022-03-09 23:46:45 +00:00
/**
2024-03-02 20:10:30 +00:00
* The Main Active Language
*
* @ var string
2022-03-09 23:46:45 +00:00
*/
2024-03-02 20:10:30 +00:00
public static $langTag ; ###ADMIN_GLOBAL_EVENT_HELPER######CUSTOM_HELPER_SCRIPT######BOTH_CUSTOM_HELPER_SCRIPT###
2022-03-09 23:46:45 +00:00
/**
* Load the Composer Vendors
*/
public static function composerAutoload ( $target )
{
// insure we load the composer vendor only once
if ( ! isset ( self :: $composer [ $target ]))
{
// get the function name
2024-03-02 20:10:30 +00:00
$functionName = Super___1f28cb53_60d9_4db1_b517_3c7dc6b429ef___Power :: safe ( 'compose' . $target );
2022-03-09 23:46:45 +00:00
// check if method exist
if ( method_exists ( __CLASS__ , $functionName ))
{
return self :: { $functionName }();
}
return false ;
}
return self :: $composer [ $target ];
}
/**
* Load the Component xml manifest .
*/
public static function manifest ()
{
$manifestUrl = JPATH_ADMINISTRATOR . " /components/com_###component###/###component###.xml " ;
return simplexml_load_file ( $manifestUrl );
}
/**
* Joomla version object
2024-03-02 20:10:30 +00:00
*/
2022-03-09 23:46:45 +00:00
protected static $JVersion ;
/**
* set / get Joomla version
*/
public static function jVersion ()
{
// check if set
2024-03-02 20:10:30 +00:00
if ( ! Super___91004529_94a9_4590_b842_e7c6b624ecf5___Power :: check ( self :: $JVersion ))
2022-03-09 23:46:45 +00:00
{
2024-03-02 20:10:30 +00:00
self :: $JVersion = new Version ();
2022-03-09 23:46:45 +00:00
}
return self :: $JVersion ;
}
/**
* Load the Contributors details .
*/
public static function getContributors ()
{
// get params
2024-03-02 20:10:30 +00:00
$params = ComponentHelper :: getParams ( 'com_###component###' );
2022-03-09 23:46:45 +00:00
// start contributors array
2024-03-02 20:10:30 +00:00
$contributors = [];
2022-03-09 23:46:45 +00:00
// get all Contributors (max 20)
$searchArray = range ( '0' , '20' );
foreach ( $searchArray as $nr )
2024-03-02 20:10:30 +00:00
{
2022-03-09 23:46:45 +00:00
if (( NULL !== $params -> get ( " showContributor " . $nr )) && ( $params -> get ( " showContributor " . $nr ) == 1 || $params -> get ( " showContributor " . $nr ) == 3 ))
{
// set link based of selected option
if ( $params -> get ( " useContributor " . $nr ) == 1 )
2024-03-02 20:10:30 +00:00
{
2022-03-09 23:46:45 +00:00
$link_front = '<a href="mailto:' . $params -> get ( " emailContributor " . $nr ) . '" target="_blank">' ;
$link_back = '</a>' ;
}
elseif ( $params -> get ( " useContributor " . $nr ) == 2 )
{
$link_front = '<a href="' . $params -> get ( " linkContributor " . $nr ) . '" target="_blank">' ;
$link_back = '</a>' ;
}
else
{
$link_front = '' ;
$link_back = '' ;
}
2024-03-02 20:10:30 +00:00
$contributors [ $nr ][ 'title' ] = Super___1f28cb53_60d9_4db1_b517_3c7dc6b429ef___Power :: html ( $params -> get ( " titleContributor " . $nr ));
$contributors [ $nr ][ 'name' ] = $link_front . Super___1f28cb53_60d9_4db1_b517_3c7dc6b429ef___Power :: html ( $params -> get ( " nameContributor " . $nr )) . $link_back ;
2022-03-09 23:46:45 +00:00
}
}
return $contributors ;
} ###HELP###
/**
* Configure the Linkbar .
*/
public static function addSubmenu ( $submenu )
{
// load user for access menus
2024-03-02 20:10:30 +00:00
$user = Factory :: getApplication () -> getIdentity ();
2022-03-09 23:46:45 +00:00
// load the submenus to sidebar
###SUBMENU###
} ###HELPER_CREATEUSER######HELPER_UIKIT######HELPER_EXEL###
2024-03-02 20:10:30 +00:00
/**
* Get a Variable
*
* @ param string $table The table from which to get the variable
* @ param string $where The value where
* @ param string $whereString The target / field string where / name
* @ param string $what The return field
* @ param string $operator The operator between $whereString / field and $where / value
* @ param string $main The component in which the table is found
*
* @ return mix string / int / float
* @ deprecated 3.3 Use Super___db87c339_5bb6_4291_a7ef_2c48ea1b06bc___Power :: var ( ... );
*/
public static function getVar ( $table , $where = null , $whereString = 'user' , $what = 'id' , $operator = '=' , $main = '###component###' )
{
return Super___db87c339_5bb6_4291_a7ef_2c48ea1b06bc___Power :: var (
$table ,
$where ,
$whereString ,
$what ,
$operator ,
$main
);
}
/**
* Get array of variables
*
* @ param string $table The table from which to get the variables
* @ param string $where The value where
* @ param string $whereString The target / field string where / name
* @ param string $what The return field
* @ param string $operator The operator between $whereString / field and $where / value
* @ param string $main The component in which the table is found
* @ param bool $unique The switch to return a unique array
*
* @ return array
* @ deprecated 3.3 Use Super___db87c339_5bb6_4291_a7ef_2c48ea1b06bc___Power :: vars ( ... );
*/
public static function getVars ( $table , $where = null , $whereString = 'user' , $what = 'id' , $operator = 'IN' , $main = '###component###' , $unique = true )
{
return Super___db87c339_5bb6_4291_a7ef_2c48ea1b06bc___Power :: vars (
$table ,
$where ,
$whereString ,
$what ,
$operator ,
$main ,
$unique
);
}
/**
* Convert a json object to a string
*
* @ input string $value The json string to convert
*
* @ returns a string
* @ deprecated 3.3 Use Super___4b225c51_d293_48e4_b3f6_5136cf5c3f18___Power :: string ( ... );
*/
public static function jsonToString ( $value , $sperator = " , " , $table = null , $id = 'id' , $name = 'name' )
{
return Super___4b225c51_d293_48e4_b3f6_5136cf5c3f18___Power :: string (
$value ,
$sperator ,
$table ,
$id ,
$name
);
}
2022-03-09 23:46:45 +00:00
public static function isPublished ( $id , $type )
{
if ( $type == 'raw' )
{
$type = 'item' ;
}
2024-03-02 20:10:30 +00:00
$db = Factory :: getContainer () -> get ( DatabaseInterface :: class );
2022-03-09 23:46:45 +00:00
$query = $db -> getQuery ( true );
$query -> select ( array ( 'a.published' ));
$query -> from ( '#__###component###_' . $type . ' AS a' );
$query -> where ( 'a.id = ' . ( int ) $id );
$query -> where ( 'a.published = 1' );
$db -> setQuery ( $query );
$db -> execute ();
$found = $db -> getNumRows ();
if ( $found )
{
return true ;
}
return false ;
}
public static function getGroupName ( $id )
{
2024-03-02 20:10:30 +00:00
$db = Factory :: getContainer () -> get ( DatabaseInterface :: class );
2022-03-09 23:46:45 +00:00
$query = $db -> getQuery ( true );
$query -> select ( array ( 'a.title' ));
$query -> from ( '#__usergroups AS a' );
$query -> where ( 'a.id = ' . ( int ) $id );
$db -> setQuery ( $query );
$db -> execute ();
$found = $db -> getNumRows ();
if ( $found )
2024-03-02 20:10:30 +00:00
{
2022-03-09 23:46:45 +00:00
return $db -> loadResult ();
}
return $id ;
}
/**
* Get the action permissions
*
* @ param string $view The related view name
* @ param int $record The item to act upon
* @ param string $views The related list view name
* @ param mixed $target Only get this permission ( like edit , create , delete )
* @ param string $component The target component
* @ param object $user The user whose permissions we are loading
*
2024-03-02 20:10:30 +00:00
* @ return object The CMSObject of permission / authorised actions
*
2022-03-09 23:46:45 +00:00
*/
public static function getActions ( $view , & $record = null , $views = null , $target = null , $component = '###component###' , $user = 'null' )
{
// load the user if not given
2024-03-02 20:10:30 +00:00
if ( ! Super___91004529_94a9_4590_b842_e7c6b624ecf5___Power :: check ( $user ))
2022-03-09 23:46:45 +00:00
{
// get the user object
2024-03-02 20:10:30 +00:00
$user = Factory :: getApplication () -> getIdentity ();
2022-03-09 23:46:45 +00:00
}
2024-03-02 20:10:30 +00:00
// load the CMSObject
$result = new CMSObject ;
2022-03-09 23:46:45 +00:00
// make view name safe (just incase)
2024-03-02 20:10:30 +00:00
$view = Super___1f28cb53_60d9_4db1_b517_3c7dc6b429ef___Power :: safe ( $view );
if ( Super___1f28cb53_60d9_4db1_b517_3c7dc6b429ef___Power :: check ( $views ))
2022-03-09 23:46:45 +00:00
{
2024-03-02 20:10:30 +00:00
$views = Super___1f28cb53_60d9_4db1_b517_3c7dc6b429ef___Power :: safe ( $views );
}
2022-03-09 23:46:45 +00:00
// get all actions from component
2024-03-02 20:10:30 +00:00
$actions = Access :: getActionsFromFile (
2022-03-09 23:46:45 +00:00
JPATH_ADMINISTRATOR . '/components/com_' . $component . '/access.xml' ,
" /access/section[@name='component']/ "
);
2024-03-02 20:10:30 +00:00
// if non found then return empty CMSObject
2022-03-09 23:46:45 +00:00
if ( empty ( $actions ))
{
return $result ;
}
// get created by if not found
2024-03-02 20:10:30 +00:00
if ( Super___91004529_94a9_4590_b842_e7c6b624ecf5___Power :: check ( $record ) && ! isset ( $record -> created_by ) && isset ( $record -> id ))
2022-03-09 23:46:45 +00:00
{
2024-03-02 20:10:30 +00:00
$record -> created_by = Super___db87c339_5bb6_4291_a7ef_2c48ea1b06bc___Power :: var ( $view , $record -> id , 'id' , 'created_by' , '=' , $component );
2022-03-09 23:46:45 +00:00
}
// set actions only set in component settings
$componentActions = array ( 'core.admin' , 'core.manage' , 'core.options' , 'core.export' );
// check if we have a target
$checkTarget = false ;
if ( $target )
{
// convert to an array
2024-03-02 20:10:30 +00:00
if ( Super___1f28cb53_60d9_4db1_b517_3c7dc6b429ef___Power :: check ( $target ))
2022-03-09 23:46:45 +00:00
{
$target = array ( $target );
}
// check if we are good to go
2024-03-02 20:10:30 +00:00
if ( Super___0a59c65c_9daf_4bc9_baf4_e063ff9e6a8a___Power :: check ( $target ))
2022-03-09 23:46:45 +00:00
{
$checkTarget = true ;
}
}
// loop the actions and set the permissions
foreach ( $actions as $action )
{
// check target action filter
if ( $checkTarget && self :: filterActions ( $view , $action -> name , $target ))
{
continue ;
}
// set to use component default
$fallback = true ;
// reset permission per/action
$permission = false ;
$catpermission = false ;
// set area
$area = 'comp' ;
// check if the record has an ID and the action is item related (not a component action)
2024-03-02 20:10:30 +00:00
if ( Super___91004529_94a9_4590_b842_e7c6b624ecf5___Power :: check ( $record ) && isset ( $record -> id ) && $record -> id > 0 && ! in_array ( $action -> name , $componentActions ) &&
2022-03-09 23:46:45 +00:00
( strpos ( $action -> name , 'core.' ) !== false || strpos ( $action -> name , $view . '.' ) !== false ))
{
// we are in item
$area = 'item' ;
// The record has been set. Check the record permissions.
$permission = $user -> authorise ( $action -> name , 'com_' . $component . '.' . $view . '.' . ( int ) $record -> id );
// if no permission found, check edit own
if ( ! $permission )
{
// With edit, if the created_by matches current user then dig deeper.
if (( $action -> name === 'core.edit' || $action -> name === $view . '.edit' ) && $record -> created_by > 0 && ( $record -> created_by == $user -> id ))
{
// the correct target
$coreCheck = ( array ) explode ( '.' , $action -> name );
// check that we have both local and global access
if ( $user -> authorise ( $coreCheck [ 0 ] . '.edit.own' , 'com_' . $component . '.' . $view . '.' . ( int ) $record -> id ) &&
$user -> authorise ( $coreCheck [ 0 ] . '.edit.own' , 'com_' . $component ))
{
// allow edit
$result -> set ( $action -> name , true );
// set not to use global default
// because we already validated it
$fallback = false ;
}
else
{
// do not allow edit
$result -> set ( $action -> name , false );
$fallback = false ;
}
}
}
2024-03-02 20:10:30 +00:00
elseif ( Super___1f28cb53_60d9_4db1_b517_3c7dc6b429ef___Power :: check ( $views ) && isset ( $record -> catid ) && $record -> catid > 0 )
2022-03-09 23:46:45 +00:00
{
// we are in item
$area = 'category' ;
// set the core check
$coreCheck = explode ( '.' , $action -> name );
$core = $coreCheck [ 0 ];
// make sure we use the core. action check for the categories
if ( strpos ( $action -> name , $view ) !== false && strpos ( $action -> name , 'core.' ) === false )
{
$coreCheck [ 0 ] = 'core' ;
$categoryCheck = implode ( '.' , $coreCheck );
}
else
{
$categoryCheck = $action -> name ;
}
// The record has a category. Check the category permissions.
$catpermission = $user -> authorise ( $categoryCheck , 'com_' . $component . '.' . $views . '.category.' . ( int ) $record -> catid );
if ( ! $catpermission && ! is_null ( $catpermission ))
{
// With edit, if the created_by matches current user then dig deeper.
if (( $action -> name === 'core.edit' || $action -> name === $view . '.edit' ) && $record -> created_by > 0 && ( $record -> created_by == $user -> id ))
{
// check that we have both local and global access
if ( $user -> authorise ( 'core.edit.own' , 'com_' . $component . '.' . $views . '.category.' . ( int ) $record -> catid ) &&
$user -> authorise ( $core . '.edit.own' , 'com_' . $component ))
{
// allow edit
$result -> set ( $action -> name , true );
// set not to use global default
// because we already validated it
$fallback = false ;
}
else
{
// do not allow edit
$result -> set ( $action -> name , false );
$fallback = false ;
}
}
}
}
}
// if allowed then fallback on component global settings
if ( $fallback )
{
// if item/category blocks access then don't fall back on global
if ((( $area === 'item' ) && ! $permission ) || (( $area === 'category' ) && ! $catpermission ))
{
// do not allow
$result -> set ( $action -> name , false );
}
// Finally remember the global settings have the final say. (even if item allow)
// The local item permissions can block, but it can't open and override of global permissions.
// Since items are created by users and global permissions is set by system admin.
else
{
$result -> set ( $action -> name , $user -> authorise ( $action -> name , 'com_' . $component ));
}
}
}
return $result ;
}
/**
* Filter the action permissions
*
* @ param string $action The action to check
* @ param array $targets The array of target actions
*
* @ return boolean true if action should be filtered out
2024-03-02 20:10:30 +00:00
*
2022-03-09 23:46:45 +00:00
*/
protected static function filterActions ( & $view , & $action , & $targets )
{
foreach ( $targets as $target )
{
if ( strpos ( $action , $view . '.' . $target ) !== false ||
strpos ( $action , 'core.' . $target ) !== false )
{
return false ;
break ;
}
}
return true ;
}
/**
2024-03-02 20:10:30 +00:00
* Returns any Model object .
*
* @ param string $type The model type to instantiate
* @ param string $prefix Prefix for the model class name . Optional .
* @ param string $component Component name the model belongs to . Optional .
* @ param array $config Configuration array for model . Optional .
*
* @ return \Joomla\CMS\MVC\Model\BaseDatabaseModel
* @ throws \Exception
* @ since 4.4
2022-03-09 23:46:45 +00:00
*/
2024-03-02 20:10:30 +00:00
public static function getModel ( string $type , string $prefix = 'Administrator' ,
string $component = '###component###' , array $config = [])
2022-03-09 23:46:45 +00:00
{
2024-03-02 20:10:30 +00:00
// make sure the name is correct
$type = Super___1f28cb53_60d9_4db1_b517_3c7dc6b429ef___Power :: safe ( $type , 'F' );
$component = strtolower ( $component );
if ( $prefix !== 'Site' && $prefix !== 'Administrator' )
2022-03-09 23:46:45 +00:00
{
2024-03-02 20:10:30 +00:00
$prefix = self :: getPrefixFromModelPath ( $prefix );
2022-03-09 23:46:45 +00:00
}
2024-03-02 20:10:30 +00:00
// Get the model through the MVCFactory
return Factory :: getApplication () -> bootComponent ( 'com_' . $component ) -> getMVCFactory () -> createModel ( $type , $prefix , $config );
}
/**
* Get the prefix from the model path
*
* @ param string $path The model path
*
* @ return string The prefix value
* @ since 4.4
*/
protected static function getPrefixFromModelPath ( string $path ) : string
{
// Check if $path starts with JPATH_ADMINISTRATOR path
if ( str_starts_with ( $path , JPATH_ADMINISTRATOR . '/components/' ))
2022-03-09 23:46:45 +00:00
{
2024-03-02 20:10:30 +00:00
return 'Administrator' ;
2022-03-09 23:46:45 +00:00
}
2024-03-02 20:10:30 +00:00
// Check if $path starts with JPATH_SITE path
elseif ( str_starts_with ( $path , JPATH_SITE . '/components/' ))
{
return 'Site' ;
}
return 'Administrator' ;
2022-03-09 23:46:45 +00:00
}
/**
* Add to asset Table
*/
public static function setAsset ( $id , $table , $inherit = true )
{
2024-03-02 20:10:30 +00:00
$parent = Table :: getInstance ( 'Asset' );
2022-03-09 23:46:45 +00:00
$parent -> loadByName ( 'com_###component###' );
2024-03-02 20:10:30 +00:00
2022-03-09 23:46:45 +00:00
$parentId = $parent -> id ;
$name = 'com_###component###.' . $table . '.' . $id ;
$title = '' ;
2024-03-02 20:10:30 +00:00
$asset = Table :: getInstance ( 'Asset' );
2022-03-09 23:46:45 +00:00
$asset -> loadByName ( $name );
// Check for an error.
$error = $asset -> getError ();
if ( $error )
{
return false ;
}
else
{
// Specify how a new or moved node asset is inserted into the tree.
if ( $asset -> parent_id != $parentId )
{
$asset -> setLocation ( $parentId , 'last-child' );
}
// Prepare the asset to be stored.
$asset -> parent_id = $parentId ;
$asset -> name = $name ;
$asset -> title = $title ;
// get the default asset rules
$rules = self :: getDefaultAssetRules ( 'com_###component###' , $table , $inherit );
2024-03-02 20:10:30 +00:00
if ( $rules instanceof AccessRules )
2022-03-09 23:46:45 +00:00
{
$asset -> rules = ( string ) $rules ;
}
if ( ! $asset -> check () || ! $asset -> store ())
{
2024-03-02 20:10:30 +00:00
Factory :: getApplication () -> enqueueMessage ( $asset -> getError (), 'warning' );
2022-03-09 23:46:45 +00:00
return false ;
}
else
{
// Create an asset_id or heal one that is corrupted.
2024-03-02 20:10:30 +00:00
$object = new \StdClass ();
2022-03-09 23:46:45 +00:00
// Must be a valid primary key value.
$object -> id = $id ;
$object -> asset_id = ( int ) $asset -> id ;
// Update their asset_id to link to the asset table.
2024-03-02 20:10:30 +00:00
return Factory :: getDbo () -> updateObject ( '#__###component###_' . $table , $object , 'id' );
2022-03-09 23:46:45 +00:00
}
}
return false ;
}
/**
* Gets the default asset Rules for a component / view .
*/
protected static function getDefaultAssetRules ( $component , $view , $inherit = true )
{
// if new or inherited
$assetId = 0 ;
// Only get the actual item rules if not inheriting
if ( ! $inherit )
{
// Need to find the asset id by the name of the component.
2024-03-02 20:10:30 +00:00
$db = Factory :: getContainer () -> get ( DatabaseInterface :: class );
2022-03-09 23:46:45 +00:00
$query = $db -> getQuery ( true )
-> select ( $db -> quoteName ( 'id' ))
-> from ( $db -> quoteName ( '#__assets' ))
-> where ( $db -> quoteName ( 'name' ) . ' = ' . $db -> quote ( $component ));
$db -> setQuery ( $query );
$db -> execute ();
// check that there is a value
if ( $db -> getNumRows ())
{
// asset already set so use saved rules
$assetId = ( int ) $db -> loadResult ();
}
}
// get asset rules
2024-03-02 20:10:30 +00:00
$result = Access :: getAssetRules ( $assetId );
if ( $result instanceof AccessRules )
2022-03-09 23:46:45 +00:00
{
$_result = ( string ) $result ;
$_result = json_decode ( $_result );
foreach ( $_result as $name => & $rule )
{
$v = explode ( '.' , $name );
if ( $view !== $v [ 0 ])
{
// remove since it is not part of this view
unset ( $_result -> $name );
}
elseif ( $inherit )
{
// clear the value since we inherit
2024-03-02 20:10:30 +00:00
$rule = [];
2022-03-09 23:46:45 +00:00
}
}
// check if there are any view values remaining
if ( count (( array ) $_result ))
{
$_result = json_encode ( $_result );
$_result = array ( $_result );
2024-03-02 20:10:30 +00:00
// Instantiate and return the AccessRules object for the asset rules.
$rules = new AccessRules ( $_result );
2022-03-09 23:46:45 +00:00
// return filtered rules
return $rules ;
}
}
return $result ;
}
/**
* xmlAppend
*
* @ param SimpleXMLElement $xml The XML element reference in which to inject a comment
* @ param mixed $node A SimpleXMLElement node to append to the XML element reference , or a stdClass object containing a comment attribute to be injected before the XML node and a fieldXML attribute containing a SimpleXMLElement
*
2023-10-18 07:26:30 +00:00
* @ return void
* @ deprecated 3.3 Use Super___1198aecf_84c6_45d2_aea8_d531aa4afdfa___Power :: append ( $xml , $node );
2022-03-09 23:46:45 +00:00
*/
public static function xmlAppend ( & $xml , $node )
{
2023-10-18 07:26:30 +00:00
Super___1198aecf_84c6_45d2_aea8_d531aa4afdfa___Power :: append ( $xml , $node );
2022-03-09 23:46:45 +00:00
}
/**
* xmlComment
*
* @ param SimpleXMLElement $xml The XML element reference in which to inject a comment
* @ param string $comment The comment to inject
*
2023-10-18 07:26:30 +00:00
* @ return void
* @ deprecated 3.3 Use Super___1198aecf_84c6_45d2_aea8_d531aa4afdfa___Power :: comment ( $xml , $comment );
2022-03-09 23:46:45 +00:00
*/
public static function xmlComment ( & $xml , $comment )
{
2023-10-18 07:26:30 +00:00
Super___1198aecf_84c6_45d2_aea8_d531aa4afdfa___Power :: comment ( $xml , $comment );
2022-03-09 23:46:45 +00:00
}
/**
* xmlAddAttributes
*
* @ param SimpleXMLElement $xml The XML element reference in which to inject a comment
* @ param array $attributes The attributes to apply to the XML element
*
* @ return null
2023-10-18 07:26:30 +00:00
* @ deprecated 3.3 Use Super___1198aecf_84c6_45d2_aea8_d531aa4afdfa___Power :: attributes ( $xml , $attributes );
2022-03-09 23:46:45 +00:00
*/
2024-03-02 20:10:30 +00:00
public static function xmlAddAttributes ( & $xml , $attributes = [])
2022-03-09 23:46:45 +00:00
{
2023-10-18 07:26:30 +00:00
Super___1198aecf_84c6_45d2_aea8_d531aa4afdfa___Power :: attributes ( $xml , $attributes );
2022-03-09 23:46:45 +00:00
}
/**
* xmlAddOptions
*
* @ param SimpleXMLElement $xml The XML element reference in which to inject a comment
* @ param array $options The options to apply to the XML element
*
* @ return void
2023-10-18 07:26:30 +00:00
* @ deprecated 3.3 Use Super___1198aecf_84c6_45d2_aea8_d531aa4afdfa___Power :: options ( $xml , $options );
2022-03-09 23:46:45 +00:00
*/
2024-03-02 20:10:30 +00:00
public static function xmlAddOptions ( & $xml , $options = [])
2022-03-09 23:46:45 +00:00
{
2023-10-18 07:26:30 +00:00
Super___1198aecf_84c6_45d2_aea8_d531aa4afdfa___Power :: options ( $xml , $options );
2022-03-09 23:46:45 +00:00
}
/**
* get the field object
*
* @ param array $attributes The array of attributes
* @ param string $default The default of the field
* @ param array $options The options to apply to the XML element
*
* @ return object
2023-10-18 07:26:30 +00:00
* @ deprecated 3.3 Use Super___1198aecf_84c6_45d2_aea8_d531aa4afdfa___Power :: field ( $attributes , $default , $options );
2022-03-09 23:46:45 +00:00
*/
public static function getFieldObject ( & $attributes , $default = '' , $options = null )
{
2023-10-18 07:26:30 +00:00
return Super___1198aecf_84c6_45d2_aea8_d531aa4afdfa___Power :: field ( $attributes , $default , $options );
2022-03-09 23:46:45 +00:00
}
/**
* get the field xml
*
* @ param array $attributes The array of attributes
* @ param array $options The options to apply to the XML element
*
* @ return object
2023-10-18 07:26:30 +00:00
* @ deprecated 3.3 Use Super___1198aecf_84c6_45d2_aea8_d531aa4afdfa___Power :: xml ( $attributes , $options );
2022-03-09 23:46:45 +00:00
*/
public static function getFieldXML ( & $attributes , $options = null )
{
2023-10-18 07:26:30 +00:00
return Super___1198aecf_84c6_45d2_aea8_d531aa4afdfa___Power :: xml ( $attributes , $options );
2022-03-09 23:46:45 +00:00
}
/**
* Render Bool Button
*
* @ param array $args All the args for the button
* 0 ) name
* 1 ) additional ( options class ) // not used at this time
* 2 ) default
* 3 ) yes ( name )
* 4 ) no ( name )
*
* @ return string The input html of the button
*
*/
public static function renderBoolButton ()
{
$args = func_get_args ();
// check if there is additional button class
$additional = isset ( $args [ 1 ]) ? ( string ) $args [ 1 ] : '' ; // not used at this time
// button attributes
$buttonAttributes = array (
'type' => 'radio' ,
2024-03-02 20:10:30 +00:00
'name' => isset ( $args [ 0 ]) ? Super___1f28cb53_60d9_4db1_b517_3c7dc6b429ef___Power :: html ( $args [ 0 ]) : 'bool_button' ,
'label' => isset ( $args [ 0 ]) ? Super___1f28cb53_60d9_4db1_b517_3c7dc6b429ef___Power :: safe ( Super___1f28cb53_60d9_4db1_b517_3c7dc6b429ef___Power :: html ( $args [ 0 ]), 'Ww' ) : 'Bool Button' , // not seen anyway
2022-03-09 23:46:45 +00:00
'class' => 'btn-group' ,
'filter' => 'INT' ,
'default' => isset ( $args [ 2 ]) ? ( int ) $args [ 2 ] : 0 );
// set the button options
$buttonOptions = array (
2024-03-02 20:10:30 +00:00
'1' => isset ( $args [ 3 ]) ? Super___1f28cb53_60d9_4db1_b517_3c7dc6b429ef___Power :: html ( $args [ 3 ]) : 'JYES' ,
'0' => isset ( $args [ 4 ]) ? Super___1f28cb53_60d9_4db1_b517_3c7dc6b429ef___Power :: html ( $args [ 4 ]) : 'JNO' );
2022-03-09 23:46:45 +00:00
// return the input
2024-03-02 20:10:30 +00:00
return Super___1198aecf_84c6_45d2_aea8_d531aa4afdfa___Power :: field ( $buttonAttributes , $buttonAttributes [ 'default' ], $buttonOptions ) -> input ;
}
/**
* Check if have an json string
*
* @ input string The json string to check
*
* @ returns bool true on success
* @ deprecated 3.3 Use Super___4b225c51_d293_48e4_b3f6_5136cf5c3f18___Power :: check ( $string );
*/
public static function checkJson ( $string )
{
return Super___4b225c51_d293_48e4_b3f6_5136cf5c3f18___Power :: check ( $string );
}
/**
* Check if have an object with a length
*
* @ input object The object to check
*
* @ returns bool true on success
* @ deprecated 3.3 Use Super___91004529_94a9_4590_b842_e7c6b624ecf5___Power :: check ( $object );
*/
public static function checkObject ( $object )
{
return Super___91004529_94a9_4590_b842_e7c6b624ecf5___Power :: check ( $object );
}
/**
* Check if have an array with a length
*
* @ input array The array to check
*
* @ returns bool / int number of items in array on success
* @ deprecated 3.3 Use Super___0a59c65c_9daf_4bc9_baf4_e063ff9e6a8a___Power :: check ( $array , $removeEmptyString );
*/
public static function checkArray ( $array , $removeEmptyString = false )
{
return Super___0a59c65c_9daf_4bc9_baf4_e063ff9e6a8a___Power :: check ( $array , $removeEmptyString );
}
/**
* Check if have a string with a length
*
* @ input string The string to check
*
* @ returns bool true on success
* @ deprecated 3.3 Use Super___1f28cb53_60d9_4db1_b517_3c7dc6b429ef___Power :: check ( $string );
*/
public static function checkString ( $string )
{
return Super___1f28cb53_60d9_4db1_b517_3c7dc6b429ef___Power :: check ( $string );
2022-03-09 23:46:45 +00:00
}
/**
* Check if we are connected
* Thanks https :// stackoverflow . com / a / 4860432 / 1429677
*
* @ returns bool true on success
*/
public static function isConnected ()
{
// If example.com is down, then probably the whole internet is down, since IANA maintains the domain. Right?
2024-03-02 20:10:30 +00:00
$connected = @ fsockopen ( " www.example.com " , 80 );
// website, port (try 80 or 443)
2022-03-09 23:46:45 +00:00
if ( $connected )
{
//action when connected
$is_conn = true ;
fclose ( $connected );
}
else
{
//action in connection failure
$is_conn = false ;
}
return $is_conn ;
}
2024-03-02 20:10:30 +00:00
/**
* Merge an array of array ' s
*
* @ input array The arrays you would like to merge
*
* @ returns array on success
* @ deprecated 3.3 Use Super___0a59c65c_9daf_4bc9_baf4_e063ff9e6a8a___Power :: merge ( $arrays );
*/
public static function mergeArrays ( $arrays )
{
return Super___0a59c65c_9daf_4bc9_baf4_e063ff9e6a8a___Power :: merge ( $arrays );
}
2022-03-09 23:46:45 +00:00
// typo sorry!
public static function sorten ( $string , $length = 40 , $addTip = true )
{
return self :: shorten ( $string , $length , $addTip );
2024-03-02 20:10:30 +00:00
}
/**
* Shorten a string
*
* @ input string The you would like to shorten
*
* @ returns string on success
* @ deprecated 3.3 Use Super___1f28cb53_60d9_4db1_b517_3c7dc6b429ef___Power :: shorten ( ... );
*/
public static function shorten ( $string , $length = 40 , $addTip = true )
{
return Super___1f28cb53_60d9_4db1_b517_3c7dc6b429ef___Power :: shorten ( $string , $length , $addTip );
}
/**
* Making strings safe ( various ways )
*
* @ input string The you would like to make safe
*
* @ returns string on success
* @ deprecated 3.3 Use Super___1f28cb53_60d9_4db1_b517_3c7dc6b429ef___Power :: safe ( ... );
*/
public static function safeString ( $string , $type = 'L' , $spacer = '_' , $replaceNumbers = true , $keepOnlyCharacters = true )
{
return Super___1f28cb53_60d9_4db1_b517_3c7dc6b429ef___Power :: safe (
$string ,
$type ,
$spacer ,
$replaceNumbers ,
$keepOnlyCharacters
);
}
/**
* Convert none English strings to code usable string
*
* @ input an string
*
* @ returns a string
* @ deprecated 3.3 Use Super___1f28cb53_60d9_4db1_b517_3c7dc6b429ef___Power :: transliterate ( $string );
*/
public static function transliterate ( $string )
{
return Super___1f28cb53_60d9_4db1_b517_3c7dc6b429ef___Power :: transliterate ( $string );
}
/**
* make sure a string is HTML save
*
* @ input an html string
*
* @ returns a string
* @ deprecated 3.3 Use Super___1f28cb53_60d9_4db1_b517_3c7dc6b429ef___Power :: html ( ... );
*/
public static function htmlEscape ( $var , $charset = 'UTF-8' , $shorten = false , $length = 40 )
{
return Super___1f28cb53_60d9_4db1_b517_3c7dc6b429ef___Power :: html (
$var ,
$charset ,
$shorten ,
$length
);
} ###HELPER_LICENSE_LOCK###
/**
* Convert all int in a string to an English word string
*
* @ input an string with numbers
*
* @ returns a string
* @ deprecated 3.3 Use Super___1f28cb53_60d9_4db1_b517_3c7dc6b429ef___Power :: numbers ( $string );
*/
public static function replaceNumbers ( $string )
{
return Super___1f28cb53_60d9_4db1_b517_3c7dc6b429ef___Power :: numbers ( $string );
}
/**
* Convert an integer into an English word string
* Thanks to Tom Nicholson < http :// php . net / manual / en / function . strval . php #41988>
*
* @ input an int
* @ returns a string
* @ deprecated 3.3 Use Super___1f28cb53_60d9_4db1_b517_3c7dc6b429ef___Power :: number ( $x );
*/
public static function numberToString ( $x )
{
return Super___1f28cb53_60d9_4db1_b517_3c7dc6b429ef___Power :: number ( $x );
}
/**
* Random Key
*
* @ returns a string
* @ deprecated 3.3 Use Super___1f28cb53_60d9_4db1_b517_3c7dc6b429ef___Power :: random ( $size );
*/
public static function randomkey ( $size )
{
return Super___1f28cb53_60d9_4db1_b517_3c7dc6b429ef___Power :: random ( $size );
} ###GET_CRYPT_KEY###
2022-03-09 23:46:45 +00:00
}