WebFioriAPI ReferenceLearnDownloadContributeLearn{{result.parent_page}} > {{result.title}}{{result.title}}Classes{{result.class_name}}{{result.summary}}Methods{{result.name}}{{result.summary}}

namespace \webfiori\framework\cron

class JobArgument

Class Methods Summary

public function __construct(string$name, string$desc)Creates new instance of the class.public function getDescription()Returns argument description.public function getName()Returns the name of the argument.public function getValue()Returns the value of job argument.public function setDescription(string$desc)Sets a description for the argument.public function setName(string$name)Sets the name of the argument.public function toJSON()Returns an object that represents the argument in JSON.

Class Methods Details

public function __construct(string$name, string$desc)Creates new instance of the class.

Parameters:

  • string $name The name of the argument. It will be considered invalid if it contains one of the following characters: '=', '&', '#' and '?'.
  • string $desc A string that describes how the argument will affect job execution. It must be non-empty string in order to be set.
public function getDescription()Returns argument description. Returns: stringA string that describes how the argument will affect job execution. Default return value is 'NO DESCRIPTION'.public function getName()Returns the name of the argument. Returns: stringThe name of the argument.public function getValue()Returns the value of job argument. The method will search for the value of the argument in the array $_POST. Note that the index that will be checked is the name of the argument.Returns: string|nullIf the value of the argument is set, it will be returned as string. Other than that, null is returned.public function setDescription(string$desc)Sets a description for the argument.

Parameters:

  • string $desc A string that describes how the argument will affect job execution. It must be non-empty string in order to be set.
Returns: booleanIf the description is set, the method will return true. false if not set.public function setName(string$name)Sets the name of the argument.

Parameters:

  • string $name The name of the argument. It will be considered invalid if it contains one of the following characters: '=', '&', '#' and '?'.
public function toJSON()Returns an object that represents the argument in JSON. Returns: JsonAn object that holds the following JSON attributes:
  • name
  • description
mdi-menuAll Classesmdi-chevron-leftAnchorBrCodeSnippetHTMLDocHTMLListHTMLNodeHTMLTableHeadNodeInputJsCodeLabelListItemOrderedListParagraphRadioGroupTableCellTableRowUnorderedListInvalidNodeNameExceptionTemplateNotFoundExceptionCaseConverterJsonJsonConverterJsonIJsonTypesPropertyAPIFilterAbstractWebServiceManagerInfoServiceParamTypesRequestRequestParameterResponseUriWebServicesManagerAccessAutoLoaderConfigConfigControllerDBEAbstractWebServiceExtendedWebServicesManagerFileLoggerPrivilegePrivilegesGroupThemeThemeLoaderUploadFileUploaderUserUtilWebFioriAppLanguageErrorBoxHTTPCodeViewMessageBoxServerErrViewStarterPageWebPageDatabaseSessionStorageDefaultSessionStorageMSSQLSessionDataTableMSSQLSessionsTableMySQLSessionDataTableMySQLSessionsTableSessionSessionOperationsSessionStorageSessionsManagerRouterRouterUriAbstractMiddlewareMiddlewareManagerEmailMessageSMTPAccountSMTPServerClassLoaderExceptionFileExceptionInitializationExceptionInvalidCRONExprExceptionMissingLangExceptionNoSuchThemeExceptionRoutingExceptionSMTPExceptionSessionExceptionUIExceptionAbstractJobCronCronEmailCronJobJobArgumentCronLoginViewCronTasksViewCronViewCronLoginServiceCronLogoutServiceCronServicesManagerForceCronExecutionServiceGetJobsServiceCLICLICommandInputStreamOutputStreamStdInStdOutClassWriterLangClassWriterQueryClassWriterServiceHolderThemeClassWriterWebServiceWriterCreateCLIClassHelperCreateCronJobCreateMiddlewareCreateTableCreateTableObjCreateThemeHelperCreateWebServiceAddCommandCreateCommandCronCommandHelpCommandListCronCommandListRoutesCommandListThemesCommandRunSQLQueryCommandSettingsCommandTestRouteCommandUpdateSettingsCommandUpdateTableCommandVersionCommandAbstractQueryColumnColumnFactoryConditionConnectionConnectionInfoDatabaseDatabaseExceptionDateTimeValidatorEntityMapperExpressionForeignKeyJoinTableResultSetSelectExpressionTableWhereExpressionMySQLColumnMySQLConnectionMySQLQueryMySQLTableMSSQLColumnMSSQLConnectionMSSQLQueryMSSQLTableAbstractCollectionComparableLinkedListNodeQueueStackPowered By: WebFiori Framework, Vue and VuetifyAll Rights Reserved © 2018 - 2024