Overview

Packages

  • AlfredBundler
  • None

Classes

  • CocoaDialog
  • ProgressBar
  • TerminalNotifier
  • Overview
  • Package
  • Class
  • Tree

Class CocoaDialog

Main class used for interaction with CocoaDialog.

Public class used to initialize the CocoaDialog interaction client. Client inintialization is built by:
$client = new CocoaDialog('path to CocoaDailog.app or exec', $debug=bool)

Initializes global options (dict) and global icons (list).

Copyright: Ritashugisha 2014
License: GPL v3
Located at cocoadialog.php
Methods summary
public
# log( string $level, string $funct, integer $lineno, string $message )

This function prints debug logs to the console.

This function prints debug logs to the console.

Parameters

$level
string
$level Logging level (adapted from Python's logging module)
$funct
string
$funct Calling function's name
$lineno
integer
$lineno Calling functions line number
$message
string
$message Desired message
public
# __construct( string $cocoa, boolean $debug = False )

CocoaDialog class constructor.

CocoaDialog class constructor.

Parameters

$cocoa
string
$cocoa Path to either CocoaDialog.app or exec
$debug
boolean
$debug True if logging is enabled
public
# _format_passed( mixed $passed )
public
# _format_notify( mixed $passed )
public string
# _run_subprocess( string $process )

Run a process on the host system.

Run a process on the host system.

Parameters

$process
string
$process Process to be run

Returns

string
Output of process
public boolean
# _valid_options( array $passed, array $custom_options )

Validate and clean up passed dialog options.

Validate and clean up passed dialog options.

Parameters

$passed
array
$passed Associative array of passed dialog arguemnts
$custom_options
array
$custom_options Associative array of calling dialog's unique arguments

Returns

boolean
True if OK for dialog to be shown
public string
# _display( string $funct, array $passed, boolean $return_process = False )

Display the passed dialog after some crutial formatting.

Display the passed dialog after some crutial formatting.

Parameters

$funct
string
$funct Dialog name
$passed
array
$passed Associative array of passed dialog options
$return_process
boolean
$return_process True if return process array instead of display

Returns

string
Output of dialog
public string
# bubble( array $_passed )

Dialog type bubble

Dialog type bubble

Valid parameters are listed at: <http://mstratman.github.io/cocoadialog/#documentation3.0/bubble_control>

Parameters

$_passed
array
$_passed Dialog paramenters

Returns

string
Output from dialog
public string
# notify( array $_passed )

Dialog type notify

Dialog type notify

Parameters

$_passed
array
$_passed Dialog paramenters

Returns

string
Output from dialog
public string
# checkbox( array $_passed )

Dialog type checkbox

Dialog type checkbox

Parameters

$_passed
array
$_passed Dialog paramenters

Returns

string
Output from dialog
public string
# radio( array $_passed )

Dialog type radio

Dialog type radio

Parameters

$_passed
array
$_passed Dialog paramenters

Returns

string
Output from dialog
public string
# slider( array $_passed )

Dialog type slider

Dialog type slider

Parameters

$_passed
array
$_passed Dialog paramenters

Returns

string
Output from dialog
public string
# msgbox( array $_passed )

Dialog type msgbox

Dialog type msgbox

Valid parameters are listed at: <http://mstratman.github.io/cocoadialog/#documentation3.0/msgbox_control>

Parameters

$_passed
array
$_passed Dialog paramenters

Returns

string
Output from dialog
public string
# ok_msgbox( array $_passed )

Dialog type ok_msgbox

Dialog type ok_msgbox

Valid parameters are listed at: <http://mstratman.github.io/cocoadialog/#documentation3.0/ok-msgbox_control>

Parameters

$_passed
array
$_passed Dialog paramenters

Returns

string
Output from dialog
public string
# yesno_msgbox( array $_passed )

Dialog type yesno_msgbox

Dialog type yesno_msgbox

Valid parameters are listed at: <http://mstratman.github.io/cocoadialog/#documentation3.0/yesno-msgbox_control>

Parameters

$_passed
array
$_passed Dialog paramenters

Returns

string
Output from dialog
public string
# inputbox( array $_passed )

Dialog type inputbox

Dialog type inputbox

Valid parameters are listed at: <http://mstratman.github.io/cocoadialog/#documentation3.0/inputbox_control>

Parameters

$_passed
array
$_passed Dialog paramenters

Returns

string
Output from dialog
public string
# standard_inputbox( array $_passed )

Dialog type standard_inputbox

Dialog type standard_inputbox

Valid parameters are listed at: <http://mstratman.github.io/cocoadialog/#documentation3.0/standard-box_control>

Parameters

$_passed
array
$_passed Dialog paramenters

Returns

string
Output from dialog
public string
# secure_inputbox( array $_passed )

Dialog type secure_inputbox

Dialog type secure_inputbox

Valid parameters are listed at: <http://mstratman.github.io/cocoadialog/#documentation3.0/secure-inputbox_control>

Parameters

$_passed
array
$_passed Dialog paramenters

Returns

string
Output from dialog
public string
# secure_standard_inputbox( array $_passed )

Dialog type secure_standard_inputbox

Dialog type secure_standard_inputbox

Valid parameters are listed at: <http://mstratman.github.io/cocoadialog/#documentation3.0/secure-standard-inputbox_control>

Parameters

$_passed
array
$_passed Dialog paramenters

Returns

string
Output from dialog
public string
# fileselect( array $_passed )

Dialog type fileselect

Dialog type fileselect

Valid parameters are listed at: <http://mstratman.github.io/cocoadialog/#documentation3.0/fileselect_control>

Parameters

$_passed
array
$_passed Dialog paramenters

Returns

string
Output from dialog
public string
# filesave( array $_passed )

Dialog type fileselect

Dialog type fileselect

Valid parameters are listed at: <http://mstratman.github.io/cocoadialog/#documentation3.0/fileselect_control>

Parameters

$_passed
array
$_passed Dialog paramenters

Returns

string
Output from dialog
public string
# textbox( array $_passed )

Dialog type textbox

Dialog type textbox

Valid parameters are listed at: <http://mstratman.github.io/cocoadialog/#documentation3.0/textbox_control>

Parameters

$_passed
array
$_passed Dialog paramenters

Returns

string
Output from dialog
public string
# dropdown( array $_passed )

Dialog type dropdown

Dialog type dropdown

Valid parameters are listed at: <http://mstratman.github.io/cocoadialog/#documentation3.0/dropdown_control>

Parameters

$_passed
array
$_passed Dialog paramenters

Returns

string
Output from dialog
public string
# standard_dropdown( array $_passed )

Dialog type standard_dropdown

Dialog type standard_dropdown

Valid parameters are listed at: <http://mstratman.github.io/cocoadialog/#documentation3.0/standard-dropdown_control>

Parameters

$_passed
array
$_passed Dialog paramenters

Returns

string
Output from dialog
Properties summary
public array $global_icons
#

Reference to a list of global icons.

Reference to a list of global icons.
Alfred Bundler API documentation generated by ApiGen 2.8.0