SCHLIX\cmsAdmin_List

Inherited from cmsAdmin_Basic
Implements interface_cmsAdmin_List
Inherits Contact_Messages_Admin, Core_BannedIP_Admin, Core_CronScheduler_Admin, Core_EmailQueue_Admin, Core_Emailtemplate_Admin, Core_Error404_Admin, Core_HttpError_Admin, Core_LogViewer_Admin, Core_MediaHeader_Admin, Core_Redirection_Admin, Core_Versioning_Admin, PersonalDataRequest_Admin, SiteManager_Admin, SiteManager_Hosts_Admin, Users_History_Admin, cmsAdmin_CategorizedList

Protected Attributes

protected $_fieldname_items 
protected $table_items 
protected $field_id 
protected $app 
protected $search_field= 'title'
protected $ajaxfieldname_items 
protected $ajaxfield_items 
protected $default_item_options 
protected $updatable_fieldname_items 

Protected Methods

protected resetAllItemsMetaOptionKeys()
Resets meta option keys for all items
protected arrayintersectFields(array $db_fields, array $array)
Intersect fields
protected setItemFieldNamesForAjaxUpdate()
protected setPreviewLinkForItemListingResult($items)
protected arraysetAdditionalVariablesForEditItem(array $local_variables)
Set additional variables for item editing before it's displayed
protected viewErrorMessage($message)
protected recordCurrentUserSaveItem($id)
protected forceRefreshMenuLinks()
protected validateUpdateItemField($id, $field, $value)
protected arraygetParserFromTableListingFields(array $table_fields, array $listing_fields)
Returns a key/value for parser of table definition

Public Methods

public __construct(string $data_type=null, array $public_methods=null)
Constructor
public setItemFieldNamesForAjaxListing()
public getItemFieldNamesForAjaxListing()
public searchReplaceItems($field_name, $search, $replace, $case_sensitive=true)
public getItemByID($id)
public getItemByIDSingleObject($id)
public ajaxSearchObjects($keyword='', $start, $end, $sortby='', $sortdirection='ASC')
public arraymodifyAjaxSearchObjectsResult(string $keyword, array $result)
Override search result
public ajaxSaveItem($id)
public ajaxCopyObjects($mixed_items_to_copy, $destination='')
public ajaxGetAllItems($start, $end, $sortby='', $sortdirection='ASC')
public modifyAjaxGetAllItemsResult($result)
public editItem(array $id)
Edit item. Returns an array ['id' => id, 'errors' => list of errors] @global \App\Users $CurrentUser
public duplicateItem($source_item_id, $destination_catnumber)
public checkIfThisItemInTheMenu($id)
public onGetAdminValidationErrorListBeforeSaveItem(array $datavalues)
Validates $datavalues before saved and returns an error list if any, otherwise return an empty array
public arrayonModifyDataBeforeSaveItem(array $datavalues)
Save item hook that you can override. Must return array of modified or unmodified $datavalues
public arrayonAfterSaveItem(array $datavalues, $original_datavalues, $previous_item, array $retval)
Save item hook that you can override. Must return array of modified or unmodified $datavalues
public booleansaveItem(int $id)
Saves Item @global \App\Users $CurrentUser
public ajaxDeleteObjects($mixed_items_to_delete)
public Hide($str)
public sortAll()
public arrayajaxUpdateField()
Ajax update a single item field with a specified ID.
public typeajaxRestoreItem(int $id, double $version)
Restore an item to an older version
public arraymodifyCategoryResponseSchemaFields(array $response_schema)
You can customize the response schema field here
public arraymodifyItemResponseSchemaFields(array $response_schema)
You can customize the response schema field here
public ajaxGetAllDataResponseSchema()
Ajax reply of all data response schema from all table
public arraygetDataTableResponseSchemaFromTable(string $tablename, array $restrict_listing_fields, string $fn_modifier)
Returns the data response Schema for ajax Listing Returns a response schema from a table for datatable listing
public getItemsResponseSchema()
Returns the data response Schema for ajax Listing
public arraysaveConfig(string $override_app_name='')
Returns the data response Schema for ajax Listing OLD - deprecated public function getItemsResponseSchema() { $listing_fields = $this->getItemFieldNamesForAjaxListing(); $table_fields = $this->app->getItemTable()->getFields(); $result_fields = $this->getParserFromTableListingFields($table_fields, $listing_fields); $result_fields = $this->modifyItemResponseSchemaFields($result_fields); $response_result = array ( 'primary_key' => $this->app->getFieldID(), 'resultsList' => "data", 'fields' => $result_fields, 'metaFields' => array( 'totalRecords' => "totalRecords", 'recordsReturned' => "recordsReturned", 'paginationRecordOffset' => "start", 'paginationRowsPerPage' => "itemsperpage", 'sortby' => "sortby", 'sortdirection' => "sortdirection", 'start'=> "start", 'end'=> "end" ) ); return $response_result; } Save Configuration. You can override the app name if required @global \SCHLIX\cmsConfigRegistry $SystemConfig @global \App\Users $CurrentUser
public booleanRun()
Runs admin command