Overview

Namespaces

  • Jlab
    • Eloglib

Classes

  • Attachment
  • FileAttachment
  • Logentry
  • LogentryUtil
  • URLAttachment
  • User

Exceptions

  • InvalidXMLException
  • IOException
  • LogentryException
  • LogRuntimeException
  • ServerException
  • UserException
  • Overview
  • Namespace
  • Class

Class Attachment

Class Attachment

Direct known subclasses

Jlab\Eloglib\FileAttachment, Jlab\Eloglib\URLAttachment
Abstract
Namespace: Jlab\Eloglib
Package: Jlab\Eloglib
Located at Attachment.php
Methods summary
public string
# getXML( string $name = 'Attachment' )

Return Attachment object as an XML DOMDocument

Return Attachment object as an XML DOMDocument

Parameters

$name
A name to use for the DOMElement being returned.

Returns

string
protected
# xmlWriteData( Jlab\Eloglib\xmlWriter $xw )

Write the data and its encoding attribute to XML.

Write the data and its encoding attribute to XML.

Parameters

$xw
public
# getCaption( )

Returns the caption text if it is set, or the base filename of the attachment if it is not.

Returns the caption text if it is set, or the base filename of the attachment if it is not.

This method can be called explicitly, but is also an interceptor method that will get invoked when a client reads $this->caption variable.

See

Jlab\Eloglib\Attachment::__get()
public mixed
# __get( string $var )

Magic method allows controlled access to class properties by checking to see if a "getVariableName()" method exists, and if so, invoking it in lieu of direct read of "variableName".

Magic method allows controlled access to class properties by checking to see if a "getVariableName()" method exists, and if so, invoking it in lieu of direct read of "variableName".

Parameters

$var

Returns

mixed
Properties summary
protected string $data

Attachment content.

Attachment content.

Can be base64-encoded bytes of the file or just a URL

#
protected string $type

Attachment MIME-TYPE.

Attachment MIME-TYPE.

#
protected string $encoding

Indicates the format of $data.

Indicates the format of $data.

Valid values are "base64" or "url"

#
protected string $caption

Text describing the attachment

Text describing the attachment

#
API documentation generated by ApiGen