include/Expressions/Actions/SetRequiredAction.php

Show:

inherited

Table of Contents

\SetRequiredAction
jump to top

Package:

Base action class


                 $expression= '""'

Default value""Details


                 $params= 'array()'

inheritedInherited from: \AbstractAction::$$params

Default valuearray()Details


                 $targetField= 'array()'

inheritedInherited from: \AbstractAction::$$targetField

Default valuearray()Details

AbstractAction(
          Array $params
          )
        
        :
          \AbstractAction

inherited

Actions are expressions which modify data or layouts.

Inherited from: \AbstractAction::AbstractAction()

Parameters

Name	Type	Description
$params	Array	A set of parameters to use in this action.

Returns

Type	Description
\AbstractAction

SetRequiredAction(
           $params
          )
        
        :
          void

Parameters

Name	Type	Description
$params

fire(
          \SugarBeam $target
          )
        
        :
          void

Applies the Action to the target.

Parameters

Name	Type	Description
$target	\SugarBeam

getActionName(
          
          )
        
        :
          void

static

getDefinition(
          
          )
        
        :
          void

inherited

Returns the definition of this action in array format.

Inherited from: \AbstractAction::getDefinition()

getJavascriptClass(
          
          )
        
        :
          string

static

Returns the javascript class equavalent to this php class

Returns

Type	Description
string	javascript.

getJavascriptFire(
          
          )
        
        :
          string

Returns the javascript code to generate this actions equivalent.

Returns

Type	Description
string	javascript.