1. interface
  2. Igniter
  3. \
  4. Flame
  5. \
  6. Pagic
  7. \
  8. Source
  9. \
  10. SourceInterface

SourceInterface

interface SourceInterface

Methods

mixed
select(string $dirName, string $fileName, string $extension)

Returns a single source.

array
selectAll(string $dirName, array $options = [])

Returns all sources.

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

Creates a new source.

int
update(string $dirName, string $fileName, string $extension, string $content, string $oldFileName = null, string $oldExtension = null)

Updates an existing source.

int
delete(string $dirName, string $fileName, string $extension)

Run a delete statement against the datasource.

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

Return the last modified date of an object

string
makeCacheKey(string $name = '')

Generate a cache key unique to this source.

string
getPathsCacheKey()

Generate a paths cache key unique to this source

array
getAvailablePaths()

Get all available paths within this source

Details

at line 16
mixed select(string $dirName, string $fileName, string $extension)

Returns a single source.

Parameters

string $dirName
string $fileName
string $extension

Return Value

mixed

at line 26
array selectAll(string $dirName, array $options = [])

Returns all sources.

Parameters

string $dirName
array $options

Return Value

array

at line 38
bool insert(string $dirName, string $fileName, string $extension, string $content)

Creates a new source.

Parameters

string $dirName
string $fileName
string $extension
string $content

Return Value

bool

at line 52
int update(string $dirName, string $fileName, string $extension, string $content, string $oldFileName = null, string $oldExtension = null)

Updates an existing source.

Parameters

string $dirName
string $fileName
string $extension
string $content
string $oldFileName
string $oldExtension

Return Value

int

at line 63
int delete(string $dirName, string $fileName, string $extension)

Run a delete statement against the datasource.

Parameters

string $dirName
string $fileName
string $extension

Return Value

int

at line 74
int lastModified(string $dirName, string $fileName, string $extension)

Return the last modified date of an object

Parameters

string $dirName
string $fileName
string $extension

Return Value

int

at line 83
string makeCacheKey(string $name = '')

Generate a cache key unique to this source.

Parameters

string $name

Return Value

string

at line 90
string getPathsCacheKey()

Generate a paths cache key unique to this source

Return Value

string

at line 97
array getAvailablePaths()

Get all available paths within this source

Return Value

array

$paths ['path/to/file1.md' => true (path can be handled and exists), 'path/to/file2.md' => false (path can be handled but doesn't exist)]