Pdf

Type
Class
Namespace
craft\commerce\services
Inherits
craft\commerce\services\Pdf » yii\base\Component » yii\base\BaseObject
Implements
yii\base\Configurable
Since
2.0

Pdf service.

View source

Public Properties

PropertyDescription
$behaviorsyii\base\Behavior – List of behaviors attached to this component

Public Methods

MethodDescription
__call()Calls the named method which is not a class method.
__clone()This method is called after the object is created by cloning an existing one.
__construct()Constructor.
__get()Returns the value of an object property.
__isset()Checks if a property is set, i.e. defined and not null.
__set()Sets value of an object property.
__unset()Sets an object property to null.
attachBehavior()Attaches a behavior to this component.
attachBehaviors()Attaches a list of behaviors to the component.
behaviors()Returns a list of behaviors that this component should behave as.
canGetProperty()Returns a value indicating whether a property can be read.
canSetProperty()Returns a value indicating whether a property can be set.
className()Returns the fully qualified name of this class.
detachBehavior()Detaches a behavior from the component.
detachBehaviors()Detaches all behaviors from the component.
ensureBehaviors()Makes sure that the behaviors declared in behaviors() are attached to this component.
getBehavior()Returns the named behavior object.
getBehaviors()Returns all behaviors attached to this component.
hasEventHandlers()Returns a value indicating whether there is any handler attached to the named event.
hasMethod()Returns a value indicating whether a method is defined.
hasProperty()Returns a value indicating whether a property is defined.
init()Initializes the object.
off()Detaches an existing event handler from this component.
on()Attaches an event handler to an event.
renderPdfForOrder()Returns a rendered PDF object for the order.
trigger()Triggers an event.

renderPdfForOrder()

Returns a rendered PDF object for the order.

View source

Arguments

Returns

string

Throws

Signature

public string renderPdfForOrder ( craft\commerce\elements\Order $order, $option = '', $templatePath = null )

Events

EVENT_AFTER_RENDER_PDF

Type
craft\commerce\events\PdfEvent

The event that is triggered after a PDF is rendered

EVENT_BEFORE_RENDER_PDF

Type
craft\commerce\events\PdfEvent

The event that is triggered before a PDF is rendered Event handlers can override Commerce's PDF generation by setting craft\commerce\events\PdfEvent::$pdf to a custom-rendered PDF.