Squiz Matrix  4.12.2
 All Data Structures Namespaces Functions Variables Pages
Asset_Management Class Reference
Inheritance diagram for Asset_Management:
MySource_Object Authentication_Default_Management Authentication_Folder_Management Authentication_IPB_Management Authentication_LDAP_Management Authentication_Management Backend_User_Management Bodycopy_Container_Management Bodycopy_Div_Management Bodycopy_Management Bodycopy_Table_Management Bulkmail_Job_Management Bulkmail_Manager_Management Bulkmail_Post_Office_Management Bulkmail_Subscribe_Page_Management Bulkmail_User_Management Cache_Manager_Management Cache_Storage_Default_Management Cache_Storage_Management Cache_Storage_Memcache_Management Calendar_Event_Cancellation_Management Calendar_Event_Management Calendar_Event_Modification_Management Calendar_Event_Multi_Date_Management Calendar_Event_Recurring_Management Calendar_Event_Single_Management Checkout_Action_Call_Rest_Resource_Management Checkout_Action_Management CMIS_Bridge_Management Comment_Management Condition_Admin_Access_Management Condition_Asset_Status_Management Condition_Asset_Type_Management Condition_Form_Posted_Management Condition_In_User_Group_Management Condition_Keyword_Regexp_Management Condition_Logged_In_Management Condition_Logical_Management Condition_Management Condition_Server_Variable_Management Condition_Simple_Edit_Mode_Management Condition_User_Agent_Management Condition_User_Frequency_Management Condition_User_IP_Management Condition_User_Type_Management Condition_Write_Access_Management Content_Type_Code_Management Content_Type_Image_Management Content_Type_Management Content_Type_Markdown_Management Content_Type_Nest_Content_Management Content_Type_Raw_HTML_Management Content_Type_Snippet_Management Content_Type_Structure_Tree_Management Content_Type_WYSIWYG_Management Cron_Job_Attempt_Safe_Trash_Management Cron_Job_Clear_Matrix_Cache_Management Cron_Job_Escalate_Safe_Trash_Management Cron_Job_Expired_Matrix_Cache_Management Cron_Job_Expired_Matrix_Locks_Management Cron_Job_Expired_WorkFlow_Management Cron_Job_Funnelback_Log_Rotation_Management Cron_Job_Future_Lineage_Management Cron_Job_Future_Permission_Management Cron_Job_Future_Status_Management Cron_Job_Generate_Log_Reports_Management Cron_Job_Manage_Incomplete_Submissions_Management Cron_Job_Manage_Pending_Accounts_Management Cron_Job_Management Cron_Job_Metadata_Triggers_Management Cron_Job_Queue_Scheduled_Job_Management Cron_Job_Refresh_Cache_Management Cron_Job_Regenerate_Report_Management Cron_Job_Remove_SOAP_Response_Files_Management Cron_Job_Send_Submission_Log_Management Cron_Job_Squid_Cache_Purge_Management Cron_Job_Sync_CMIS_Bridges_Management Cron_Job_Sync_Suite_Products_Management Cron_Job_Update_Sharepoint_Record_Management Cron_Job_Update_Trim_Record_Management Cron_Manager_Management CSS_File_Management Data_Record_Management Data_Source_Csv_Management Data_Source_DB_Management Data_Source_Graph_Management Data_Source_iCal_Management Data_Source_Json_Management Data_Source_Ldap_Management Data_Source_Management Data_Source_Record_Set_Management Data_Source_RSS_Management Data_Source_Xml_Management Db_Connector_Management Decision_Tree_Question_Management Decision_Tree_Question_Type_Numeric_Management Decision_Tree_Question_Type_Select_Management Default_Delivery_Method_Management Design_Area_Access_History_Management Design_Area_Asset_Lineage_Management Design_Area_Body_Management Design_Area_Colourise_Image_Management Design_Area_Constant_Button_Management Design_Area_Custom_Image_Management Design_Area_DateTime_Management Design_Area_Declared_Vars_Management Design_Area_Ecommerce_Cart_Management Design_Area_Exit_Management Design_Area_Head_Management Design_Area_JS_Calendar_Navigator_Management Design_Area_Linked_Css_Management Design_Area_Login_Form_Management Design_Area_Management Design_Area_Menu_Normal_Management Design_Area_Menu_Recursive_Management Design_Area_Menu_Stalks_Management Design_Area_Menu_Type_Management Design_Area_Metadata_Management Design_Area_Nest_Content_Management Design_Area_Password_Change_Form_Management Design_Area_Request_Vars_Management Design_Area_SearchBox_Management Design_Area_Show_If_Management Design_Css_Customisation_Management Design_Css_Management Design_Customisation_Management Design_Management Designs_Folder_Management Donation_Management Ecommerce_Cart_Management Ecommerce_Checkout_Management Ecommerce_Delivery_Method_Management Ecommerce_Order_Management EES_Login_Design_Management Excel_Doc_Management File_Bridge_Management File_Management FLV_File_Management Folder_Management Form_Action_Call_Rest_Resource_Management Form_Action_Create_Sharepoint_List_Item_Management Form_Action_DB_Query_Management Form_Action_Management Form_Action_Save_Xml_Management Form_Action_Send_Email_Management Form_Action_Set_Session_Var_Management Form_Action_SOAP_Call_Management Form_Action_TRIM_Submit_Management Form_Action_Upload_Youtube_Video_Management Form_Ecommerce_Management Form_Email_Management Form_Management Form_Question_Management Form_Question_Rule_Management Form_Question_Rule_Type_Begins_With_Management Form_Question_Rule_Type_Comparison_Management Form_Question_Rule_Type_Contain_Management Form_Question_Rule_Type_Email_Management Form_Question_Rule_Type_Ends_With_Management Form_Question_Rule_Type_File_Size_Management Form_Question_Rule_Type_File_Type_Management Form_Question_Rule_Type_File_Virus_Check_Management Form_Question_Rule_Type_Found_In_Management Form_Question_Rule_Type_Integer_Management Form_Question_Rule_Type_Length_Management Form_Question_Rule_Type_Numeric_Management Form_Question_Rule_Type_Regexp_Management Form_Question_Rule_Type_Select_Limit_Management Form_Question_Rule_Type_Selection_Management Form_Question_Type_Country_Management Form_Question_Type_Datetime_Management Form_Question_Type_Email_Address_Management Form_Question_Type_File_Upload_Management Form_Question_Type_Numeric_Management Form_Question_Type_Option_List_Management Form_Question_Type_Password_Management Form_Question_Type_Select_Management Form_Question_Type_Text_Management Form_Question_Type_Tickbox_List_Management Form_Question_Type_Tickbox_Table_Management Form_Section_Action_Management Form_Section_Action_SOAP_Call_Management Form_Section_Management Form_Submission_Management Funnelback_Manager_Management Funnelback_REST_Search_Page_Management Funnelback_Search_Log_Report_Management Funnelback_Search_Page_Management Google_Map_Location_Management Google_Map_Management Image_Management Image_Variety_Management Import_Tool_Converter_Management Import_Tool_Converter_Word_Management Import_Tools_Manager_Management Inbox_Management IPB_Bridge_Management Ipb_Forum_Management Ipb_Poll_Management Ipb_Post_Management Ipb_Root_Forum_Management Ipb_Topic_Management Ipb_User_Group_Management Ipb_User_Management JS_Api_Management JS_File_Management Layout_Management Layout_Manager_Management Ldap_Backend_User_Management LDAP_Bridge_Management Ldap_Simple_Edit_User_Management Ldap_User_Group_Management Ldap_User_Management Link_Management Listing_Engine_Management Locking_Method_Default_Management Locking_Method_Management Locking_Method_Memcache_Management Log_Manager_Management Log_Report_Management Login_Design_Management Lookup_Value_Management Metadata_Field_Date_Management Metadata_Field_Hierarchy_Management Metadata_Field_Management Metadata_Field_Multiple_Text_Management Metadata_Field_Related_Asset_Management Metadata_Field_Select_Management Metadata_Field_Text_Management Metadata_Field_Thesaurus_Management Metadata_Field_WYSIWYG_Management Metadata_Schema_Management Metadata_Section_Management MP3_File_Management News_Item_Management Online_Quiz_Question_Group_Management Online_Quiz_Question_Management Online_Quiz_Question_Multichoice_Management Online_Quiz_Submission_Management Order_Line_Management Order_Management Page_Account_Manager_Management Page_Asset_Builder_Management Page_Asset_Listing_Management Page_Calendar_Events_Search_Management Page_Calendar_Management Page_Calendar_Restricted_Management Page_Calendar_Rolling_Management Page_Custom_Form_Ecommerce_Management Page_Custom_Form_Management Page_Decision_Tree_Management Page_Hit_Count_Listing_Management Page_Link_Manager_Management Page_Management Page_Multiple_Page_Management Page_Multiple_Page_Page_Management Page_Online_Quiz_Management Page_Password_Reset_Management Page_Poll_Management Page_Redirect_Management Page_Related_Asset_Listing_Management Page_Remote_Content_Management Page_REST_Resource_JS_Management Page_REST_Resource_Management Page_REST_Resource_OAuth_Session_Management Page_REST_Resource_OAuth_Two_Legged_Management Page_RSS_Feed_Management Page_Site_Map_Management Page_Standard_Management Page_Tag_Listing_Management Page_Upcoming_Events_List_Management Page_User_Group_Manager_Management Page_Whats_New_Management Paint_Layout_Bodycopy_Management Paint_Layout_Lookup_Value_Management Paint_Layout_Page_Management Password_Change_Design_Management Payment_Gateway_Datacash_Management Payment_Gateway_Dps_Management Payment_Gateway_Esec_Management Payment_Gateway_Management Payment_Gateway_SagePay_Management Payment_Gateway_UTransact_Management Paypal_Business_Account_Management Paypal_Configuration_Management Paypal_IPN_Receiver_Management Paypal_Order_Management Paypal_Payment_Button_Management PDF_File_Management Physical_File_Management Physical_Folder_Management Poll_Question_Management Powerpoint_Doc_Management Product_Management Promotional_Code_Management Promotional_Rule_Management Promotional_Rule_Type_Quantity_Management Public_User_Management Remap_Manager_Management Report_Asset_Counter_Management Report_Asset_Statuses_Management Report_Incomplete_Metadata_Management Report_Links_Management Report_Management Report_Most_Used_Asset_Types_Management Report_Rollback_Management Report_Safe_Trash_Management Report_Total_Assets_Management Report_Total_Internal_Messages_Management Report_Trash_Age_Management Report_Triggers_Management REST_Manager_Management Role_Management Root_Folder_Management Root_User_Management Rtf_File_Management Saml2_ACS_Management Saml2_SLS_Management SAML_Account_Manager_Management Search_Folder_Management Search_List_Management Search_Log_Report_Management Search_Manager_Management Search_Page_Management Session_Handler_Default_Management Session_Handler_Management Session_Handler_Memcache_Management Sharepoint_Connector_Management Sharepoint_Saved_Search_Management Simple_Edit_User_Management Simple_Form_Management Simple_Report_Management Site_Management Site_Network_Management Soap_Api_Asset_Service_Management Soap_Api_Design_Lookup_Service_Management Soap_Api_File_Retrieval_Service_Management Soap_Api_Link_Service_Management SOAP_Api_Management Soap_Api_Metadata_Service_Management Soap_Api_Permission_Role_Service_Management Soap_Api_Search_Service_Management Soap_Api_Workflow_Service_Management Soap_Server_Management Squiz_Suite_System_Management Squiz_Suite_System_Search_Management Squiz_Suite_System_Suite_Management Structured_Asset_Info_Management Suite_Manager_Management System_Management_Folder_Management System_User_Group_Management System_User_Management Tag_Manager_Management Text_File_Management Thesaurus_Management Thesaurus_Term_Management Thumbnail_Management Tool_Asset_Sorter_Management Tool_Bulk_File_Import_Management Tool_Change_Thesaurus_Term_Management Tool_Clear_Matrix_Cache_Management Tool_Clear_Squid_Cache_Management Tool_Delete_Bmail_Users_Management Tool_Export_Assets_To_Xml_Management Tool_Export_Files_Management Tool_Export_Online_Quiz_To_XML_Management Tool_Import_Assets_From_Xml_Management Tool_Import_Bmail_User_Management Tool_Import_File_Management Tool_Management Tool_Mass_Clone_Management Tool_Reindex_Management Tool_Rollback_Management_Management Tool_Search_Replace_Management Tool_Structured_File_Import_Management Trash_Folder_Management Trigger_Action_Add_Assetid_Remap_Management Trigger_Action_Add_Url_Management Trigger_Action_Add_Web_Path_Management Trigger_Action_Calculate_Average_Comment_Rating_Management Trigger_Action_Call_Rest_Resource_Management Trigger_Action_Clear_Cache_Management Trigger_Action_Create_Asset_Management Trigger_Action_Create_Clone_Management Trigger_Action_Create_Design_Customisation_Management Trigger_Action_Create_File_Asset_Management Trigger_Action_Create_Image_Variety_Management Trigger_Action_Create_Link_Management Trigger_Action_Decrement_Hit_Count_Management Trigger_Action_Delete_Bmail_User_Management Trigger_Action_Delete_Future_Lineage_Management Trigger_Action_Delete_Future_Permission_Management Trigger_Action_Delete_Future_Status_Management Trigger_Action_Delete_Image_Variety_Management Trigger_Action_Execute_Database_Query_Management Trigger_Action_Fail_Management Trigger_Action_Increment_Hit_Count_Management Trigger_Action_Increment_Version_Management Trigger_Action_Join_User_Group_For_Session_Management Trigger_Action_Login_Ipb_Management Trigger_Action_Logout_Ipb_Management Trigger_Action_Make_SOAP_Call_Management Trigger_Action_Management Trigger_Action_Purge_Squid_Cache_Management Trigger_Action_Redirect_Management Trigger_Action_Release_Lock_Management Trigger_Action_Reload_User_Management Trigger_Action_Remove_Future_Lineage_Cron_Management Trigger_Action_Remove_Links_Management Trigger_Action_Remove_Metadata_Schema_Management Trigger_Action_Remove_Remaps_Management Trigger_Action_Remove_Web_Path_Management Trigger_Action_Remove_Workflow_Schema_Management Trigger_Action_Replace_File_Asset_Management Trigger_Action_Reset_Hit_Count_Management Trigger_Action_Schedule_Bulkmail_Job_Management Trigger_Action_Send_Email_Management Trigger_Action_Set_Attribute_Value_Management Trigger_Action_Set_Cache_Expiry_Management Trigger_Action_Set_Cookie_Management Trigger_Action_Set_Design_Associated_Files_Management Trigger_Action_Set_Design_Management Trigger_Action_Set_Design_Parse_File_Management Trigger_Action_Set_Force_Secure_Management Trigger_Action_Set_Future_Lineage_Management Trigger_Action_Set_Future_Permission_Management Trigger_Action_Set_Future_Status_Management Trigger_Action_Set_Index_Page_Management Trigger_Action_Set_Metadata_Field_Date_Management Trigger_Action_Set_Metadata_Schema_Management Trigger_Action_Set_Metadata_Value_Management Trigger_Action_Set_Paint_Layout_Management Trigger_Action_Set_Permission_Management Trigger_Action_Set_Role_Management Trigger_Action_Set_Session_Var_Management Trigger_Action_Set_Site_Special_Page_Management Trigger_Action_Set_Standard_Asset_Date_Management Trigger_Action_Set_Status_Management Trigger_Action_Set_Tag_Management Trigger_Action_Set_Thesaurus_Terms_Management Trigger_Action_Set_Thumbnail_Management Trigger_Action_Set_Workflow_Schema_Management Trigger_Action_Update_Link_Management Trigger_Action_Update_Twitter_Status_Management Trigger_Condition_Access_Permission_Management Trigger_Condition_Asset_ID_Management Trigger_Condition_Asset_Tagged_Management Trigger_Condition_Asset_Type_Management Trigger_Condition_Attribute_Changed_Management Trigger_Condition_Attribute_Value_Management Trigger_Condition_Interface_Mode_Management Trigger_Condition_Keyword_Management Trigger_Condition_Link_Exists_Management Trigger_Condition_Management Trigger_Condition_Metadata_Field_Updated_Management Trigger_Condition_Metadata_Set_Management Trigger_Condition_Metadata_Time_Management Trigger_Condition_Metadata_Value_Management Trigger_Condition_Request_Method_Management Trigger_Condition_Rest_Response_Management Trigger_Condition_Status_Change_To_Management Trigger_Condition_Status_Management Trigger_Condition_Tree_Location_Management Trigger_Condition_URL_Matches_Management Trigger_Condition_User_Public_Management Trigger_Condition_User_Sysadmin_Management Trigger_Event_After_Asset_Built_Management Trigger_Event_After_Metadata_Updated_Management Trigger_Event_Asset_Accessed_Management Trigger_Event_Asset_Cloned_Management Trigger_Event_Asset_Content_Changed_Management Trigger_Event_Asset_Created_Management Trigger_Event_Asset_Recached_Management Trigger_Event_Asset_Updated_Management Trigger_Event_Attributes_Changed_Management Trigger_Event_Attributes_Saved_Management Trigger_Event_Before_Asset_Created_Management Trigger_Event_Before_Asset_Deleted_Management Trigger_Event_Before_Status_Change_Management Trigger_Event_Before_User_Logout_Management Trigger_Event_Ecommerce_Order_Submitted_Management Trigger_Event_Ecommerce_Payment_Completed_Management Trigger_Event_Enter_Simple_Edit_Management Trigger_Event_Link_Created_Management Trigger_Event_Link_Deleted_Management Trigger_Event_Lookups_Updated_Management Trigger_Event_Management Trigger_Event_Matrix_Cache_Cleared_Management Trigger_Event_Metadata_Time_Management Trigger_Event_Metadata_Updated_Management Trigger_Event_Paypal_IPN_Completed_Management Trigger_Event_Public_User_Session_Created_Management Trigger_Event_Rest_Response_Received_Management Trigger_Event_Status_Changed_Management Trigger_Event_User_Login_Management Trigger_Event_User_Logout_Management Trigger_Event_Workflow_Approval_Management Trigger_Event_Workflow_Rejection_Management Trigger_Folder_Management Trigger_Management Trigger_Manager_Management Trim_Connector_Management TRIM_Saved_Search_Management User_Group_Management User_Management Video_File_Management Weatherco_Feed_Management Web_Folder_Designs_Management Web_Folder_Management Web_Folder_Media_Management Web_Folder_Users_Management Web_Folder_Web_Services_Management Word_Doc_Management Workflow_Bundle_Management Workflow_Schema_Management Workflow_Step_Condition_Management Workflow_Step_Management Workflow_Stream_Management Workspace_Management Xml_File_Management XML_User_Bridge_Management Xsl_File_Management

