Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added DocBlocks to DataExtension methods #9544

Merged
merged 3 commits into from
Jun 16, 2020
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
77 changes: 77 additions & 0 deletions src/ORM/DataExtension.php
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,9 @@
abstract class DataExtension extends Extension
{

/**
* @deprecated 4.7.0 No longer used by internal code
*/
public static function unload_extra_statics($class, $extension)
{
throw new Exception('unload_extra_statics gone');
Expand Down Expand Up @@ -60,42 +63,116 @@ public function augmentWrite(&$manipulation)
{
}

/**
* Extend the owner's onBeforeWrite() logic
*
* See {@link DataObject::onBeforeWrite()} for context.
*/
public function onBeforeWrite()
{
}

/**
* Extend the owner's onAfterWrite() logic
*
* See {@link DataObject::onAfterWrite()} for context.
*/
public function onAfterWrite()
{
}

/**
* Extend the owner's onBeforeDelete() logic
*
* See {@link DataObject::onBeforeDelete()} for context.
*/
public function onBeforeDelete()
{
}

/**
* Extend the owner's onAfterDelete() logic
*
* See {@link DataObject::onAfterDelete()} for context.
*/
public function onAfterDelete()
{
}

/**
* Extend the owner's requireDefaultRecords() logic
*
* See {@link DataObject::requireDefaultRecords()} for context.
*/
public function requireDefaultRecords()
{
}

/**
* Extend the owner's populateDefaults() logic
*
* See {@link DataObject::populateDefaults()} for context.
*/
public function populateDefaults()
{
}

/**
* Influence the owner's can() permission check value to be disallowed (false),
* allowed (true) if no other processed results are to disallow, or open (null) to not
* affect the outcome.
*
* See {@link DataObject::can()} and {@link DataObject::extendedCan()} for context.
jakxnz marked this conversation as resolved.
Show resolved Hide resolved
*
* @param Member $member
* @param array $context
* @return bool|null
*/
public function can($member)
{
}

/**
* Influence the owner's canEdit() permission check value to be disallowed (false),
* allowed (true) if no other processed results are to disallow, or open (null) to not
* affect the outcome.
*
* See {@link DataObject::canEdit()} and {@link DataObject::extendedCan()} for context.
*
* @param Member $member
* @param array $context
* @return bool|null
*/
public function canEdit($member)
{
}

/**
* Influence the owner's canDelete() permission check value to be disallowed (false),
* allowed (true) if no other processed results are to disallow, or open (null) to not
* affect the outcome.
*
* See {@link DataObject::canDelete()} and {@link DataObject::extendedCan()} for context.
*
* @param Member $member
* @param array $context
* @return bool|null
*/
public function canDelete($member)
{
}

/**
* Influence the owner's canCreate() permission check value to be disallowed (false),
* allowed (true) if no other processed results are to disallow, or open (null) to not
* affect the outcome.
*
* See {@link DataObject::canCreate()} and {@link DataObject::extendedCan()} for context.
*
* @param Member $member
* @param array $context
* @return bool|null
*/
public function canCreate($member)
{
}
Expand Down