AmetysFrontEditionHelper (Ametys 4.1.x

java.lang.Object
- org.ametys.plugins.frontedition.AmetysFrontEditionHelper

All Implemented Interfaces:: Serviceable

public class AmetysFrontEditionHelper
extends Object
implements Serviceable

Helper for preparing the Ametys Edition

Field Summary

Fields
Modifier and Type	Field and Description
`private static AmetysObjectResolver`	`_ametysObjectResolver`
`private static ContentWorkflowHelper`	`_contentWorkflowHelper`
`private static HashCache`	`_hashCache`
`private static JSONUtils`	`_jsonUtils`
`private static PageHelper`	`_pageHelper`
`private static RichTextConfigurationExtensionPoint`	`_richTextConfigurationExtensionPoint`
`private static RightManager`	`_rightManager`
`private static SiteManager`	`_siteManager`
`private static WorkflowHelper`	`_workflowHelper`
`static String`	`FRONT_EDITION_RIGHT_ID` The right's id from front-edition access

Constructor Summary

Constructors
Constructor and Description

AmetysFrontEditionHelper()

Constructors
Constructor and Description
`AmetysFrontEditionHelper()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`private static void`	`_addRichTextConfigurationFiles(Map<String,Map<String,String>> files, Map<String,String> filesInfos, String locale, boolean rtlMode, boolean scripts)`
`private static List<ClientSideElement.ScriptFile>`	`_getRichTextConfigurationFiles(boolean scripts, Map<String,Object> contextParameters)`
`static String`	`getContentModifiables(int actionId, String inputPageId, boolean checkEditionMode)` Get a string representing a json map of the contentIds with true/false if they can/can't be modified
`String`	`getContentStatus(Content content)` check if a content is published ot not
`String`	`getContentStatus(String contentId)` check if a content is published ot not
`long`	`getContentWorkflowId(Content content)` Get the workflow step id of a content
`long`	`getContentWorkflowId(String contentId)` Get the workflow step id of a content
`String`	`getPageStatus(String pageId)` Get the status (validated/draft) of all contents in a page
`static String`	`getWorkflowName(String workflowName, int actionId)` Get the name of a workflow action
`long`	`getZoneItemPosition(String zoneItemId, String pageId)` Get the position of this zoneItem in the zone, or -1 if not found
`long`	`getZoneSize(String zoneName, String pageId)` Return the size of a zone
`static boolean`	`hasFrontEditionRight()` Check if the current user has the Front_Edition_Access_Right right
`static boolean`	`hasFrontEditionRight(String rightId, String inputPageId)` Deprecated. Use the version with three arguments
`static boolean`	`hasFrontEditionRight(String rightId, String objectId, boolean editionModeOnly)` Check if we can display the front edition button for a specific right Checks : * Rendering context == front * Edition mode * Front_Edition_Access_Right * RightId available
`static boolean`	`hasWorkflowRight(int actionId, String contentId, boolean checkEditionMode)` Check if the current workflow action is available on this content
`static boolean`	`hasWorkflowRight(List<Integer> actionIds, Content content, boolean checkEditionMode)` Check if a list of workflow actions are available on this content
`static boolean`	`hasWorkflowRight(List<Integer> actionIds, String contentId, boolean checkEditionMode)` Check if a list of workflow actions are available on this content
`boolean`	`isContentLive(Content content)` check if a content is published ot not
`boolean`	`isContentLive(String contentId)` check if a content is published ot not
`static String`	`prepareCSSFiles(String locale, boolean rtlMode)` Prepare a hashcode for css files
`static String`	`prepareJSFiles(String locale, boolean rtlMode)` Prepare a hashcode for js files
`void`	`service(ServiceManager manager)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - FRONT_EDITION_RIGHT_ID
```
public static final String FRONT_EDITION_RIGHT_ID
```
    The right's id from front-edition access
    
    See Also:
    
    Constant Field Values
  - _ametysObjectResolver
```
private static AmetysObjectResolver _ametysObjectResolver
```
  - _hashCache
```
private static HashCache _hashCache
```
  - _richTextConfigurationExtensionPoint
```
private static RichTextConfigurationExtensionPoint _richTextConfigurationExtensionPoint
```
  - _rightManager
```
private static RightManager _rightManager
```
  - _contentWorkflowHelper
```
private static ContentWorkflowHelper _contentWorkflowHelper
```
  - _pageHelper
```
private static PageHelper _pageHelper
```
  - _workflowHelper
```
private static WorkflowHelper _workflowHelper
```
  - _jsonUtils
```
private static JSONUtils _jsonUtils
```
  - _siteManager
```
private static SiteManager _siteManager
```
- Constructor Detail
  - AmetysFrontEditionHelper
```
public AmetysFrontEditionHelper()
```
- Method Detail
  - service
```
public void service(ServiceManager manager)
             throws ServiceException
```
    Specified by:
    
    service in interface Serviceable
    
    Throws:
    
    ServiceException
  - prepareJSFiles
```
public static String prepareJSFiles(String locale,
                                    boolean rtlMode)
```
    Prepare a hashcode for js files
    
    Parameters:
    
    locale - The language code to use
    
    rtlMode - Is for right-to-left language?
    
    Returns:
    
    The new hashcode to read the minimified concatened file
  - prepareCSSFiles
```
public static String prepareCSSFiles(String locale,
                                     boolean rtlMode)
```
    Prepare a hashcode for css files
    
    Parameters:
    
    locale - The language code to use
    
    rtlMode - Is for right-to-left language?
    
    Returns:
    
    The new hashcode to read the minimified concatened file
  - _getRichTextConfigurationFiles
```
private static List<ClientSideElement.ScriptFile> _getRichTextConfigurationFiles(boolean scripts,
                                                                                 Map<String,Object> contextParameters)
```
  - _addRichTextConfigurationFiles
```
private static void _addRichTextConfigurationFiles(Map<String,Map<String,String>> files,
                                                   Map<String,String> filesInfos,
                                                   String locale,
                                                   boolean rtlMode,
                                                   boolean scripts)
```
  - hasFrontEditionRight
```
@Deprecated
public static boolean hasFrontEditionRight(String rightId,
                                                       String inputPageId)
```
    Deprecated. Use the version with three arguments
    
    Check if we can display the front edition button for a specific right Checks : * Rendering context == front * Edition mode * Front_Edition_Access_Right * RightId available
    
    Parameters:
    
    rightId - right to check (can be null)
    
    inputPageId - page to check
    
    Returns:
    
    true if all is OK, false if at least one is false
  - hasFrontEditionRight
```
public static boolean hasFrontEditionRight(String rightId,
                                           String objectId,
                                           boolean editionModeOnly)
```
    Check if we can display the front edition button for a specific right Checks : * Rendering context == front * Edition mode * Front_Edition_Access_Right * RightId available
    
    Parameters:
    
    rightId - right to check (can be null)
    
    objectId - page/content to check
    
    editionModeOnly - Check if the user is in edition mode
    
    Returns:
    
    true if all is OK, false if at least one is false
  - hasFrontEditionRight
```
public static boolean hasFrontEditionRight()
```
    Check if the current user has the Front_Edition_Access_Right right
    
    Returns:
    
    true if right granted
  - hasWorkflowRight
```
public static boolean hasWorkflowRight(int actionId,
                                       String contentId,
                                       boolean checkEditionMode)
```
    Check if the current workflow action is available on this content
    
    Parameters:
    
    actionId - action to check
    
    contentId - content to check
    
    checkEditionMode - check also if we are in edition mode
    
    Returns:
    
    true if right is granted
  - hasWorkflowRight
```
public static boolean hasWorkflowRight(List<Integer> actionIds,
                                       String contentId,
                                       boolean checkEditionMode)
```
    Check if a list of workflow actions are available on this content
    
    Parameters:
    
    actionIds - list of action ids
    
    contentId - id of the content to check
    
    checkEditionMode - check also if we are in edition mode
    
    Returns:
    
    true if all actions are available
  - hasWorkflowRight
```
public static boolean hasWorkflowRight(List<Integer> actionIds,
                                       Content content,
                                       boolean checkEditionMode)
```
    Check if a list of workflow actions are available on this content
    
    Parameters:
    
    actionIds - list of action ids
    
    content - content to check
    
    checkEditionMode - check also if we are in edition mode
    
    Returns:
    
    true if all actions are available
  - getContentModifiables
```
public static String getContentModifiables(int actionId,
                                           String inputPageId,
                                           boolean checkEditionMode)
```
    Get a string representing a json map of the contentIds with true/false if they can/can't be modified
    
    Parameters:
    
    actionId - action to check
    
    inputPageId - page (can be null)
    
    checkEditionMode - check also if we are in edition mode
    
    Returns:
    
    {contentId : true/false, ....}
  - getWorkflowName
```
public static String getWorkflowName(String workflowName,
                                     int actionId)
```
    Get the name of a workflow action
    
    Parameters:
    
    workflowName - workflow name
    
    actionId - action id in the workflow
    
    Returns:
    
    name of the workflow action
  - getPageStatus
```
public String getPageStatus(String pageId)
```
    Get the status (validated/draft) of all contents in a page
    
    Parameters:
    
    pageId - id of the page to check
    
    Returns:
    
    "" if not a page, "draft" if all contents are drafts, "validated" if all contents are validated, and "mixed" if there are both
  - getContentWorkflowId
```
public long getContentWorkflowId(String contentId)
```
    Get the workflow step id of a content
    
    Parameters:
    
    contentId - id of the content
    
    Returns:
    
    the step Id
  - getContentWorkflowId
```
public long getContentWorkflowId(Content content)
```
    Get the workflow step id of a content
    
    Parameters:
    
    content - content
    
    Returns:
    
    the step Id
  - getContentStatus
```
public String getContentStatus(String contentId)
```
    check if a content is published ot not
    
    Parameters:
    
    contentId - id of the content
    
    Returns:
    
    "validated" or "draft", "" if not found
  - getContentStatus
```
public String getContentStatus(Content content)
```
    check if a content is published ot not
    
    Parameters:
    
    content - content
    
    Returns:
    
    "validated" or "draft"
  - isContentLive
```
public boolean isContentLive(String contentId)
```
    check if a content is published ot not
    
    Parameters:
    
    contentId - id of the content
    
    Returns:
    
    true if validated
  - isContentLive
```
public boolean isContentLive(Content content)
```
    check if a content is published ot not
    
    Parameters:
    
    content - content
    
    Returns:
    
    true if validated
  - getZoneItemPosition
```
public long getZoneItemPosition(String zoneItemId,
                                String pageId)
                         throws UnknownAmetysObjectException,
                                AmetysRepositoryException,
                                RepositoryException
```
    Get the position of this zoneItem in the zone, or -1 if not found
    
    Parameters:
    
    zoneItemId - zoneitem to search
    
    pageId - page id
    
    Returns:
    
    zero based position, -1 if not found
    
    Throws:
    
    UnknownAmetysObjectException - If an error occurred
    
    AmetysRepositoryException - If an error occurred
    
    RepositoryException - If an error occurred
  - getZoneSize
```
public long getZoneSize(String zoneName,
                        String pageId)
```
    Return the size of a zone
    
    Parameters:
    
    zoneName - zone name
    
    pageId - page Id
    
    Returns:
    
    size of the zone (-1 if not found)

Class AmetysFrontEditionHelper

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

FRONT_EDITION_RIGHT_ID

_ametysObjectResolver

_hashCache

_richTextConfigurationExtensionPoint

_rightManager

_contentWorkflowHelper

_pageHelper

_workflowHelper

_jsonUtils

_siteManager

Constructor Detail

AmetysFrontEditionHelper

Method Detail

service

prepareJSFiles

prepareCSSFiles

_getRichTextConfigurationFiles

_addRichTextConfigurationFiles

hasFrontEditionRight

hasFrontEditionRight

hasFrontEditionRight

hasWorkflowRight

hasWorkflowRight

hasWorkflowRight

getContentModifiables

getWorkflowName

getPageStatus

getContentWorkflowId

getContentWorkflowId

getContentStatus

getContentStatus

isContentLive

isContentLive

getZoneItemPosition

getZoneSize