Public Member Functions

 Asset_Management (&$pm)
 
 getAssetType ()
 
 update ()
 
 _updateFiles ()
 
 _install ()
 
 _upgrade ($current_version)
 
 _getAllVars ()
 
 _getFileList ()
 
 getEventList ()
 
 _addAttribute ($name)
 
 _deleteAttribute ($name)
 
 _updateAttribute ($name, $current_version)
 
 _updateOwnedAttribute ($name, $curr_attr)
 
 _updateCustomAttribute ($attributeid, $name, $field, $old_type_code, $new_type_code, $new_value)
 
 _validateAttributeDefault (&$default, $attr_type, $parameters)
 
 getAssetInfo ($file)
 
 _installDALQueries ()
 
- Public Member Functions inherited from MySource_Object
 MySource_Object ()
 
 __sleep ()
 
 __wakeup ()
 

Data Fields

 $_pm
 
 $_am
 
 $_db
 
 $vars = Array()
 
 $components = Array()
 
- Data Fields inherited from MySource_Object
 $_tmp
 

Detailed Description

Definition at line 32 of file asset_management.inc.

Member Function Documentation

_addAttribute (   $name)

Adds an attribute to this asset's collection

Parameters
string$namethe name of the attribute to add
Returns
boolean private

Definition at line 446 of file asset_management.inc.

