1. Documentation
  2. API
  3. Backend
  4. Controllers
  5. Files

Backend\Controllers\Files

Source: ~/modules/backend/controllers/Files.php

Extends:

Backend files controller

Used for delivering protected system files, and generating URLs for accessing them.

Public properties

There are no public properties in the class.

Show inherited public properties

Inherited public properties

Protected properties

There are no protected properties in the class.

Show inherited protected properties

Inherited protected properties

Public methods

public void get($code=NULL)

Output file, or fall back on the 404 page

Parameters
  • $code

public static string getDownloadUrl($file $file)

Returns the URL for downloading a system file.

Parameters
  • $file $file - System\Models\File

public static string getThumbUrl($file $file, $width $width, $height $height, $options $options)

Returns the URL for downloading a system file.

Parameters
  • $file $file - System\Models\File
  • $width $width - Int
  • $height $height - Int
  • $options $options - Array

public static string getUniqueCode($file $file)

Returns a unique code used for masking the file identifier.

Parameters
  • $file $file - System\Models\File

public void thumb($code=NULL, $width=100, $height=100, $mode='auto', $extension='auto')

Output thumbnail, or fall back on the 404 page

Parameters
  • $code
  • $width
  • $height
  • $mode
  • $extension

Show inherited public methods

Inherited public methods

  • public void __call($name, $params) - defined in Backend\Classes\Controller.
  • public static void __callStatic($name, $params) - defined in Backend\Classes\Controller.
  • public void __construct() - defined in Backend\Classes\Controller. Constructor.
  • public void __get($name) - defined in Backend\Classes\Controller.
  • public void __set($name, $value) - defined in Backend\Classes\Controller.
  • public boolean actionExists(string $name, bool $internal=false) - defined in Backend\Classes\Controller. This method is used internally.
  • public void actionUrl($action=NULL, $path=NULL) - defined in Backend\Classes\Controller. Returns a URL for this controller and supplied action.
  • public void addCss(string $name, array $attributes=array()) - defined in Backend\Classes\Controller. Adds StyleSheet asset to the asset list. Call $this->makeAssets() in a view.
  • public void addDynamicMethod(string $dynamicName, callable $method, string $extension=NULL) - defined in Backend\Classes\Controller. Programmatically adds a method to the extendable class.
  • public void addDynamicProperty(string $dynamicName, string $value=NULL) - defined in Backend\Classes\Controller. Programmatically adds a property to the extendable class.
  • public void addJs(string $name, array $attributes=array()) - defined in Backend\Classes\Controller. Adds JavaScript asset to the asset list. Call $this->makeAssets() in a view.
  • public void addRss(string $name, array $attributes=array()) - defined in Backend\Classes\Controller. Adds an RSS link asset to the asset list. Call $this->makeAssets() in a view.
  • public void addViewPath(string|array $path) - defined in Backend\Classes\Controller. Prepends a path on the available view path locations.
  • public mixed asExtension(string $shortName) - defined in Backend\Classes\Controller. Short hand for getClassExtension() method, except takes the short.
  • public self bindEvent($event, $callback, $priority=0) - defined in Backend\Classes\Controller. Create a new event binding.
  • public self bindEventOnce($event, $callback) - defined in Backend\Classes\Controller. Create a new event binding that fires once only.
  • public Symfony\Component\HttpFoundation\Response callAction(string $method, array $parameters) - defined in Illuminate\Routing\Controller. Execute an action on the controller.
  • public static void clearExtendedClasses() - defined in Backend\Classes\Controller. Clear the list of extended classes so they will be re-extended.
  • public string combineAssets(array $assets, string $localPath='') - defined in Backend\Classes\Controller. Run the provided assets through the Asset Combiner.
  • public static void extend($callback) - defined in Backend\Classes\Controller. Extend this object properties upon construction.
  • public void extendClassWith(string $extensionName) - defined in Backend\Classes\Controller. Dynamically extend a class with a specified behavior.
  • public mixed extendableCall(string $name, array $params=NULL) - defined in Backend\Classes\Controller. Magic method for __call().
  • public static mixed extendableCallStatic(string $name, array $params=NULL) - defined in Backend\Classes\Controller. Magic method for __callStatic().
  • public void extendableConstruct() - defined in Backend\Classes\Controller. This method should be called as part of the constructor.
  • public static void extendableExtendCallback(callable $callback) - defined in Backend\Classes\Controller. Helper method for ::extend() static method.
  • public string extendableGet(string $name) - defined in Backend\Classes\Controller. Magic method for __get().
  • public string extendableSet(string $name, string $value) - defined in Backend\Classes\Controller. Magic method for __set().
  • public array fireEvent(string $event, array $params=array(), boolean $halt=false) - defined in Backend\Classes\Controller. Fire an event and call the listeners.
  • public mixed fireSystemEvent(string $event, array $params=array(), boolean $halt=true) - defined in Backend\Classes\Controller. Fires a combination of local and global events. The first segment is removed.
  • public string fireViewEvent(string $event, array $params=array()) - defined in Backend\Classes\Controller. Special event function used for extending within view files,
  • public void flushAssets() - defined in Backend\Classes\Controller. Disables the use, and subequent broadcast, of assets. This is useful.
  • public string getAjaxHandler() - defined in Backend\Classes\Controller. Returns the AJAX handler for the current request, if available.
  • public string getAssetPath(string $fileName, string $assetPath=NULL) - defined in Backend\Classes\Controller. Locates a file based on it's definition. If the file starts with.
  • public array getAssetPaths() - defined in Backend\Classes\Controller. Returns an array of all registered asset paths.
  • public mixed getClassExtension(string $name) - defined in Backend\Classes\Controller. Returns a behavior object from an extendable class, example:.
  • public array getClassMethods() - defined in Backend\Classes\Controller. Get a list of class methods, extension equivalent of get_class_methods().
  • public string getConfigPath(string $fileName, mixed $configPath=NULL) - defined in Backend\Classes\Controller. Locates a file based on it's definition. If the file starts with.
  • public array getDynamicProperties() - defined in Backend\Classes\Controller. Returns all dynamic properties and their values.
  • public string getFatalError() - defined in Backend\Classes\Controller. Returns the fatal error message
  • public void getId($suffix=NULL) - defined in Backend\Classes\Controller. Returns a unique ID for the controller and route. Useful in creating HTML markup.
  • public array getMiddleware() - defined in Illuminate\Routing\Controller. Get the middleware assigned to the controller.
  • public void getPublicActions() - defined in Backend\Classes\Controller. Returns the controllers public actions.
  • public Symfony\Component\HttpFoundation\ResponseHeaderBag|null getResponseHeaders() - defined in Backend\Classes\Controller. Get the header response bag.
  • public int getStatusCode() - defined in Backend\Classes\Controller. Returns the status code for the current web response.
  • public string getViewPath(string $fileName, mixed $viewPath=NULL) - defined in Backend\Classes\Controller. Locates a file based on its definition. The file name can be prefixed with a.
  • public array getViewPaths() - defined in Backend\Classes\Controller. Returns the active view path locations.
  • public string guessConfigPath(string $suffix='') - defined in Backend\Classes\Controller. Guess the package path for the called class.
  • public string guessConfigPathFrom(string $class, string $suffix='') - defined in Backend\Classes\Controller. Guess the package path from a specified class.
  • public string guessViewPath(string $suffix='', bool $isPublic=false) - defined in Backend\Classes\Controller. Guess the package path for the called class.
  • public string guessViewPathFrom(string $class, string $suffix='', bool $isPublic=false) - defined in Backend\Classes\Controller. Guess the package path from a specified class.
  • public void handleError($exception) - defined in Backend\Classes\Controller. Sets standard page variables in the case of a controller error.
  • public bool hasAssetsDefined() - defined in Backend\Classes\Controller. Returns true if assets any have been added.
  • public boolean hasFatalError() - defined in Backend\Classes\Controller. Determines whether a fatal error has been set or not.
  • public boolean isBackendHintHidden(string $name) - defined in Backend\Classes\Controller. Checks if a hint has been hidden by the user.
  • public boolean isClassExtendedWith(string $name) - defined in Backend\Classes\Controller. Check if extendable class is extended with a behavior object.
  • public string makeAssets(string $type=NULL) - defined in Backend\Classes\Controller. Outputs <link> and <script> tags to load assets previously added with addJs and addCss method calls.
  • public array|stdClass makeConfig(array $configFile=array(), array $requiredConfig=array()) - defined in Backend\Classes\Controller. Reads the contents of the supplied file and applies it to this object.
  • public stdClass makeConfigFromArray(array $configArray=array()) - defined in Backend\Classes\Controller. Makes a config object from an array, making the first level keys properties of a new object.
  • public string makeFileContents(string $filePath, array $extraParams=array()) - defined in Backend\Classes\Controller. Includes a file path using output buffering.
  • public Backend\Classes\FormWidgetBase makeFormWidget(string $class, mixed $fieldConfig=array(), array $widgetConfig=array()) - defined in Backend\Classes\Controller. Makes a form widget object with the supplied form field and widget configuration.
  • public string makeHintPartial(string $name, string $partial=NULL, array $params=array()) - defined in Backend\Classes\Controller. Renders a hint partial, used for displaying informative information that.
  • public mixed makeLayout(string $name=NULL, array $params=array(), bool $throwException=true) - defined in Backend\Classes\Controller. Render a layout.
  • public string makeLayoutPartial(string $partial, array $params=array()) - defined in Backend\Classes\Controller. Renders a layout partial.
  • public mixed makePartial(string $partial, array $params=array(), bool $throwException=true) - defined in Backend\Classes\Controller. Render a partial file contents located in the views folder.
  • public mixed makeResponse(mixed $contents) - defined in Backend\Classes\Controller. Prepares a response that considers overrides and custom responses.
  • public string makeView(string $view) - defined in Backend\Classes\Controller. Loads a view with the name specified. Applies layout if its name is provided by the parent object.
  • public string makeViewContent(string $contents, string $layout=NULL) - defined in Backend\Classes\Controller. Renders supplied contents inside a layout.
  • public Backend\Classes\WidgetBase makeWidget(string $class, array $widgetConfig=array()) - defined in Backend\Classes\Controller. Makes a widget object with the supplied configuration file.
  • public stdClass mergeConfig(mixed $configA, mixed $configB) - defined in Backend\Classes\Controller. Merges two configuration sources, either prepared or not, and returns.
  • public boolean methodExists(string $name) - defined in Backend\Classes\Controller. Checks if a method exists, extension equivalent of method_exists().
  • public Illuminate\Routing\ControllerMiddlewareOptions middleware(array|string|\Closure $middleware, array $options=array()) - defined in Illuminate\Routing\Controller. Register middleware on the controller.
  • public void onHideBackendHint() - defined in Backend\Classes\Controller. Ajax handler to hide a backend hint, once hidden the partial.
  • public void pageAction() - defined in Backend\Classes\Controller. Invokes the current controller action without rendering a view,
  • public boolean propertyExists(string $name) - defined in Backend\Classes\Controller. Checks if a property exists, extension equivalent of property_exists().
  • public mixed run(string $action=NULL, array $params=array()) - defined in Backend\Classes\Controller. Execute the controller action.
  • public $this setResponse(mixed $response) - defined in Backend\Classes\Controller. Sets the response for the current page request cycle, this value takes priority.
  • public $this setResponseCookie(Symfony\Component\HttpFoundation\Cookie|mixed $cookie) - defined in Backend\Classes\Controller. Add a cookie to the response.
  • public $this setResponseHeader(string $key, array|string $values, bool $replace=true) - defined in Backend\Classes\Controller. Set a header on the Response.
  • public $this setStatusCode(int $code) - defined in Backend\Classes\Controller. Sets the status code for the current web response.
  • public self unbindEvent(string $event=NULL) - defined in Backend\Classes\Controller. Destroys an event binding.

