Overview

Namespaces

  • Charcoal
    • Admin
      • Widget
        • Cms
    • Cms
      • Config
      • Mixin
        • Traits
      • Route
      • Section
      • Service
        • Loader
        • Manager
      • ServiceProvider
      • Support
        • Helpers
        • Interfaces
        • Traits
    • Property

Classes

  • AbstractDocument
  • AbstractEvent
  • AbstractFaq
  • AbstractImage
  • AbstractNews
  • AbstractSection
  • AbstractText
  • AbstractVideo
  • Config
  • Document
  • DocumentCategory
  • EmptySection
  • Event
  • EventCategory
  • ExternalSection
  • Faq
  • FaqCategory
  • Image
  • ImageCategory
  • News
  • NewsCategory
  • Section
  • Tag
  • Text
  • TextCategory
  • Video
  • VideoCategory

Interfaces

  • DocumentInterface
  • EventInterface
  • FaqInterface
  • ImageInterface
  • MetatagInterface
  • NewsInterface
  • SearchableInterface
  • SectionInterface
  • TemplateableInterface
  • TextInterface
  • VideoInterface

Traits

  • MetatagTrait
  • SearchableTrait
  • TemplateableTrait
  • Overview
  • Namespace
  • Class

Interface DocumentInterface

Direct known implementers

Charcoal\Cms\AbstractDocument, Charcoal\Cms\ImageInterface, Charcoal\Cms\VideoInterface

Indirect known implementers

Charcoal\Cms\AbstractImage, Charcoal\Cms\AbstractVideo, Charcoal\Cms\Document, Charcoal\Cms\Image, Charcoal\Cms\Video
Namespace: Charcoal\Cms
Located at Charcoal/Cms/DocumentInterface.php
Methods summary
public Charcoal\Cms\DocumentInterface
# setName( mixed $name )

Parameters

$name
The document name (localized).

Returns

Charcoal\Cms\DocumentInterface
public Charcoal\Translator\Translation|string|null
# name( )

Returns

Charcoal\Translator\Translation|string|null
public Charcoal\Cms\DocumentInterface
# setFile( string $file )

Parameters

$file
The file relative path / url (localized).

Returns

Charcoal\Cms\DocumentInterface
public string
# file( )

Returns

string
public string
# path( )

Returns

string
public string
# url( )

Returns

string
public string
# mimetype( )

Returns

string
public string
# filename( )

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

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

Returns

string
public integer
# filesize( )

Get the document's file size, in bytes.

Get the document's file size, in bytes.

Returns

integer
API documentation generated by ApiGen