\TemplatesModelTemplate

Template model class.

Synopsis

class TemplatesModelTemplate extends JModelForm {

• // members
• protected  $template;
• protected  $element;
• // Inherited members from JModelForm
• protected  $_forms;
• // Inherited members from JModelLegacy
• protected  $__state_set;
• protected   $_db;
• protected  $name;
• protected  $option;
• protected  $state;
• protected  $event_clean_cache;
• // Inherited members from JObject
• protected  $_errors;
• // methods
• protected  getFile()
• public array getFiles()
• public array getDirectoryTree()
• protected void populateState()
• public mixed getTemplate()
• public boolean checkNewName()
• public string getFromName()
• public boolean copy()
• public boolean cleanup()
• protected boolean fixTemplateName()
• public JForm getForm()
• protected mixed loadFormData()
• public mixed getSource()
• public boolean save()
• public  getOverridesFolder()
• public array getOverridesList()
• public boolean createOverride()
• public boolean compileLess()
• public boolean deleteFile()
• public boolean createFile()
• public boolean uploadFile()
• public boolean createFolder()
• public boolean deleteFolder()
• public string renameFile()
• public array getImage()
• public boolean cropImage()
• public boolean resizeImage()
• public  getPreview()
• public mixed getFont()
• public  getHathor()
• public boolean copyFile()
• public array getArchive()
• public boolean extractArchive()
• // Inherited methods from JModelForm
• public boolean checkin()
• public boolean checkout()
• public abstract mixed getForm()
• protected mixed loadForm()
• protected array loadFormData()
• protected void preprocessData()
• protected void preprocessForm()
• public mixed validate()
• // Inherited methods from JModelLegacy
• public static array addIncludePath()
• public static void addTablePath()
• protected static string _createFileName()
• public static mixed getInstance()
• public void __construct()
• protected array _getList()
• protected integer _getListCount()
• protected mixed _createTable()
• public JDatabaseDriver getDbo()
• public string getName()
• public  getState()
• public JTable getTable()
• public boolean loadHistory()
• protected void populateState()
• public void setDbo()
• public mixed setState()
• protected void cleanCache()
• // Inherited methods from JObject
• public void __construct()
• public string __toString()
• public mixed def()
• public mixed get()
• public array getProperties()
• public string getError()
• public array getErrors()
• public mixed set()
• public boolean setProperties()
• public void setError()
}


Hierarchy

Extends

• JModelForm

Members

protected

• $__state_set — boolean
  Indicates if the internal state has been set
• $_db —
  Database Connector
• $_errors — array
  An array of error messages or Exception objects.
• $_forms — array
  Array of form objects.
• $element
• $event_clean_cache — string
  The event to trigger when cleaning cache.
• $name — string
  The model (base) name
• $option — string
  The URL option for the component.
• $state — string
  A state object
• $template

Methods

protected

• fixTemplateName() — Method to rename the template in the XML files and rename the language files
• getFile() — Internal method to get file properties.
• loadFormData() — Method to get the data that should be injected in the form.
• populateState() — Method to auto-populate the model state.

public

• checkNewName() — Method to check if new template name already exists
• cleanup() — Method to delete tmp folder
• compileLess() — Compile less using the less compiler under /build.
• copy() — Method to check if new template name already exists
• copyFile() — Copy a file.
• createFile() — Create new file.
• createFolder() — Create new folder.
• createOverride() — Create overrides.
• cropImage() — Crop an image.
• deleteFile() — Delete a particular file.
• deleteFolder() — Delete a folder.
• extractArchive() — Extract contents of a archive file.
• getArchive() — Get the compressed files.
• getDirectoryTree() — Get the directory tree.
• getFiles() — Method to get a list of all the files to edit in a template.
• getFont() — Rename a file.
• getForm() — Method to get the record form.
• getFromName() — Method to check if new template name already exists
• getHathor() — Check the admin template.
• getImage() — Get an image address, height and width.
• getOverridesFolder() — Get overrides folder.
• getOverridesList() — Get a list of overrides.
• getPreview() — Template preview.
• getSource() — Method to get a single record.
• getTemplate() — Method to get the template information.
• renameFile() — Rename a file.
• resizeImage() — Resize an image.
• save() — Method to store the source file contents.
• uploadFile() — Upload new file.

Inherited from JModelForm

protected

• loadForm() — Method to get a form object.
• loadFormData() — Method to get the data that should be injected in the form.
• preprocessData() — Method to allow derived classes to preprocess the data.
• preprocessForm() — Method to allow derived classes to preprocess the form.

public

• checkin() — Method to checkin a row.
• checkout() — Method to check-out a row for editing.
• getForm() — Abstract method for getting the form from the model.
• validate() — Method to validate the form data.

Inherited from JModelLegacy

protected

• _createFileName() — Create the filename for a resource
• _createTable() — Method to load and return a model object.
• _getList() — Gets an array of objects from the results of database query.
• _getListCount() — Returns a record count for the query.
• cleanCache() — Clean the cache
• populateState() — Method to auto-populate the model state.

public

• addIncludePath() — Add a directory where JModelLegacy should search for models. You may either pass a string or an array of directories.
• addTablePath() — Adds to the stack of model table paths in LIFO order.
• getDbo() — Method to get the database driver object
• getInstance() — Returns a Model object, always creating it
• getName() — Method to get the model name
• getState() — Method to get model state variables
• getTable() — Method to get a table object, load it if necessary.
• loadHistory() — Method to load a row for editing from the version history table.
• setDbo() — Method to set the database driver object
• setState() — Method to set model state variables

Inherited from JObject

public

• __toString() — Magic method to convert the object to a string gracefully.
• def() — Sets a default value if not alreay assigned
• get() — Returns a property of the object or the default value if the property is not set.
• getError() — Get the most recent error message.
• getErrors() — Return all errors, if any.
• getProperties() — Returns an associative array of object properties.
• set() — Modifies a property of the object, creating it if it does not already exist.
• setError() — Add an error message.
• setProperties() — Set the object properties based on a named array/hash.