public interface FileResource

interface.fileresource.php #14

The FileResource interface defines the minimum functions required by managers that manage Symphony's file based objects. This interface is used by the DatasourceManager, EventManager, EmailGatewayManager, ExtensionManager, FieldManager and TextFormatterManager.

Methods

static string|boolean __getClassName(string $name)

Given a name, return the class name of that object. Symphony objects often have conventions tied to an objects class name that prefix the class with the type of the object. eg. field{Class}, formatter{Class}

static string|boolean __getClassPath(string $name)

Given a name, return the path to the class of that object

static string|boolean __getDriverPath(string $name)

Given a name, return the path to the driver of that object

static string|boolean __getHandleFromFilename(string $filename)

Given a filename, return the handle. This will remove any Symphony conventions such as field.*.php

static array|boolean about(string $name)

The about function returns information about a particular object in this manager's pool. It is limited for use on objects provided by Extensions. The function uses the getClassName(), getDriverPath() and getHandleFromFilename() functions to find the object of the Manager's type on the filesystem.

Parameters
  • $name stringThe name of the object that has an about() function. This should be lowercase and free from any Symphony conventions. eg. author, not field.author.php.

Returns

False is object doesn't exist or an associative array of information

static object create(string $name)

Creates a new instance of an object by name and returns it by reference.

Parameters
  • $name stringThe name of the Object to be created. Can be used in conjunction with the auto discovery methods to find a class.

static array listAll()

Returns an array of all the objects that this manager is responsible for. This function is only use on the file based Managers in Symphony such DatasourceManager, EventManager, EmailGatewayManager, ExtensionManager, FieldManager and TextformatterManager.

Symphony • Open Source XSLT CMS

Server Requirements

  • PHP 5.3-5.6 or 7.0-7.3
  • PHP's LibXML module, with the XSLT extension enabled (--with-xsl)
  • MySQL 5.5 or above
  • An Apache or Litespeed webserver
  • Apache's mod_rewrite module or equivalent

Compatible Hosts

Sign in

Login details