\Charcoal\CmsDocument

Base document class.

Summary

Methods

Properties

Constants

setName()
name()
setFile()
file()
setBasePath()
basePath()
setBaseUrl()
baseUrl()
path()
url()
mimetype()
filename()
filesize()
categoryType()

No public properties found

No constants found

No protected methods found

No protected properties found

N/A

No private methods found

$name
$file
$basePath
$baseUrl

N/A

final

File: Cms/Document.php
Package: Default
Class hierarchy: \Charcoal\Object\Content

\Charcoal\Cms\AbstractDocument

\Charcoal\Cms\Document

Properties

$name

$name : \Charcoal\Translator\Translation|string|null

Type

\Charcoal\Translator\Translation|string|null

$file

$file : string

Type

string

$basePath

$basePath : string

Type

string

$baseUrl

$baseUrl : string

Type

string

Methods

setName()

setName(mixed  $name) : self

Parameters

mixed

$name

The document name.

Returns

self

name()

name() : \Charcoal\Translator\Translation|string|null

Returns

\Charcoal\Translator\Translation|string|null

setFile()

setFile(string  $file) : self

Parameters

string

$file

The file relative path / url.

Returns

self

file()

file() : string

Returns

string

setBasePath()

setBasePath(string  $path) : self

Parameters

string

$path

The document base path.

Returns

self

basePath()

basePath() : string

Get the base path, with a trailing slash.

Returns

string

setBaseUrl()

setBaseUrl(string  $url) : self

Parameters

string

$url

The document base URL.

Returns

self

baseUrl()

baseUrl() : string

Get the base url, with a trailing slash.

Returns

string

path()

path() : string

Returns

string

url()

url() : string

Returns

string

mimetype()

mimetype() : string

Returns

string

filename()

filename() : string

Get the fiqlename (basename; without any path segment).

Returns

string

filesize()

filesize() : integer

Get the document's file size, in bytes.

Returns

integer

categoryType()

categoryType() : string

Returns

string