class GridFieldPrintButton implements GridField_HTMLProvider, GridField_ActionProvider, GridField_URLHandler

Adds an "Print" button to the bottom or top of a GridField.

Traits

Allows an object to have extensions applied to it.
Allows an object to declare a set of custom methods

Methods

mixed
__call(string $method, array $arguments)

Attempts to locate and call a method dynamically added to a class at runtime if a default cannot be located

bool
hasMethod(string $method)

Return TRUE if a method exists on this object

array
allMethodNames(bool $custom = false)

Return the names of all the methods available on this object

static bool
add_extension(string $classOrExtension, string $extension = null)

Add an extension to a specific class.

static 
remove_extension(string $extension)

Remove an extension from a class.

static array
get_extensions(string $class = null, bool $includeArgumentString = false)

No description

static array|null
get_extra_config_sources(string $class = null)

Get extra config sources for this class

static bool
has_extension(string $classOrExtension, string $requiredExtension = null, boolean $strict = false)

Return TRUE if a class has a specified extension.

array
invokeWithExtensions(string $method, mixed $a1 = null, mixed $a2 = null, mixed $a3 = null, mixed $a4 = null, mixed $a5 = null, mixed $a6 = null, mixed $a7 = null)

Calls a method if available on both this object and all applied {@link Extensions}, and then attempts to merge all results into an array

array
extend(string $method, mixed $a1 = null, mixed $a2 = null, mixed $a3 = null, mixed $a4 = null, mixed $a5 = null, mixed $a6 = null, mixed $a7 = null)

Run the given function on all of this object's extensions. Note that this method originally returned void, so if you wanted to return results, you're hosed

Extension|null
getExtensionInstance(string $extension)

Get an extension instance attached to this object by name.

bool
hasExtension(string $extension)

Returns TRUE if this object instance has a specific extension applied in {@link $extension_instances}. Extension instances are initialized at constructor time, meaning if you use {@link add_extension()} afterwards, the added extension will just be added to new instances of the extended class. Use the static method {@link has_extension()} to check if a class (not an instance) has a specific extension.

getExtensionInstances()

Get all extension instances for this specific object instance.

__construct(string $targetFragment = "after", array $printColumns = null)

No description

array
getHTMLFragments(GridField $gridField)

Place the print button in a

<

p> tag below the field

array
getActions(GridField $gridField)

Print is an action button.

handleAction(GridField $gridField, string $actionName, array $arguments, array $data)

Handle the print action.

array
getURLHandlers(GridField $gridField)

Print is accessible via the url

handlePrint(GridField $gridField, HTTPRequest $request = null)

Handle the print, for both the action button and the URL

array
getTitle(GridField $gridField)

Return the title of the printed page

generatePrintData(GridField $gridField)

Export core.

array
getPrintColumns()

No description

$this
setPrintColumns(array $cols)

No description

boolean
getPrintHasHeader()

No description

$this
setPrintHasHeader(bool $bool)

No description

Details

in CustomMethods at line 47
mixed __call(string $method, array $arguments)

Attempts to locate and call a method dynamically added to a class at runtime if a default cannot be located

You can add extra methods to a class using {@link Extensions}, {@link Object::createMethod()} or {@link Object::addWrapperMethod()}

Parameters

string $method
array $arguments

Return Value

mixed

Exceptions

BadMethodCallException

in CustomMethods at line 146
bool hasMethod(string $method)

Return TRUE if a method exists on this object

This should be used rather than PHP's inbuild method_exists() as it takes into account methods added via extensions

Parameters

string $method

Return Value

bool

in CustomMethods at line 176
array allMethodNames(bool $custom = false)

Return the names of all the methods available on this object

Parameters

bool $custom include methods added dynamically at runtime

Return Value

array

in Extensible at line 172
static bool add_extension(string $classOrExtension, string $extension = null)

Add an extension to a specific class.

The preferred method for adding extensions is through YAML config, since it avoids autoloading the class, and is easier to override in more specific configurations.

As an alternative, extensions can be added to a specific class directly in the {@link Object::$extensions} array. See {@link SiteTree::$extensions} for examples. Keep in mind that the extension will only be applied to new instances, not existing ones (including all instances created through {@link singleton()}).

Parameters

string $classOrExtension Class that should be extended - has to be a subclass of {@link Object}
string $extension Subclass of {@link Extension} with optional parameters as a string, e.g. "Versioned" or "Translatable('Param')"

Return Value

bool Flag if the extension was added

See also

http://doc.silverstripe.org/framework/en/trunk/reference/dataextension

in Extensible at line 236
static remove_extension(string $extension)

Remove an extension from a class.

Note: This will not remove extensions from parent classes, and must be called directly on the class assigned the extension.

Keep in mind that this won't revert any datamodel additions of the extension at runtime, unless its used before the schema building kicks in (in your _config.php). Doesn't remove the extension from any {@link Object} instances which are already created, but will have an effect on new extensions. Clears any previously created singletons through {@link singleton()} to avoid side-effects from stale extension information.

Parameters

string $extension class name of an {@link Extension} subclass, without parameters

in Extensible at line 278
static array get_extensions(string $class = null, bool $includeArgumentString = false)

Parameters