_deleteAttribute (   $name)

Removes an attribute from the set of attributes owned by this asset

This asset type must be the attribute's owning type. If we have the attribute via inheritance or whatever, deletion is not allowed.

Parameters
string$namethe attribute to delete
Returns
boolean whether the delete was successful private

Definition at line 692 of file asset_management.inc.

_getAllVars ( )

Returns all the variable names that are available for this asset type

  • any inherited vars and those defined in this management class
Returns
array(string) public

Definition at line 385 of file asset_management.inc.

_getFileList ( )

Returns all files this asset wants installed/updated into the data directory

Returns
array(string) private

Definition at line 418 of file asset_management.inc.

_install ( )

Installs this asset

Returns
boolean public

Definition at line 239 of file asset_management.inc.

_installDALQueries ( )

Generates the baked Database Abstraction Layer (DAL) queries for the asset

Returns
boolean public

Definition at line 1159 of file asset_management.inc.

_updateAttribute (   $name,
  $current_version 
)

Updates an attribute in this asset's set

Parameters
string$namethe name of the attribute to update
string$current_versionthe version of the asset that is currenly installed
Returns
boolean protected

Definition at line 745 of file asset_management.inc.

_updateCustomAttribute (   $attributeid,
  $name,
  $field,
  $old_type_code,
  $new_type_code,
  $new_value 
)