Protected methods

protected System\Models\File findFileObject($code $code)

Locates a file model based on the unique code.

Parameters
  • $code $code - String

protected static string|null getTemporaryUrl(System|Models\File $file, string|null $path=NULL)

Attempt to return a redirect to a temporary URL to the asset instead of streaming the asset - if supported

Parameters
  • System|Models\File $file
  • string|null $path - Optional, defaults to the getDiskPath() of the file

Show inherited protected methods

Inherited protected methods

  • protected void addAsset(string $type, string $path, array $attributes) - defined in Backend\Classes\Controller. Adds the provided asset to the internal asset collections.
  • protected array emitterEventSortEvents(string $eventName) - defined in Backend\Classes\Controller. Sort the listeners for a given event by priority.
  • protected void execAjaxHandlers() - defined in Backend\Classes\Controller. This method is used internally.
  • protected void execPageAction(string $actionName, array $parameters) - defined in Backend\Classes\Controller. This method is used internally.
  • protected boolean extendableIsAccessible(mixed $class, string $propertyName) - defined in Backend\Classes\Controller. Checks if a property is accessible, property equivalent of is_callable().
  • protected void extensionExtractMethods(string $extensionName, object $extensionObject) - defined in Backend\Classes\Controller. Extracts the available methods from a behavior and adds it to the.
  • protected string getAssetEntryBuildPath(array $asset) - defined in Backend\Classes\Controller. Internal helper, attaches a build code to an asset path.
  • protected string getAssetScheme(string $asset) - defined in Backend\Classes\Controller. Internal helper, get asset scheme.
  • protected void getLocalPath($relativePath) - defined in Backend\Classes\Controller.
  • protected void handleViewException(Exception $e, int $obLevel) - defined in Backend\Classes\Controller. Handle a view exception.
  • protected Symfony\Component\HttpFoundation\Cookie makeXsrfCookie() - defined in Backend\Classes\Controller. Adds anti-CSRF cookie.
  • protected void removeDuplicates() - defined in Backend\Classes\Controller. Removes duplicate assets from the entire collection.
  • protected boolean runAjaxHandler($handler) - defined in Backend\Classes\Controller. Tries to find and run an AJAX handler in the page action.
  • protected mixed runAjaxHandlerForWidget($widget, $handler) - defined in Backend\Classes\Controller. Specific code for executing an AJAX handler for a widget.
  • protected bool verifyCsrfToken() - defined in Backend\Classes\Controller. Checks the request data / headers for a valid CSRF token.
  • protected bool verifyForceSecure() - defined in Backend\Classes\Controller. Checks if the back-end should force a secure protocol (HTTPS) enabled by config.