PascalRAL

Class TRALParams

Description
Hierarchy
Nested Classes and Records
Fields
Methods
Properties

Unit

RALParams

Declaration

type TRALParams = class(TObject)

Description

Collection of TRALParam objects

Hierarchy

Overview

Nested Classes and Records

Public TEnumerator = class(TObject)

Methods

Public constructor Create;
Public destructor Destroy; override;
Public function AddFile(const AParamName: StringRAL; const AFileName: StringRAL): TRALParam; overload;
Public function AddFile(const AFileName: StringRAL): TRALParam; overload;
Public function AddParam(const AName: StringRAL; const AValue: StringRAL; AKind: TRALParamKind = rpkNONE): TRALParam; overload;
Public function AddParam(const AName: StringRAL; AContent: TStream; AKind: TRALParamKind = rpkNONE): TRALParam; overload;
Public function AddValue(const AContent: StringRAL; AKind: TRALParamKind = rpkNONE): TRALParam; overload;
Public function AddValue(AContent: TStream; AKind: TRALParamKind = rpkNONE): TRALParam; overload;
Public function AsJSON: StringRAL;
Public function AssignParamsListText(AKind: TRALParamKind; const ANameSeparator: StringRAL = '='): StringRAL;
Public function AssignParamsText(AKind: TRALParamKind; AUrlEncoded: boolean = False; const ANameSeparator: StringRAL = '='; const ALineSeparator: StringRAL = '&'): StringRAL;
Public function AssignParamsUrl(AKind: TRALParamKind): StringRAL;
Public function AsString: StringRAL;
Public function Count: IntegerRAL; overload;
Public function Count(AKind: TRALParamKind): IntegerRAL; overload;
Public function Count(AKinds: TRALParamKinds): IntegerRAL; overload;
Public function DecodeBody(ASource: TStream; const AContentType: StringRAL; const AContentDisposition: StringRAL = ''): TStream; overload;
Public function DecodeBody(const ASource, AContentType: StringRAL; const AContentDisposition: StringRAL = ''): TStream; overload;
Public function EncodeBody(var AContentType, AContentDisposition: StringRAL): TStream;
Public function GetEnumerator: TEnumerator; inline;
Public function NewParam: TRALParam;
Public function URLEncodedToList(ASource: StringRAL): TStringList;
Protected function Compress(AStream: TStream): TStream;
Protected function Decompress(AStream: TStream): TStream; overload;
Protected function Decompress(const ASource: StringRAL): StringRAL; overload;
Protected function Decrypt(const ASource: StringRAL): StringRAL; overload;
Protected function Decrypt(AStream: TStream): TStream; overload;
Protected function Encrypt(AStream: TStream): TStream;
Protected function FindBodyNameSeparator(const ASource: StringRAL): StringRAL;
Protected function FindHeaderNameSeparator(const ASource: StringRAL): StringRAL;
Protected function GetBody: TList;
Protected function GetParam(AIndex: IntegerRAL; AKind: TRALParamKind): TRALParam; overload;
Protected function GetParam(AName: StringRAL; AKind: TRALParamKind): TRALParam; overload;
Protected function GetParam(AName: StringRAL): TRALParam; overload;
Protected function GetParam(AIndex: IntegerRAL): TRALParam; overload;
Protected function NextParamInt: IntegerRAL;
Protected function NextParamStr: StringRAL;
Public procedure AppendBodyParams(ASource: TStrings; AKind: TRALParamKind);
Public procedure AppendParams(ASource: TStrings; AKind: TRALParamKind); overload;
Public procedure AppendParams(ASource: TStringList; AKind: TRALParamKind); overload;
Public procedure AppendParamsListText(ASource: StringRAL; AKind: TRALParamKind; ANameSeparator: StringRAL = '');
Public procedure AppendParamsText(AText: StringRAL; AKind: TRALParamKind; const ANameSeparator: StringRAL = '='; const ALineSeparator: StringRAL = '&');
Public procedure AppendParamsUri(AFullURI, APartialURI: StringRAL; AKind: TRALParamKind);
Public procedure AppendParamsUrl(AUrlQuery: StringRAL; AKind: TRALParamKind);
Public procedure AssignParams(ADest: TStrings; AKind: TRALParamKind; ASeparator: StringRAL = '='); overload;
Public procedure AssignParams(ADest: TStringList; AKind: TRALParamKind; ASeparator: StringRAL = '='); overload;
Public procedure ClearParams(AKind: TRALParamKind); overload;
Public procedure ClearParams; overload;
Public procedure DecodeFields(const ASource: StringRAL; AKind: TRALParamKind = rpkFIELD);
Public procedure DelParam(const AName: StringRAL); overload;
Public procedure DelParam(const AName: StringRAL; AKind: TRALParamKind); overload;
Protected procedure AppendParamLine(const ALine: StringRAL; const ANameSeparator: StringRAL; AKind: TRALParamKind);
Protected procedure OnFormBodyData(Sender: TObject; AFormData: TRALMultipartFormData; var AFreeData: Boolean);