Updates an attribute that this asset doesn't own but has set the default value on

Parameters
string$namethe name of the attribute to update
string$curr_attrthe info for the attribute as it stands at the moment
string$fieldthe part of the attribute we are updating (ie default | param)
Returns
boolean private

Definition at line 1036 of file asset_management.inc.

_updateFiles ( )

Copy files used by the asset to the data directory

Returns
boolean private

Definition at line 202 of file asset_management.inc.

_updateOwnedAttribute (   $name,
  $curr_attr 
)

Updates an attribute that this asset owns (ie the first time it is defined is by this asset)

Parameters
string$namethe name of the attribute to update
string$curr_attrthe info for the attribute as it stands at the moment
Returns
boolean private

Definition at line 937 of file asset_management.inc.

_upgrade (   $current_version)

Upgrade

Parameters
string$current_versionthe version of the asset that is currenly installed
Returns
boolean public

Definition at line 300 of file asset_management.inc.

_validateAttributeDefault ( $default,
  $attr_type,
  $parameters 
)

Checks an attributes default value to make sure that it is valid Accepts the $default by reference so that it can be changed if need be

Parameters
mixed$defaultthe proposed default value
string$attr_typethe type of asset represented by the id
array$parametersthe params for this attribute
Returns
boolean private

Definition at line 1094 of file asset_management.inc.

Asset_Management ( $pm)

Constructor

Definition at line 88 of file asset_management.inc.

getAssetInfo (   $file)

Returns the information from the passed asset.xml This function can be called without creating an instance of the class ie $info = Asset_Management::getAssetInfo($file);

Parameters
string$filethe asset.xml file path
Returns
Array public

Definition at line 1118 of file asset_management.inc.

getAssetType ( )

Returns the asset type that this management class is working for

Note that as of PHP 5.x, return values from get_class() are in mixed case. This makes sure asset types are returned lower case, as in other parts of Matrix.

Returns
string public

Definition at line 113 of file asset_management.inc.

getEventList ( )

returns a list of events that this asset is listening for

public

Returns
array

Definition at line 431 of file asset_management.inc.

update ( )

This gets run to intall/upgrade the asset that this management class represents

Returns
boolean public

Definition at line 127 of file asset_management.inc.


The documentation for this class was generated from the following file: