| [ Index ] |
PHP Cross Reference of Unnamed Project |
[Source view] [Print] [Project Stats]
Class core_tag_area for managing tag areas
| Copyright: | 2015 Marina Glancy |
| License: | http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later |
| File Size: | 481 lines (20 kb) |
| Included or required: | 0 times |
| Referenced: | 0 times |
| Includes or requires: | 0 files |
core_tag_area:: (13 methods):
get_areas()
get_by_id()
display_name()
is_enabled()
get_collection()
get_showstandard()
get_definitions_for_component()
delete()
create()
update()
reset_definitions_for_component()
uninstall()
move_tags()
Class: core_tag_area - X-Ref
Class to manage tag areas| get_areas($tagcollid = null, $enabledonly = false) X-Ref |
| Returns the list of areas indexed by itemtype and component param: int $tagcollid return only areas in this tag collection param: bool $enabledonly return only enabled tag areas return: array itemtype=>component=>tagarea object |
| get_by_id($tagareaid) X-Ref |
| Retrieves info about one tag area param: int $tagareaid return: stdClass |
| display_name($component, $itemtype) X-Ref |
| Returns the display name for this area param: string $component param: string $itemtype return: lang_string |
| is_enabled($component, $itemtype) X-Ref |
| Returns whether the tag area is enabled param: string $component component responsible for tagging param: string $itemtype what is being tagged, for example, 'post', 'course', 'user', etc. return: bool|null |
| get_collection($component, $itemtype) X-Ref |
| Returns the id of the tag collection that should be used for storing tags of this itemtype param: string $component component responsible for tagging param: string $itemtype what is being tagged, for example, 'post', 'course', 'user', etc. return: int |
| get_showstandard($component, $itemtype) X-Ref |
| Returns wether this tag area should display or not standard tags when user edits it. param: string $component component responsible for tagging param: string $itemtype what is being tagged, for example, 'post', 'course', 'user', etc. return: int |
| get_definitions_for_component($componentname) X-Ref |
| Returns all tag areas and collections that are currently cached in DB for this component param: string $componentname return: array first element is the list of areas and the second list of collections |
| delete($record) X-Ref |
| Completely delete a tag area and all instances inside it param: stdClass $record |
| create($record) X-Ref |
| Create a new tag area param: stdClass $record |
| update($existing, $data) X-Ref |
| Update the tag area param: stdClass $existing current record from DB table tag_area param: array|stdClass $data fields that need updating |
| reset_definitions_for_component($componentname) X-Ref |
| Update the database to contain a list of tagged areas for a component. The list of tagged areas is read from [plugindir]/db/tag.php param: string $componentname - The frankenstyle component name. |
| uninstall($pluginname) X-Ref |
| Deletes all tag areas, collections and instances associated with the plugin. param: string $pluginname |
| move_tags($component, $itemtype, $tagcollid) X-Ref |
| Moves existing tags associated with an item type to another tag collection param: string $component param: string $itemtype param: int $tagcollid |
| Generated: Thu Aug 11 10:00:09 2016 | Cross-referenced by PHPXref 0.7.1 |