Properties

Public property Body: TList read GetBody;
Published property CompressType: TRALCompressType read FCompressType write FCompressType;
Published property ContentDispositionInline: Boolean read FContentDispositionInline write FContentDispositionInline;
Published property CriptoOptions: TRALCriptoOptions read FCriptoOptions write FCriptoOptions;
Public property Get[AName:StringRAL]: TRALParam read GetParam;
Public property GetKind[AName:StringRAL;AKind:TRALParamKind]: TRALParam read GetParam;
Public property Index[AIndex:IntegerRAL]: TRALParam read GetParam;
Public property IndexKind[AIndex:IntegerRAL;AKind:TRALParamKind]: TRALParam read GetParam;

Description

Methods

Public constructor Create;
 
Public destructor Destroy; override;
 
Public function AddFile(const AParamName: StringRAL; const AFileName: StringRAL): TRALParam; overload;

Locate the RALParam with the given AParamName and fills it with a file from the AFileName.

Public function AddFile(const AFileName: StringRAL): TRALParam; overload;

Creates a new RALParam in the internal list and fills it with a file from the AFileName.

Public function AddParam(const AName: StringRAL; const AValue: StringRAL; AKind: TRALParamKind = rpkNONE): TRALParam; overload;

AddParam is used to include a TRALParam Object into the internal list.

Public function AddParam(const AName: StringRAL; AContent: TStream; AKind: TRALParamKind = rpkNONE): TRALParam; overload;

AddParam is used to include a TRALParam Object into the internal list.

Public function AddValue(const AContent: StringRAL; AKind: TRALParamKind = rpkNONE): TRALParam; overload;

AddValue creates a new RALParam in the internal list and fills it with the given parameters.

Public function AddValue(AContent: TStream; AKind: TRALParamKind = rpkNONE): TRALParam; overload;

AddValue creates a new RALParam in the internal list and fills it with the given parameters.

Public function AsJSON: StringRAL;

returns all the params in a JSON UTF8string format.

Public function AssignParamsListText(AKind: TRALParamKind; const ANameSeparator: StringRAL = '='): StringRAL;

Returns an UTF8 String with RALParams matching 'AKind'.

Public function AssignParamsText(AKind: TRALParamKind; AUrlEncoded: boolean = False; const ANameSeparator: StringRAL = '='; const ALineSeparator: StringRAL = '&'): StringRAL;

Returns an UTF8 String with RALParams matching 'AKind'. Can accept a different Line Separator than CRLF.

Public function AssignParamsUrl(AKind: TRALParamKind): StringRAL;

Returns an UTF8 String with RALParams matching 'AKind' using default URL separators.

Public function AsString: StringRAL;

returns all the params in a comma separated UTF8string.

Public function Count: IntegerRAL; overload;

Returns total ammount of RALParams.

Public function Count(AKind: TRALParamKind): IntegerRAL; overload;

Returns total ammount of RALParams matching AKind.

Public function Count(AKinds: TRALParamKinds): IntegerRAL; overload;

Returns total ammount of RALParams matching multiple kinds.

Public function DecodeBody(ASource: TStream; const AContentType: StringRAL; const AContentDisposition: StringRAL = ''): TStream; overload;

Returns a TStream with the filtered Stream body contents.

Public function DecodeBody(const ASource, AContentType: StringRAL; const AContentDisposition: StringRAL = ''): TStream; overload;

Returns a TStream with the filtered String body contents.

Public function EncodeBody(var AContentType, AContentDisposition: StringRAL): TStream;

Returns a TStream with all RALParams that matches 'Body' Kind.

Public function GetEnumerator: TEnumerator; inline;

Retuns the internal Enumerator type to allow for..in loops

Public function NewParam: TRALParam;

creates and returns an empty param for a more flexible way of coding.

Public function URLEncodedToList(ASource: StringRAL): TStringList;

converts a HTML encoded URL into a TStringList.

Protected function Compress(AStream: TStream): TStream;

Compresses the input stream into a TStream.

Protected function Decompress(AStream: TStream): TStream; overload;

Decompresses the input stream into a TStream.

Protected function Decompress(const ASource: StringRAL): StringRAL; overload;

Decompresses the input string into an UTF8 String.

