Mk Labs

EEasy Like 1.0

EeasyLike v1.0 for EE3

Documentation

Summary

  1. System requirements
  2. Instalation
  3. Activation
  4. Tags
      1. Approve
      2. Approves
      3. Comments
      4. Approvers

Contents

  • System requirements

    - top

  • Instalation

    - top
    • Download EEasy Like
    • Extract the .zip file on your computer.
    • Copy the extracted content in to the /system/user/addons/ directory.

  • Activation

    - top
    • Log into your ExpressionEngine control panel.
    • Navigate to Develper / Addons.
    • Scroll down to the Third Party Add-Ons section.
    • Select Install button in the row for EEasy Like.

  • Tags

    - top
      • Approve

        - top
          • Description - top
            The tag enables the user to approve (like) or reject (unlike) given content.
            * Please note that this tag requires the jQuery javascript plug-in. It you do not use it in your page than the tag will automatically include the plug-in.

          • Required parameters - top
              • * This tag can use only one parameter at a time. Please use on of the following:
                entry_id="1337"
                or
                url_title="url-title-goes-here"
                or
                comment_id="31337"

              • Optional Parameters - top
                  • approved_text
                    Normally, EEasy Like replaces the {approve} variable with the word approve.
                    The parameter changes the approve word in to the one passed to the parameter.

                    approved_text="love"

                  • rejected_text
                    The same behavior as the approved_text parameter, only for it applies for the {reject} variable.

                    rejected_text="hate"

                  • approved_class
                    Normally, EEasy Like adds a default class to the anchor generated by the {approve} variable .
                    The parameter changes the anchor class for the {approve} variable.

                    approved_class="i-love-it-class"

                  • rejected_class
                    The same behavior as the approved_class parameter, only for it applies for the {reject} variable.

                    rejected_class="i-hate-it-class"

          • Variables - top
                  • approve
                    The {approve} variable creates the button that users will use to approve a given content.

                  • reject
                    The {reject} variable creates the button that users will use to reject a given content.

                  • approve_count
                    The {approve_count} variable shows the number of user that have approved the given content.

                  • reject_count
                    The {reject_count} variable shows the number of user that have rejected the given content.

                  • remove_after_event_triggered
                    The {remove_after_event_triggered} variable pair can be used to remove from DOM that data it wrappes after a user has approved or rejected a given content.

                  • show_after_event_triggered
                    The {show_after_event_triggered} variable pair can be used to show in DOM that data it wrappes after a user has approved or rejected a given content.

          • Example - top
            {exp:eeasylike:approve
              entry_id="1337"
            
              approved_text="love"
              rejected_text="hate"
            
              approved_class="i-love-it-class"
            
              rejected_class="i-hate-it-class"
            }
              {remove_after_event_triggered}
                I {approve} this content.
                I {reject} this content.
              {/remove_after_event_triggered}
            
              {show_after_event_triggered}
                {approve_count} people approved this content.
                {reject_count} people rejected this content.
              {/show_after_event_triggered}
            {/exp:eeasylike:approve}


      • Approves

        - top
          • Description- top
            The tag enables you to see the list of most approved / rejected entries from your channels.

              • Required parameters - top
                * This tag can use only one parameter at a time. Please use on of the following:
                channel="channel-goes-here"
                or
                weblog="weblog-goes-here"

              • Optional parameters - top
                  • order_by
                    Sets the listing order for the approved / rejected entries that are stored in your channel.
                    order_by="date"

                  • sort
                    Sets the listing sorting order for the approved / rejected entries that are stored in your channel.
                    sort="asc"

                  • limit
                    Limits the number of approved / rejected returned results from your channel.
                    limit="7"

                  • type
                    Set the type of entries the tag will return. Use approved or rejected.
                    type="rejected"

                  • only_current_user
                    Used for returning approved / rejected entries that are set by the current user.
                    If the current user is logged in than the results will be relative to his login information, otherwise to his cookie information.
                    only_current_user="true"

          • Variables - top
                  • count
                    The {count} variable returns the number of returned approved and rejected entries for a given content set in to type parameter.
                    If the parameter is not set than the result will be relative to the approved entries.

                  • opposite_count
                    The opposite_count variable returns the count of the opposite type from the count variable.

                  • entry_id
                    The entry_id variable outputs the entry_id of the approved / rejected entry.

                  • title
                    The title variable returns the title of approved / disliked entry.

                  • url_title
                    The url_title variable returns the url_title of approved / disliked entry.

                  • channel_id   or weblog_id
                    The channel_id or weblog_id variables returns the channel_id or weblog_id of approved / rejected entry.

          • Example - top
            {exp:eeasylike:approves channel="channe-goes-here"}
              {entry_id} entry id, {url_title} url title, {title} - {count} approves, {opposite_count} rejected
              <br />
            {/exp:eeasylike:approves}


      • Comments

        - top
          • Description- top
            The tag enables you to see the list of most approved / rejected comments from your channel / weblog.

              • Required parameters - top
                • * This tag can use only one parameter at a time. Please use on of the following:
                  channel="channel-goes-here"
                  or
                  weblog="weblog-goes-here"

                • Multiple channels/weblogs can be added being separated with a pipe:
                  channel="channel-goes-here|other-channel-goes-here"
                  weblog="weblog-goes-here|weblog-goes-here"

              • Optional - top
                  • entry_id   or url_title
                    Reduces the number of results returned by the tag by returning only with ones that have an entry id or are from a url
                    entry_id="1337"
                    url_title="url-title-goes-here"

                  • order_by
                    Sets the listing order for the approved / rejected returned comments that are stored in your channel.
                    order_by="date"

                  • sort
                    Sets the listing sorting order for the approved / rejected comments that are stored in your channel.
                    sort="asc"

                  • limit
                    Limits the number of approved / rejected returned comments.
                    limit="7"

                  • type
                    Set the type of entries the tag will return. Use approved or rejected.
                    type="rejected"

                  • only_current_user
                    Used for returning approved / rejected comments that are set by the current user.
                    If the current user is logged in than the results will be relative to his login information, otherwise to his cookie information.
                    only_current_user="true"

          • Variables - top
                  • count
                    The {count} variable returns the number of approved and rejected entries for a given comment set in to type parameter.
                    If the parameter is not set than the result will be relative to the approved entries.

                  • opposite_count
                    The opposite_count variable returns the count of the opposite type from the count variable.

                  • entry_id
                    The entry_id variable returns the entry_id of the approved / rejected comment.

                  • comment_id
                    The comment_id variable returns the comment_id of approves / disliked comment.

                  • name
                    The name variable returns the name associated with the approved / rejecfted comment.

                  • email
                    The email variable returns email address of the user who approved / rejected the comment.

                  • url
                    The url variable returns the url associated with the approved / rejected comment.

                  • location
                    The location variable returns the location from where the user approved / rejected the comment.

                  • comment
                    The comment variable returns returns the comment.

          • Example - top
            {exp:eeasylike:comments
              channel="default_site"
              only_current_user="true"
            }
              {name} ({count} approved, {opposite_count} rejected)
              <br />
              email: {email}
              <br />
              location: {location}
              <br />
              {comment}
              <hr />
            {/exp:eeasylike:comments}


      • Approvers

        - top
          • Description- top
            The tag functionality shows approved / rejeced entries and user info.
            *This works for users that have approved / rejected entries while they where logged in.

              • Required parameters - top
                * This tag can use only one parameter at a time. Please use on of the following:
                entry_id="1337"
                or
                url-title="url-title-goes-here"
                or
                comment_id="31337"

              • Optional parameters - top
                  • type
                    Set the type of entries the tag will return.
                    Use approved, rejected or all.
                    type="approved"

                  • limit
                    Limits the number of results returned by the tag.
                    limit="3"

          • Variables - top
              • eeasylike_member_id
                The eeasylike_member_id variable returns the member id of the approver.

              • eeasylike_username
                The eeasylike_username variable returns the username of the approver.

              • eeasylike_screen_name
                The eeasylike_screen_name variable returns the screen name of the approver.

              • eeasylike_email
                The eeasylike_email variable returns the email address of the approver.

              • eeasylike_url
                The eeasylike_url variable returns the url of the approver.

              • eeasylike_occupation
                The eeasylike_occupation variable returns the occupation of the approver

              • eeasylike_interests
                The eeasylike_interests variable returns the interests of the approver.

              • eeasylike_bday_d
                The eeasylike_bday_d variable returns the birthdate day of the approver.

              • eeasylike_bday_m
                The eeasylike_bday_m variable returns the birthdate month of the approver.

              • eeasylike_bday_y
                The eeasylike_bday_y variable returns the birthdate year of the approver.

              • eeasylike_aol_im
                The eeasylike_aol_im variable returns the AIM address of the approver.

              • eeasylike_yahoo_im
                The eeasylike_yahoo_im variable returns the Yahoo IM address of the approver.

              • eeasylike_msn_im
                The eeasylike_msn_im variable returns the MSN IM address of the approver.

              • eeasylike_icq
                The eeasylike_icq variable returns the ICQ address of the approver.

              • eeasylike_bio
                The eeasylike_bio variable returns the biography of the approver.

              • eeasylike_signature
                The eeasylike_signature variable returns the signature of the approver.

              • eeasylike_avatar_filename
                The eeasylike_avatar_filename variable returns the approver's avatar filename.

              • eeasylike_avatar_width
                The eeasylike_avatar_width variable returns the width approver's avatar width.

              • eeasylike_avatar_height
                The eeasylike_avatar_height variable returns the width approver's avatar height.

              • eeasylike_photo_filename
                The eeasylike_icq variable returns the approver's photo filename.

              • eeasylike_photo_width
                The eeasylike_photo_width variable returns the approver's photo width.

              • eeasylike_photo_height
                The eeasylike_photo_height variable returns the approver's photo height.

          • Example - top
            {exp:channel:entries
              channel="channel-goes-here"
            }
              {exp:likee:likers entry_id="{entry_id}"}
                {eeasylike_member_id} member id
                <br />
                {eeasylike_username} user name
                <br />
                {eeasylike_email} email
              {/exp:likee:likers}
              <hr />
            {/exp:channel:entries}