1. Documentation
  2. API
  3. Library
  4. Halcyon
  5. Datasource
  6. DatasourceInterface

October\Rain\Halcyon\Datasource\DatasourceInterface

Source: ~/vendor/october/rain/src/Halcyon/Datasource/DatasourceInterface.php

Public methods

public bool delete(string $dirName, string $fileName, string $extension)

Run a delete statement against the datasource.

Parameters
  • string $dirName
  • string $fileName
  • string $extension

public bool forceDelete(string $dirName, string $fileName, string $extension)

Run a delete statement against the datasource, forcing the complete removal of the template

Parameters
  • string $dirName
  • string $fileName
  • string $extension

public array getAvailablePaths()

Get all available paths within this datastore

public string getPathsCacheKey()

Generate a paths cache key unique to this datasource

public bool insert(string $dirName, string $fileName, string $extension, array $content)

Creates a new template.

Parameters
  • string $dirName
  • string $fileName
  • string $extension
  • array $content

public int lastModified(string $dirName, string $fileName, string $extension)

Return the last modified date of an object

Parameters
  • string $dirName
  • string $fileName
  • string $extension

public string makeCacheKey(string $name='')

Generate a cache key unique to this datasource.

Parameters
  • string $name

public array select(string $dirName, array $options=array())

Returns all templates.

Parameters
  • string $dirName
  • array $options

public mixed selectOne(string $dirName, string $fileName, string $extension)

Returns a single template.

Parameters
  • string $dirName
  • string $fileName
  • string $extension

public int update(string $dirName, string $fileName, string $extension, array $content, string $oldFileName=NULL, string $oldExtension=NULL)

Updates an existing template.

Parameters
  • string $dirName
  • string $fileName
  • string $extension
  • array $content
  • string $oldFileName - Defaults to null
  • string $oldExtension - Defaults to null