userAddressFields
extends fieldExtender
in package
This is the root class for use by plugins to extend the Zenphoto database table fields. The administrative tabs for the objects will have input items for these new fields. They will be placed in the proximate location of the "custom data" field on the page.
Table of Contents
- __construct() : mixed
- _addToSearch() : array<string|int, mixed>
- Updates the list of search fields to include the new fields
- _adminEdit() : string
- Displays the edit fields for user type objects
- _adminNotice() : type
- Notification of need to run setup
- _adminSave() : bool
- Process the save of user object type elements
- _getCustomData() : array<string|int, mixed>
- Returns an array with the content of the custom fields for the object
- _mediaItemEdit() : string
- Displays the edit fields for image and album objects
- _mediaItemSave() : mixed
- Processes the save of image and album objects
- _register() : mixed
- registers filters for handling display and edit of objects as appropriate
- _setCustomData() : mixed
- _zenpageItemEdit() : string
- Displays the edit fields for zenpage objects
- _zenpageItemSave() : string
- Processes the save of zenpage objects
- addToSearch() : mixed
- adminEdit() : mixed
- adminNotice() : mixed
- adminSave() : mixed
- constructor() : mixed
- This method establishes the current set of database fields. It will add the fields to the database if they are not already present. Fields from previous constructor calls that are no longer in the list will be removed from the database (along with any data associated with them.)
- fields() : mixed
- getCustomData() : mixed
- mediaItemEdit() : mixed
- mediaItemSave() : mixed
- register() : mixed
- setCustomData() : mixed
- zenpageItemEdit() : mixed
- zenpageItemSave() : mixed
Methods
__construct()
public
__construct() : mixed
Return values
mixed —_addToSearch()
Updates the list of search fields to include the new fields
public
static _addToSearch(array<string|int, mixed> $list, mixed $fields) : array<string|int, mixed>
Parameters
- $list : array<string|int, mixed>
-
the list of fields as known to the search engine
- $fields : mixed
Return values
array<string|int, mixed> —_adminEdit()
Displays the edit fields for user type objects
public
static _adminEdit(string $html, object $userobj, int $i, string $background, bool $current, mixed $fields) : string
Parameters
- $html : string
- $userobj : object
- $i : int
- $background : string
- $current : bool
- $fields : mixed
Return values
string —_adminNotice()
Notification of need to run setup
public
static _adminNotice(type $tab, type $subtab, type $me) : type
Parameters
- $tab : type
- $subtab : type
- $me : type
Return values
type —_adminSave()
Process the save of user object type elements
public
static _adminSave(bool $updated, object $userobj, int $i, bool $alter, mixed $fields) : bool
Parameters
- $updated : bool
- $userobj : object
- $i : int
- $alter : bool
- $fields : mixed
Return values
bool —_getCustomData()
Returns an array with the content of the custom fields for the object
public
static _getCustomData(object $obj, array<string|int, mixed> $fields) : array<string|int, mixed>
Parameters
- $obj : object
- $fields : array<string|int, mixed>
Return values
array<string|int, mixed> —_mediaItemEdit()
Displays the edit fields for image and album objects
public
static _mediaItemEdit(string $html, object $object, int $i, mixed $fields) : string
Parameters
- $html : string
- $object : object
- $i : int
- $fields : mixed
Return values
string —_mediaItemSave()
Processes the save of image and album objects
public
static _mediaItemSave(object $object, int $i, mixed $fields) : mixed
Parameters
- $object : object
- $i : int
- $fields : mixed
Return values
mixed —_register()
registers filters for handling display and edit of objects as appropriate
public
static _register(mixed $me, mixed $fields) : mixed
Parameters
- $me : mixed
- $fields : mixed
Return values
mixed —_setCustomData()
public
static _setCustomData(mixed $obj, mixed $values) : mixed
Parameters
- $obj : mixed
- $values : mixed
Return values
mixed —_zenpageItemEdit()
Displays the edit fields for zenpage objects
public
static _zenpageItemEdit(string $html, object $object, mixed $fields) : string
Parameters
- $html : string
- $object : object
- $fields : mixed
Return values
string —_zenpageItemSave()
Processes the save of zenpage objects
public
static _zenpageItemSave(string $custom, object $object, mixed $fields) : string
Parameters
- $custom : string
- $object : object
- $fields : mixed
Return values
string —addToSearch()
public
static addToSearch(mixed $list) : mixed
Parameters
- $list : mixed
Return values
mixed —adminEdit()
public
static adminEdit(mixed $html, mixed $userobj, mixed $i, mixed $background, mixed $current) : mixed
Parameters
- $html : mixed
- $userobj : mixed
- $i : mixed
- $background : mixed
- $current : mixed
Return values
mixed —adminNotice()
public
static adminNotice(mixed $tab, mixed $subtab) : mixed
Parameters
- $tab : mixed
- $subtab : mixed
Return values
mixed —adminSave()
public
static adminSave(mixed $updated, mixed $userobj, mixed $i, mixed $alter) : mixed
Parameters
- $updated : mixed
- $userobj : mixed
- $i : mixed
- $alter : mixed
Return values
mixed —constructor()
This method establishes the current set of database fields. It will add the fields to the database if they are not already present. Fields from previous constructor calls that are no longer in the list will be removed from the database (along with any data associated with them.)
public
constructor(mixed $me, array<string|int, mixed> $newfields) : mixed
Parameters
- $me : mixed
- $newfields : array<string|int, mixed>
Return values
mixed —fields()
public
static fields() : mixed
Return values
mixed —getCustomData()
public
static getCustomData(mixed $obj) : mixed
Parameters
- $obj : mixed
Return values
mixed —mediaItemEdit()
public
static mediaItemEdit(mixed $html, mixed $object, mixed $i) : mixed
Parameters
- $html : mixed
- $object : mixed
- $i : mixed
Return values
mixed —mediaItemSave()
public
static mediaItemSave(mixed $object, mixed $i) : mixed
Parameters
- $object : mixed
- $i : mixed
Return values
mixed —register()
public
static register() : mixed
Return values
mixed —setCustomData()
public
static setCustomData(mixed $obj, mixed $values) : mixed
Parameters
- $obj : mixed
- $values : mixed
Return values
mixed —zenpageItemEdit()
public
static zenpageItemEdit(mixed $html, mixed $object) : mixed
Parameters
- $html : mixed
- $object : mixed
Return values
mixed —zenpageItemSave()
public
static zenpageItemSave(mixed $custom, mixed $object) : mixed
Parameters
- $custom : mixed
- $object : mixed