string $class If omitted, will get extensions for the current class
bool $includeArgumentString Include the argument string in the return array, FALSE would return array("Versioned"), TRUE returns array("Versioned('Stage','Live')").

Return Value

array Numeric array of either {@link DataExtension} class names, or eval'ed class name strings with constructor arguments.

in Extensible at line 312
static array|null get_extra_config_sources(string $class = null)

Get extra config sources for this class

Parameters

string $class Name of class. If left null will return for the current class

Return Value

array|null

in Extensible at line 373
static bool has_extension(string $classOrExtension, string $requiredExtension = null, boolean $strict = false)

Return TRUE if a class has a specified extension.

This supports backwards-compatible format (static Object::has_extension($requiredExtension)) and new format ($object->has_extension($class, $requiredExtension))

Parameters

string $classOrExtension Class to check extension for, or the extension name to check if the second argument is null.
string $requiredExtension If the first argument is the parent class, this is the extension to check. If left null, the first parameter will be treated as the extension.
boolean $strict if the extension has to match the required extension and not be a subclass

Return Value

bool Flag if the extension exists

in Extensible at line 415
array invokeWithExtensions(string $method, mixed $a1 = null, mixed $a2 = null, mixed $a3 = null, mixed $a4 = null, mixed $a5 = null, mixed $a6 = null, mixed $a7 = null)

Calls a method if available on both this object and all applied {@link Extensions}, and then attempts to merge all results into an array

Parameters

string $method the method name to call
mixed $a1
mixed $a2
mixed $a3
mixed $a4
mixed $a5
mixed $a6
mixed $a7

Return Value

array List of results with nulls filtered out

in Extensible at line 450
array extend(string $method, mixed $a1 = null, mixed $a2 = null, mixed $a3 = null, mixed $a4 = null, mixed $a5 = null, mixed $a6 = null, mixed $a7 = null)

Run the given function on all of this object's extensions. Note that this method originally returned void, so if you wanted to return results, you're hosed

Currently returns an array, with an index resulting every time the function is called. Only adds returns if they're not NULL, to avoid bogus results from methods just defined on the parent extension. This is important for permission-checks through extend, as they use min() to determine if any of the returns is FALSE. As min() doesn't do type checking, an included NULL return would fail the permission checks.

The extension methods are defined during {@link __construct()} in {@link defineMethods()}.

Parameters

string $method the name of the method to call on each extension
mixed $a1
mixed $a2
mixed $a3
mixed $a4
mixed $a5
mixed $a6
mixed $a7

Return Value

array

in Extensible at line 497
Extension|null getExtensionInstance(string $extension)

Get an extension instance attached to this object by name.

Parameters

string $extension

Return Value

Extension|null

in Extensible at line 526
bool hasExtension(string $extension)

Returns TRUE if this object instance has a specific extension applied in {@link $extension_instances}. Extension instances are initialized at constructor time, meaning if you use {@link add_extension()} afterwards, the added extension will just be added to new instances of the extended class. Use the static method {@link has_extension()} to check if a class (not an instance) has a specific extension.

Caution: Don't use singleton()->hasExtension() as it will give you inconsistent results based on when the singleton was first accessed.

Parameters

string $extension Classname of an {@link Extension} subclass without parameters

Return Value

bool

in Extensible at line 540
Extension[] getExtensionInstances()

Get all extension instances for this specific object instance.

See {@link get_extensions()} to get all applied extension classes for this class (not the instance).

This method also provides lazy-population of the extension_instances property.

Return Value

Extension[] Map of {@link DataExtension} instances, keyed by classname.

at line 47
__construct(string $targetFragment = "after", array $printColumns = null)

Parameters

string $targetFragment The HTML fragment to write the button into
array $printColumns The columns to include in the print view

at line 60
array getHTMLFragments(GridField $gridField)

Place the print button in a

<

p> tag below the field

Parameters

GridField $gridField

Return Value

array

at line 85
array getActions(GridField $gridField)

Print is an action button.

Parameters

GridField $gridField

Return Value

array with action identifier strings.

at line 99
handleAction(GridField $gridField, string $actionName, array $arguments, array $data)

Handle the print action.

Parameters

GridField $gridField
string $actionName Action identifier, see {@link getActions()}.
array $arguments Arguments relevant for this
array $data All form data

at line 112
array getURLHandlers(GridField $gridField)

Print is accessible via the url

Parameters

GridField $gridField

Return Value

array

at line 126
DBHTMLText handlePrint(GridField $gridField, HTTPRequest $request = null)

Handle the print, for both the action button and the URL

Parameters

GridField $gridField
HTTPRequest $request

Return Value

DBHTMLText

at line 174
array getTitle(GridField $gridField)

Return the title of the printed page

Parameters

GridField $gridField

Return Value

array

at line 207
ArrayData generatePrintData(GridField $gridField)

Export core.

Parameters

GridField $gridField

Return Value

ArrayData

at line 260
array getPrintColumns()

Return Value

array

at line 269
$this setPrintColumns(array $cols)

Parameters

array $cols

Return Value

$this

at line 279
boolean getPrintHasHeader()

Return Value

boolean

at line 288
$this setPrintHasHeader(bool $bool)

Parameters

bool $bool

Return Value

$this