Property | Type | Description | |
---|---|---|---|
$binPath | string | Bin directory, should contain the phantomjs file, otherwise it won't work | |
$jobs | Jobs directory, directory for temporary files to be written and executed with phantomjs | ||
$output | Screen\Location\Output | Base directory to save the output files | |
$templatePath | string | Template directory, directory in which will be the js templates files to execute |
Property | Type | Description | |
---|---|---|---|
$backgroundColor | string | Default body background color is white | |
$clipHeight | integer | Height of the page to clip | |
$clipWidth | integer | Width of the page to clip | |
$height | integer | Height of the page to render | |
$imageLocation | string | Location where the file was written to | |
$imageType | Image Type, default is jpeg | ||
$includedJsScripts | array | List of included JS scripts | |
$includedJsSnippets | array | List of included JS snippets | |
$options | array | List of options which will be passed to phantomjs | |
$timeout | integer | Sets the timeout period | |
$url | string | URL to capture the screen of | |
$userAgentString | string | User Agent String used on the page request | |
$width | integer | Width of the page to render |
Method | Description | |
---|---|---|
__construct ( $url = null ) | Capture constructor. | |
getImageLocation ( ) : string | Returns the location where the screenshot file was written | |
getImageType ( ) : |
Returns the image type instance | |
includeJs ( string | URL $script ) : |
Adds a JS script or snippet to the screen shot script | |
save ( string $imageLocation, boolean $deleteFileIfExists = true ) : boolean | Saves the screenshot to the requested location | |
setBackgroundColor ( string $backgroundColor ) : |
Sets the page body background color | |
setBinPath ( $binPath ) | Sets the path to PhantomJS binary, example: "/usr/bin" | |
setClipHeight ( integer $clipHeight ) : |
Sets the height to clip | |
setClipWidth ( integer $clipWidth ) : |
Sets the width to clip | |
setHeight ( integer $height ) : |
Sets the page height | |
setImageType ( string $type ) : |
Sets the image type | |
setOptions ( array $options ) | Sets the options which will be passed to phantomjs | |
setTimeout ( integer $timeout ) : |
Sets the timeout period | |
setUrl ( string $url ) | Sets the url to screenshot | |
setUserAgentString ( string $userAgentString ) : |
Sets the User Agent String to be used on the page request | |
setWidth ( integer $width ) : |
Sets the page width |
Method | Description | |
---|---|---|
getOptionsString ( ) : string | ||
getTemplateResult ( string $templateName, array $args ) : string |
public getImageLocation ( ) : string | ||
return | string |
public getImageType ( ) : |
||
return |
public setBackgroundColor ( string $backgroundColor ) : |
||
$backgroundColor | string | Background Color |
return |
public setBinPath ( $binPath ) |
public setClipHeight ( integer $clipHeight ) : |
||
$clipHeight | integer | Page clip height |
return |
public setClipWidth ( integer $clipWidth ) : |
||
$clipWidth | integer | Page clip width |
return |
public setImageType ( string $type ) : |
||
$type | string | 'jpg', 'png', etc... |
return |
public setOptions ( array $options ) | ||
$options | array |
public setTimeout ( integer $timeout ) : |
||
$timeout | integer | Timeout period |
return |
public setUserAgentString ( string $userAgentString ) : |
||
$userAgentString | string | User Agent String |
return |
protected string $backgroundColor | ||
return | string |
public string $binPath | ||
return | string |
protected string $imageLocation | ||
return | string |
protected Type,Screen\Image\Types $imageType | ||
return |
protected array $includedJsScripts | ||
return | array |
protected array $includedJsSnippets | ||
return | array |
public Jobs,Screen\Location $jobs | ||
return |
protected array $options | ||
return | array |
public Output,Screen\Location $output | ||
return | Screen\Location\Output |
public string $templatePath | ||
return | string |
protected string $userAgentString | ||
return | string |