Protected function Decrypt(const ASource: StringRAL): StringRAL; overload;

Decrypts the input string into an UTF8 String.

Protected function Decrypt(AStream: TStream): TStream; overload;

Decrypts the input stream into a TStream.

Protected function Encrypt(AStream: TStream): TStream;

Encrypts the whole class instead of each individual object.

Protected function FindBodyNameSeparator(const ASource: StringRAL): StringRAL;
 
Protected function FindHeaderNameSeparator(const ASource: StringRAL): StringRAL;

Results either = or : if found on the input text.

Protected function GetBody: TList;
 
Protected function GetParam(AIndex: IntegerRAL; AKind: TRALParamKind): TRALParam; overload;
 
Protected function GetParam(AName: StringRAL; AKind: TRALParamKind): TRALParam; overload;
 
Protected function GetParam(AName: StringRAL): TRALParam; overload;
 
Protected function GetParam(AIndex: IntegerRAL): TRALParam; overload;
 
Protected function NextParamInt: IntegerRAL;

Moves to the next param and returns its index.

Protected function NextParamStr: StringRAL;

Moves to the next param and returns its internal name.

Public procedure AppendBodyParams(ASource: TStrings; AKind: TRALParamKind);

Used to append a list of params (ASource) from the body to the current params list.

Public procedure AppendParams(ASource: TStrings; AKind: TRALParamKind); overload;

Used to append a list of params (ASource) to the current params list.

Public procedure AppendParams(ASource: TStringList; AKind: TRALParamKind); overload;

Used to append a list of params (ASource) to the current params list.

Public procedure AppendParamsListText(ASource: StringRAL; AKind: TRALParamKind; ANameSeparator: StringRAL = '');

Used to append a list of params in a string to the current params list.

Public procedure AppendParamsText(AText: StringRAL; AKind: TRALParamKind; const ANameSeparator: StringRAL = '='; const ALineSeparator: StringRAL = '&');

Appends params based on a string 'AText'.

Public procedure AppendParamsUri(AFullURI, APartialURI: StringRAL; AKind: TRALParamKind);

Appends params based on the full URL given separated by '/'.

Public procedure AppendParamsUrl(AUrlQuery: StringRAL; AKind: TRALParamKind);

Appends params based on the full URL given.

Public procedure AssignParams(ADest: TStrings; AKind: TRALParamKind; ASeparator: StringRAL = '='); overload;

Fills the 'ADest' Strings with RALParams matching 'AKind'.

Public procedure AssignParams(ADest: TStringList; AKind: TRALParamKind; ASeparator: StringRAL = '='); overload;

Fills the 'ADest' StringList with RALParams matching 'AKind'.

Public procedure ClearParams(AKind: TRALParamKind); overload;

Clears all params matching AKind.

Public procedure ClearParams; overload;

Clears all params.

Public procedure DecodeFields(const ASource: StringRAL; AKind: TRALParamKind = rpkFIELD);

Decode and append RALParams based on the ASource input.

Public procedure DelParam(const AName: StringRAL); overload;

Removes a RALParam matching the given AName.

Public procedure DelParam(const AName: StringRAL; AKind: TRALParamKind); overload;

Removes a RALParam matching the given AName and AKind.

Protected procedure AppendParamLine(const ALine: StringRAL; const ANameSeparator: StringRAL; AKind: TRALParamKind);

Decodes the ALine URL and adds it to the param list.

Protected procedure OnFormBodyData(Sender: TObject; AFormData: TRALMultipartFormData; var AFreeData: Boolean);

Event to be called during the processing of FormData.

Properties

Public property Body: TList read GetBody;

Grabs only the body kind of params, excluding headers and cookies.

Published property CompressType: TRALCompressType read FCompressType write FCompressType;

Which algorithm to compress the content of params.

Published property ContentDispositionInline: Boolean read FContentDispositionInline write FContentDispositionInline;
 
Published property CriptoOptions: TRALCriptoOptions read FCriptoOptions write FCriptoOptions;

Configuration of the cryptography used on params for a secure P2P traffic.

Public property Get[AName:StringRAL]: TRALParam read GetParam;

Grabs a param by its name.

Public property GetKind[AName:StringRAL;AKind:TRALParamKind]: TRALParam read GetParam;

Grabs a param by its name and kind since you can have multiple kinds with same name.

Public property Index[AIndex:IntegerRAL]: TRALParam read GetParam;

Grabs a param by its index on the TRALParams list.

Public property IndexKind[AIndex:IntegerRAL;AKind:TRALParamKind]: TRALParam read GetParam;

Grabs a param by its index on the TRALParams list.



GitHub Repository
Generated by PasDoc 0.16.0.