Class AbstractDocument

Base document class.

Charcoal\Object\Content

Charcoal\Cms\AbstractDocument implements Charcoal\Object\CategorizableInterface, Charcoal\Cms\DocumentInterface uses Charcoal\Object\CategorizableTrait (not available)

Direct known subclasses

Charcoal\Cms\AbstractImage, Charcoal\Cms\AbstractVideo, Charcoal\Cms\Document

Indirect known subclasses

Charcoal\Cms\Image, Charcoal\Cms\Video

Abstract
Namespace: Charcoal\Cms
Located at Charcoal/Cms/AbstractDocument.php

Methods summary
`public Charcoal\Cms\AbstractDocument`	# `setName( mixed $name )` Parameters `$name` The document name. Returns `Charcoal\Cms\AbstractDocument` Implementation of `Charcoal\Cms\DocumentInterface::setName()`
`public Charcoal\Translator\Translation\|string\|null`	# `name( )` Returns Charcoal\Translator\Translation\|string\|null Implementation of `Charcoal\Cms\DocumentInterface::name()`
`public Charcoal\Cms\AbstractDocument`	# `setFile( string $file )` Parameters `$file` The file relative path / url. Returns `Charcoal\Cms\AbstractDocument` Implementation of `Charcoal\Cms\DocumentInterface::setFile()`
`public string`	# `file( )` Returns string Implementation of `Charcoal\Cms\DocumentInterface::file()`
`public Charcoal\Cms\AbstractDocument`	# `setBasePath( string $path )` Parameters `$path` The document base path. Returns `Charcoal\Cms\AbstractDocument`
`public string`	# `basePath( )` Get the base path, with a trailing slash. Get the base path, with a trailing slash. Returns string
`public Charcoal\Cms\AbstractDocument`	# `setBaseUrl( string $url )` Parameters `$url` The document base URL. Returns `Charcoal\Cms\AbstractDocument`
`public string`	# `baseUrl( )` Get the base url, with a trailing slash. Get the base url, with a trailing slash. Returns string
`public string`	# `path( )` Returns string Implementation of `Charcoal\Cms\DocumentInterface::path()`
`public string`	# `url( )` Returns string Implementation of `Charcoal\Cms\DocumentInterface::url()`
`public string`	# `mimetype( )` Returns string Implementation of `Charcoal\Cms\DocumentInterface::mimetype()`
`public string`	# `filename( )` Get the fiqlename (basename; without any path segment). Get the fiqlename (basename; without any path segment). Returns string Implementation of `Charcoal\Cms\DocumentInterface::filename()`
`public integer`	# `filesize( )` Get the document's file size, in bytes. Get the document's file size, in bytes. Returns integer Implementation of `Charcoal\Cms\DocumentInterface::filesize()`

Namespaces

Classes

Interfaces

Traits

Class AbstractDocument

Direct known subclasses

Indirect known subclasses

Parameters

Returns

Implementation of

Returns

Implementation of

Parameters

Returns

Implementation of

Returns

Implementation of

Parameters

Returns

Returns

Parameters

Returns

Returns

Returns

Implementation of

Returns

Implementation of

Returns

Implementation of

Returns

Implementation of

Returns

Implementation of