PHP Class Pimcore\Model\Object\ClassDefinition\Data\Password

Inheritance: extends Pimcore\Model\Object\ClassDefinition\Data
Show file Open project: pimcore/pimcore

Public Properties

Property Type Description
$algorithm string
$columnType string Type for the column
$fieldtype string Static type of this element
$phpdocType string Type for the generated phpdoc
$queryColumnType string Type for the column to query
$salt string
$saltlocation string
$width integer

Public Methods

Method Description
calculateHash ( $data ) : boolean | null | string Calculate hash according to configured parameters
getAlgorithm ( ) : string
getDataForEditmode ( string $data, null | AbstractObject $object = null, mixed $params = [] ) : string
getDataForGrid ( $data, $object, $params = [] )
getDataForQueryResource ( string $data, null | AbstractObject $object = null, mixed $params = [] ) : string
getDataForResource ( string $data, null | AbstractObject $object = null, mixed $params = [] ) : string
getDataFromEditmode ( string $data, null | AbstractObject $object = null, mixed $params = [] ) : string
getDataFromResource ( string $data, null | AbstractObject $object = null, mixed $params = [] ) : string
getDiffDataForEditMode ( mixed $data, null $object = null, mixed $params = [] ) : array | null See parent class.
getDiffDataFromEditmode ( $data, null $object = null, mixed $params = [] ) : null | Pimcore_Date See parent class.
getForWebserviceExport ( string $object, mixed $params = [] ) : mixed converts data to be exposed via webservices
getFromCsvImport ( string $importValue, null | AbstractObject $object = null, mixed $params = [] ) : Data fills object field data values from CSV Import String
getSalt ( ) : string
getSaltlocation ( ) : string
getVersionPreview ( string $data, null | AbstractObject $object = null, mixed $params = [] ) : string
getWidth ( ) : integer
isDiffChangeAllowed ( string $object, mixed $params = [] ) : boolean True if change is allowed in edit mode.
setAlgorithm ( string $algorithm )
setSalt ( string $salt )
setSaltlocation ( string $saltlocation )
setWidth ( integer $width )
synchronizeWithMasterDefinition ( Data $masterDefinition )
verifyPassword ( $password, AbstractObject $object, boolean | true $updateHash = true ) : boolean Verify password. Optionally re-hash the password if needed.

Method Details

calculateHash() public method

Calculate hash according to configured parameters
public calculateHash ( $data ) : boolean | null | string
$data
return boolean | null | string

getAlgorithm() public method

public getAlgorithm ( ) : string
return string

getDataForEditmode() public method

See also: Object\ClassDefinition\Data::getDataForEditmode
public getDataForEditmode ( string $data, null | AbstractObject $object = null, mixed $params = [] ) : string
$data string
$object null | Pimcore\Model\Object\AbstractObject
$params mixed
return string

getDataForGrid() public method

public getDataForGrid ( $data, $object, $params = [] )

getDataForQueryResource() public method

See also: Object\ClassDefinition\Data::getDataForQueryResource
public getDataForQueryResource ( string $data, null | AbstractObject $object = null, mixed $params = [] ) : string
$data string
$object null | Pimcore\Model\Object\AbstractObject
$params mixed
return string

getDataForResource() public method

See also: Object\ClassDefinition\Data::getDataForResource
public getDataForResource ( string $data, null | AbstractObject $object = null, mixed $params = [] ) : string
$data string
$object null | Pimcore\Model\Object\AbstractObject
$params mixed
return string

getDataFromEditmode() public method

See also: Model\Object\ClassDefinition\Data::getDataFromEditmode
public getDataFromEditmode ( string $data, null | AbstractObject $object = null, mixed $params = [] ) : string
$data string
$object null | Pimcore\Model\Object\AbstractObject
$params mixed
return string

getDataFromResource() public method

See also: Object\ClassDefinition\Data::getDataFromResource
public getDataFromResource ( string $data, null | AbstractObject $object = null, mixed $params = [] ) : string
$data string
$object null | Pimcore\Model\Object\AbstractObject
$params mixed
return string

getDiffDataForEditMode() public method

See parent class.
public getDiffDataForEditMode ( mixed $data, null $object = null, mixed $params = [] ) : array | null
$data mixed
$object null
$params mixed
return array | null

getDiffDataFromEditmode() public method

See parent class.
public getDiffDataFromEditmode ( $data, null $object = null, mixed $params = [] ) : null | Pimcore_Date
$data
$object null
$params mixed
return null | Pimcore_Date

getForWebserviceExport() public method

converts data to be exposed via webservices
public getForWebserviceExport ( string $object, mixed $params = [] ) : mixed
$object string
$params mixed
return mixed

getFromCsvImport() public method

fills object field data values from CSV Import String
public getFromCsvImport ( string $importValue, null | AbstractObject $object = null, mixed $params = [] ) : Data
$importValue string
$object null | Pimcore\Model\Object\AbstractObject
$params mixed
return Pimcore\Model\Object\ClassDefinition\Data

getSalt() public method

public getSalt ( ) : string
return string

getSaltlocation() public method

public getSaltlocation ( ) : string
return string

getVersionPreview() public method

See also: Object\ClassDefinition\Data::getVersionPreview
public getVersionPreview ( string $data, null | AbstractObject $object = null, mixed $params = [] ) : string
$data string
$object null | Pimcore\Model\Object\AbstractObject
$params mixed
return string

getWidth() public method

public getWidth ( ) : integer
return integer

isDiffChangeAllowed() public method

True if change is allowed in edit mode.
public isDiffChangeAllowed ( string $object, mixed $params = [] ) : boolean
$object string
$params mixed
return boolean

setAlgorithm() public method

public setAlgorithm ( string $algorithm )
$algorithm string

setSalt() public method

public setSalt ( string $salt )
$salt string

setSaltlocation() public method

public setSaltlocation ( string $saltlocation )
$saltlocation string

setWidth() public method

public setWidth ( integer $width )
$width integer

synchronizeWithMasterDefinition() public method

public synchronizeWithMasterDefinition ( Data $masterDefinition )
$masterDefinition Pimcore\Model\Object\ClassDefinition\Data

verifyPassword() public method

Re-hash will be performed if PHP's password_hash default params (algorithm, cost) differ from the ones which were used to create the hash (e.g. cost was increased from 10 to 12). In this case, the hash will be re-calculated with the new parameters and saved back to the object.
public verifyPassword ( $password, AbstractObject $object, boolean | true $updateHash = true ) : boolean
$password
$object Pimcore\Model\Object\AbstractObject
$updateHash boolean | true
return boolean

Property Details

$algorithm public property

public string $algorithm
return string

$columnType public property

Type for the column
public string $columnType
return string

$fieldtype public property

Static type of this element
public string $fieldtype
return string

$phpdocType public property

Type for the generated phpdoc
public string $phpdocType
return string

$queryColumnType public property

Type for the column to query
public string $queryColumnType
return string

$salt public property

public string $salt
return string

$saltlocation public property

public string $saltlocation
return string

$width public property

public int $width
return integer