setasign\SetaPDF2\Core\Document\Action
UriAction Class representing an URI action
File: /SetaPDF v2/Core/Document/Action/UriAction.php
Old class name (alias):
\SetaPDF_Core_Document_Action_Uri
Resolve a uniform resource identifier. See PDF 32000-1:2008 - 12.6.4.7
Class hierarchy
Summary
Properties
Static Methods
byObjectOrDictionary()
public static Action::byObjectOrDictionary (
\setasign\SetaPDF2\Core\Type\PdfIndirectObject|\setasign\SetaPDF2\Core\Type\PdfIndirectReference|\setasign\SetaPDF2\Core\Type\PdfDictionary $objectOrDictionary
): ActionCreates an action object by an action dictionary.
Parameters
- $objectOrDictionary : \setasign\SetaPDF2\Core\Type\PdfIndirectObject|\setasign\SetaPDF2\Core\Type\PdfIndirectReference|\setasign\SetaPDF2\Core\Type\PdfDictionary
Exceptions
Throws \setasign\SetaPDF2\Core\Type\Exception
Throws \InvalidArgumentException
createActionDictionary()
public static UriAction::createActionDictionary (
string|\setasign\SetaPDF2\Core\Type\PdfString $uri
): \setasign\SetaPDF2\Core\Type\PdfDictionaryCreate a URI Action dictionary.
Parameters
- $uri : string|\setasign\SetaPDF2\Core\Type\PdfString
Exceptions
Throws \InvalidArgumentException
Methods
__construct()
public UriAction::__construct (
string|\setasign\SetaPDF2\Core\Type\PdfDictionary|\setasign\SetaPDF2\Core\Type\IndirectObjectInterface $objectOrDictionary
)The constructor.
Parameters
- $objectOrDictionary : string|\setasign\SetaPDF2\Core\Type\PdfDictionary|\setasign\SetaPDF2\Core\Type\IndirectObjectInterface
Exceptions
Throws \InvalidArgumentException,\setasign\SetaPDF2\Core\Type\Exception
getIndirectObject()
public Action::getIndirectObject (
?\setasign\SetaPDF2\Core\Document $document = null
): \setasign\SetaPDF2\Core\Type\IndirectObjectInterfaceGet the indirect object of this annotation or creates it in the specific document context.
Parameters
- $document : ?\setasign\SetaPDF2\Core\Document
The document instance
getNext()
public Action::getNext (
void
): false|\setasign\SetaPDF2\Core\Type\PdfDictionary|\setasign\SetaPDF2\Core\Type\PdfArray|\setasign\SetaPDF2\Core\Type\PdfIndirectReferenceGets the PDF value of the next entry.
setIndirectObject()
public Action::setIndirectObject (
\setasign\SetaPDF2\Core\Type\IndirectObjectInterface $indirectReference
): voidSet the indirect object of this annotation.
Parameters
- $indirectReference : \setasign\SetaPDF2\Core\Type\IndirectObjectInterface
setNext()
public Action::setNext (
\setasign\SetaPDF2\Core\Type\PdfDictionary|Action|\setasign\SetaPDF2\Core\Type\IndirectObjectInterface $next
): voidSet the next action which should be executed after this one.