Index

  1. \SetaPDF
    1. Core
    2. Core
      1. Canvas
      2. Canvas
      3. ColorSpace
      4. ColorSpace
      5. DataStructure
      6. Document
      7. Document
      8. Encoding
      9. Encoding
      10. Filter
      11. Font
      12. Font
      13. Geometry
      14. IccProfile
      15. Image
      16. Image
      17. Parser
      18. Reader
      19. Resource
      20. Resource
      21. SecHandler
      22. SecHandler
      23. Text
      24. Text
      25. Type
      26. Writer
      27. Writer
      28. XObject
      29. XObject
      30. XmpHelper
      31. XmpHelper
      32. BitConverter
      33. EmbeddedFileStream
      34. Exception
      35. FileSpecification
      36. OutputIntent
      37. PageBoundaries
      38. PageFormats
      39. Tokenizer
      40. TransparencyGroup
      41. WriteInterface
      42. Zugferd

SetaPDF_Core_FileSpecification Class representing a file specification

File: /SetaPDF v2/Core/FileSpecification.php

Class hierarchy

Summary

Static Methods

Methods

Properties

Constants

Constants

FILE_SYSTEM_UNDEFINED

public const null SetaPDF_Core_FileSpecification::FILE_SYSTEM_UNDEFINED = NULL

Default file system constant

FILE_SYSTEM_URL

public const string SetaPDF_Core_FileSpecification::FILE_SYSTEM_URL = 'URL'

URL file system contant


Properties

$_dictionary

protected SetaPDF_Core_Type_Dictionary SetaPDF_Core_FileSpecification::$_dictionary

The dictionary


Static Methods

createDictionary()

public static SetaPDF_Core_FileSpecification::createDictionary (
string $fileSpecificationString
): SetaPDF_Core_Type_Dictionary

Creates a file specification dictionary.

Parameters
$fileSpecificationString : string
 

createEmbedded()

public static SetaPDF_Core_FileSpecification::createEmbedded (
SetaPDF_Core_Document $document, SetaPDF_Core_Reader_ReaderInterface|string $pathOrReader, string $filename [, array $fileStreamParams = array ( ) [, null|string $mimeType = null ]]
): SetaPDF_Core_FileSpecification

Create a file specification with an embedded file stream.

Parameters
$document : SetaPDF_Core_Document
 
$pathOrReader : SetaPDF_Core_Reader_ReaderInterface|string

A reader instance or a path to a file.

$filename : string

The filename in UTF-8 encoding.

$fileStreamParams : array

See setParams() method.

$mimeType : null|string

The subtype of the embedded file. Shall conform to the MIME media type names defined in Internet RFC 2046

Exceptions

Throws SetaPDF_Core_Document_ObjectNotFoundException

Throws SetaPDF_Core_Exception

Throws SetaPDF_Core_Parser_Pdf_InvalidTokenException

Throws SetaPDF_Core_Reader_Exception

Throws SetaPDF_Core_Type_Exception

Throws SetaPDF_Core_Type_IndirectReference_Exception

Throws SetaPDF_Exception

Throws SetaPDF_Exception_NotImplemented


Methods

__construct()

public SetaPDF_Core_FileSpecification::__construct ()

The constructor.

If the parameter cannot be evaluated to a dictionary it will be passed to the createDictionary method to create an appropriate dictionary.

Parameters
$fileSpecification : string|SetaPDF_Core_Type_IndirectObjectInterface|SetaPDF_Core_Type_Dictionary|SetaPDF_Core_Type_StringValue
 
Exceptions

Throws SetaPDF_Core_Type_Exception

See

getCollectionItem()

public SetaPDF_Core_FileSpecification::getCollectionItem (
void
): null|SetaPDF_Core_Type_Dictionary

Get the collection item data.

getDescription()

public SetaPDF_Core_FileSpecification::getDescription (
[ string $encoding = 'UTF-8' ]
): null|string

Get the descriptive text associated with the file specification.

Parameters
$encoding : string
 

getDictionary()

public SetaPDF_Core_FileSpecification::getDictionary (
void
): SetaPDF_Core_Type_Dictionary

Get the dictionary.

getEmbeddedFileStream()

public SetaPDF_Core_FileSpecification::getEmbeddedFileStream (
[ boolean $unicode = false ]
): null|SetaPDF_Core_EmbeddedFileStream

Get the embedded file stream object.

Parameters
$unicode : boolean

If true use the UF key, otherwise the F key.

Exceptions

Throws SetaPDF_Core_Document_ObjectNotFoundException

Throws SetaPDF_Core_Exception

Throws SetaPDF_Core_Parser_Pdf_InvalidTokenException

Throws SetaPDF_Core_Reader_Exception

Throws SetaPDF_Core_Type_Exception

Throws SetaPDF_Core_Type_IndirectReference_Exception

Throws SetaPDF_Exception

Throws SetaPDF_Exception_NotImplemented

getFileSpecification()

public SetaPDF_Core_FileSpecification::getFileSpecification (
void
): string|null

Get the file specification value.

getFileSystem()

public SetaPDF_Core_FileSpecification::getFileSystem (
void
): null|string

Get name of the file system.

getUnicodeFileSpecification()

public SetaPDF_Core_FileSpecification::getUnicodeFileSpecification (
[ string $encoding = 'UTF-8' ]
): string|null

Get the unicode text file specification value.

Parameters
$encoding : string
 

getVolatile()

public SetaPDF_Core_FileSpecification::getVolatile (
void
): boolean

Get the volatile flag.

setCollectionItem()

public SetaPDF_Core_FileSpecification::setCollectionItem (
[ SetaPDF_Core_Type_Dictionary|null $item = null ]
): void

Set the collection item data.

Parameters
$item : SetaPDF_Core_Type_Dictionary|null
 

setDescription()

public SetaPDF_Core_FileSpecification::setDescription (
string|null $desc [, string $encoding = 'UTF-8' ]
): void

Set the descriptive text associated with the file specification.

Parameters
$desc : string|null
 
$encoding : string
 

setEmbeddedFileStream()

public SetaPDF_Core_FileSpecification::setEmbeddedFileStream (
SetaPDF_Core_EmbeddedFileStream $embeddedFileStream [, bool $unicode = false ]
): void

Set the embedded file stream object.

Parameters
$embeddedFileStream : SetaPDF_Core_EmbeddedFileStream
 
$unicode : bool

If true use the UF key, otherwise the F key.

setFileSpecification()

public SetaPDF_Core_FileSpecification::setFileSpecification (
string|null $fileSpecification
): void

Set the file specification value.

Parameters
$fileSpecification : string|null
 

setFileSystem()

public SetaPDF_Core_FileSpecification::setFileSystem (
null|string $fileSystem
): void

Set the file system name.

Parameters
$fileSystem : null|string
 

setUnicodeFileSpecification()

public SetaPDF_Core_FileSpecification::setUnicodeFileSpecification (
string|null $fileSpecification [, string $encoding = 'UTF-8' ]
): void

Set the unicode text file specification value.

Parameters
$fileSpecification : string|null
 
$encoding : string
 

setVolatile()

public SetaPDF_Core_FileSpecification::setVolatile (
boolean|null $volatile
): void

Set the volatile flag.

Parameters
$volatile : boolean|null
 

© 2024 Setasign GmbH & Co. KG · Contact / Imprint · Data Privacy Statement (German)