Свойство | Тип | Описание | |
---|---|---|---|
$_allow | mixed | false: none true: all array: List of permissions that are allowed | |
$_availablePermissions | array | Available permissions | |
$_cache | string | boolean | Cache config name, if set to false cache is disabled | |
$_cryptoClass | Instance of PdfCrypto class | ||
$_delay | integer | Javascript delay before rendering document in milliseconds | |
$_encoding | string | Encoding | |
$_engineClass | CakePdf\Pdf\Engine\AbstractPdfEngine | Instance of PdfEngine class | |
$_footer | string | Footer HTML | |
$_header | string | Header HTML | |
$_helpers | array | Helpers to be used in the render | |
$_html | string | Html to be rendered | |
$_layout | string | Layout for the View | |
$_layoutPath | string | Path to the layout - defaults to 'pdf' | |
$_marginBottom | number | Bottom margin in mm | |
$_marginLeft | number | Left margin in mm | |
$_marginRight | number | Right margin in mm | |
$_marginTop | number | Top margin in mm | |
$_orientation | string | Orientation of the pdf | |
$_ownerPassword | boolean | Owner password, used with crypto | |
$_pageSize | string | Page size of the pdf | |
$_protect | boolean | Flag that tells if we need to pass it through crypto | |
$_template | string | Template for the view | |
$_templatePath | string | Path to the template - defaults to 'Pdf' | |
$_theme | array | Theme for the View | |
$_title | string | Title of the document | |
$_userPassword | boolean | User password, used with crypto | |
$_viewRender | string | View for render | |
$_viewVars | array | Vars to sent to render | |
$_windowStatus | string | Window status required before rendering document |
Метод | Описание | |
---|---|---|
__construct ( array $config = [] ) | Constructor | |
cache ( null | boolean | string $cache = null ) : mixed | Get/Set caching. | |
crypto ( string $name = null ) : |
Load PdfCrypto | |
delay ( null | integer $delay = null ) : mixed | Get/Set javascript delay. | |
encoding ( null | string $encoding = null ) : mixed | Get/Set Encoding. | |
engine ( string $name = null ) : CakePdf\Pdf\Engine\AbstractPdfEngine | Load PdfEngine | |
footer ( null | string $left = null, null | string $center = null, null | string $right = null ) : mixed | Get/Set footer HTML. | |
header ( null | string $left = null, null | string $center = null, null | string $right = null ) : mixed | Get/Set header HTML. | |
helpers ( array $helpers = null ) : mixed | Helpers to be used in render | |
html ( null | string $html = null ) : mixed | Get/Set Html. | |
layoutPath ( mixed $layoutPath = false ) : mixed | Layout path | |
margin ( null | string | array $bottom = null, null | string $left = null, null | string $right = null, null | string $top = null ) : mixed | Get/Set page margins. | |
marginBottom ( null | string $margin = null ) : mixed | Get/Set bottom margin. | |
marginLeft ( null | string $margin = null ) : mixed | Get/Set left margin. | |
marginRight ( null | string $margin = null ) : mixed | Get/Set right margin. | |
marginTop ( null | string $margin = null ) : mixed | Get/Set top margin. | |
orientation ( null | string $orientation = null ) : mixed | Get/Set Orientation. | |
output ( null | string $html = null ) : string | Create pdf content from html. Can be used to write to file or with PdfView to display | |
ownerPassword ( null | string $password = null ) : mixed | Get/Set ownerPassword. | |
pageSize ( null | string $pageSize = null ) : mixed | Get/Set Page size. | |
permissions ( null | boolean | array $permissions = null ) : mixed | Get/Set permissions. | |
protect ( null | boolean $protect = null ) : mixed | Get/Set protection. | |
template ( mixed $template = false, mixed $layout = null ) : mixed | Template and layout | |
templatePath ( mixed $templatePath = false ) : mixed | Template path | |
theme ( string $theme = null ) : mixed | Theme to use when rendering | |
title ( null | string $title = null ) : mixed | Get/Set document title. | |
userPassword ( null | string $password = null ) : mixed | Get/Set userPassword | |
viewRender ( string $viewClass = null ) : mixed | View class for render | |
viewVars ( array $viewVars = null ) : mixed | Variables to be set on render | |
windowStatus ( null | string $status = null ) : mixed | Get/Set the required window status for rendering Waits until the status is equal to the string before rendering the pdf | |
write ( string $destination, boolean $create = true, string $html = null ) : boolean | Writes output to file |
Метод | Описание | |
---|---|---|
_render ( ) : array | Build and set all the view properties needed to render the layout and template. |
public __construct ( array $config = [] ) | ||
$config | array | Pdf configs to use |
public layoutPath ( mixed $layoutPath = false ) : mixed | ||
$layoutPath | mixed | The path of the layout file to use |
Результат | mixed |
public margin ( null | string | array $bottom = null, null | string $left = null, null | string $right = null, null | string $top = null ) : mixed | ||
$bottom | null | string | array | bottom margin, or array of margins |
$left | null | string | left margin |
$right | null | string | right margin |
$top | null | string | top margin |
Результат | mixed |
public templatePath ( mixed $templatePath = false ) : mixed | ||
$templatePath | mixed | The path of the template to use |
Результат | mixed |
public viewRender ( string $viewClass = null ) : mixed | ||
$viewClass | string | name of the view class to use |
Результат | mixed |
protected mixed $_allow | ||
Результат | mixed |
protected array $_availablePermissions | ||
Результат | array |
protected AbstractPdfCrypto,CakePdf\Pdf\Crypto $_cryptoClass | ||
Результат |
protected int $_delay | ||
Результат | integer |
protected AbstractPdfEngine,CakePdf\Pdf\Engine $_engineClass | ||
Результат | CakePdf\Pdf\Engine\AbstractPdfEngine |
protected array $_helpers | ||
Результат | array |
protected string $_layoutPath | ||
Результат | string |
protected number $_marginBottom | ||
Результат | number |
protected number $_marginRight | ||
Результат | number |
protected string $_orientation | ||
Результат | string |
protected bool $_ownerPassword | ||
Результат | boolean |
protected bool $_protect | ||
Результат | boolean |
protected string $_templatePath | ||
Результат | string |
protected bool $_userPassword | ||
Результат | boolean |
protected string $_windowStatus | ||
Результат | string |