API Documentation
\
Alphred

\AlphredResult

Result class

Class object represents an item in the script filter array. The internals of the class check for validity so that only correct methods can be set.

Summary

Methods
Properties
Constants
__construct()
set()
__call()
set_arg()
set_autocomplete()
set_icon()
set_icon_fileicon()
set_icon_filetype()
set_subtitle()
set_subtitle_alt()
set_subtitle_cmd()
set_subtitle_ctrl()
set_subtitle_fn()
set_subtitle_shift()
set_text_copy()
set_text_largetype()
set_title()
set_uid()
No public properties found
No constants found
No protected methods found
No protected properties found
N/A
No private methods found
$string_methods
$bool_methods
N/A

Properties

$string_methods

$string_methods : array

Possible string methods for a Result

Type

array

$bool_methods

$bool_methods : array

Possible boolean methods for a Result

Type

array

Methods

__construct()

__construct(array|string  $args)

Creates a Result object

Parameters

array|string $args

the title if string; a list of arguments if an array

set()

set(array  $options)

Sets a multiple values of a result object

Parameters

array $options

an array of possible options

Throws

\Alphred\InvalidScriptFilterArgument

When trying to set an invalid script filter field

__call()

__call(string  $called, array  $arguments) : boolean

Magic method to set everything necessary

Parameters

string $called

method called
array $arguments

array of arguments

Throws

\Alphred\TooManyArguments

when trying to use multiple values

\Alphred\InvalidXMLProperty

when trying to set an invalid XML property

Returns

boolean

set_arg()

set_arg(string  $arg) : void

the argument to pass

Parameters

string $arg

set_autocomplete()

set_autocomplete(string  $autocomplete) : void

autocomplete text

Parameters

string $autocomplete

set_icon()

set_icon(string  $icon) : void

path to icon

Parameters

string $icon

set_icon_fileicon()

set_icon_fileicon(string  $fileicon) : void

path to application

Parameters

string $fileicon

set_icon_filetype()

set_icon_filetype(string  $filetype) : void

filetype for icon

Parameters

string $filetype

set_subtitle()

set_subtitle(string  $subtitle) : void

subtitle text

Parameters

string $subtitle

set_subtitle_alt()

set_subtitle_alt(string  $subtitle) : void

alt subtitle text

Parameters

string $subtitle

set_subtitle_cmd()

set_subtitle_cmd(string  $subtitle) : void

cmd subtitle text

Parameters

string $subtitle

set_subtitle_ctrl()

set_subtitle_ctrl(string  $subtitle) : void

ctrl subtitle text

Parameters

string $subtitle

set_subtitle_fn()

set_subtitle_fn(string  $subtitle) : void

fn subtitle text

Parameters

string $subtitle

set_subtitle_shift()

set_subtitle_shift(string  $subtitle) : void

shift subtitle text

Parameters

string $subtitle

set_text_copy()

set_text_copy(string  $text) : void

text to pass when copying

Parameters

string $text

set_text_largetype()

set_text_largetype(string  $text) : void

text to pass to large type

Parameters

string $text

set_title()

set_title(string  $title) : void

title of result

Parameters

string $title

set_uid()

set_uid(string  $uid) : void

uid for result

Parameters

string $uid