Drops are an important concept in terms of the Ctesius app and most methods you use will come from one of the drops. Each property record, for example, will call the PropertyDrop class and thus methods such as property.price are made available for each property.
NOTE: You should always check that a variable exists before you try to use it, to avoid errors when the value is nil. e.g.
{% if property.video_url %}
{% property.video_url | split: '/' %}
{% endif %}You can print the available methods on any Ctesius drop as a comma-separated string using available_methods.
{{ property.available_methods }}Below are the methods available on the AgencyDrop, what they return and also what they expect to be passed when calling the method.
Returns: Agency address with HTML formatting
Returns: A array of the staff member’s surnames, ordered alphabetically.
Returns: A collection of agency_portal_prefereces. See AgencyPortalPreferenceDrop
Returns: An array of all articles for an Agency. See ArticleDrop
Returns: See ArticleDrop
Expects: An article_id as a string
Returns: All the topics used by the Agency for articles. Useful for blog type topic lists
Returns: An array of topics
Returns: An array of banners set up by an Agency
Returns: The specified BannerDrop
Expects: A banner_id as a string
Returns: A BranchDrop object
Expects: A branch_id as a string
Returns: A collection of all the Agency branches as branch drops
Returns: An array of branches, arranged in the order they appear in the agency’s admin.
Returns: An array of branches, in alphanumeric order.
Returns: A collection of the Agency’s CarouselItemDrop’s
Returns: The default search channel for the Agency, either ‘sales’ or ‘lettings’
Returns: A string URL for the Agency’s facebook page
Returns: A collection of PageDrop’s that have been set to be featured
Returns: A random BranchDrop from a sample of branches that have been set to featured
Returns: A collection of PropertyDrop’s that have been set to be featured
Returns: A string URL for the Agency’s googleplus page
Returns: A boolean whether any of the social links have been set
Returns: A string of the URL for the agency’s Instagram page.
Returns: The agency’s latest article, as an ArticleDrop.
Returns: Boolean for if lettings are enabled
Returns: A string URL for the Agency’s linkedin page
Returns: A MrRichardImage for the Agency logo
Returns: A collection of specific locations defined by the Agency
Returns: A MenuDrop
Expects: A menu_id as a string from a choice of [‘primary’, ‘secondary’]
Returns: All the MenuDrop’s for the Agency
Returns: A specific CRMPageDrop cms page object
Expects: A string page_id
Returns: An array of all categories used for pages for the Agency site
Returns: A collection of CRMPageDrop’s for the Agency Limit: Page size is 10
Returns: The agency’s Pinterest URL as a string, if they have one.
Returns: A collection of properties by a specific tag
Expects: A string tag, such as ‘house’ or ‘garden’ etc
Limit: 10
Returns: A collection of properties that have video’s
Limit: 10
Returns: A MrRichardImage for the Agency specific Portal logo
Returns: A collection of the latest lettings properties
Limit: 10
Returns: A collection of the latest properties
Limit: 10
Returns: A collection of the latest sales and lettings properties
Limit: 10
Returns: A collection of the latest sales properties
Limit: 10
Returns: A boolean to represent if the Agency has sales properties
Returns: An array of the carousel items, ordered randomly.
Returns: A collection of all the StaffMemberDrop’s for the agency
Returns: The subdomain for the Agency site as a string
Returns: A string for the URL of the twitter page
Returns: A boolean representation if the website has been published live
Returns: A MrRichardImage of the Agency’s website specific logo. This can be used if the original logo does not work well on the site
Returns: A string for the URL of the company’s Youtube page.
Below are the methods available on the ArticleDrop, what they return and also what they expect to be passed when calling the method.
Returns: The StaffMemberDrop of the Article author.
Returns: The id of the staff member who wrote the article.
Returns: The article’s ID.
Returns: The associated branch as a BranchDrop.
Returns: The ID of the branch associated with the article.
Returns: The canonical_url for the article.
Returns: The Article content text.
Returns: The raw date/time the article was created.
Returns: The date the article was created, formatted.
Returns: A MrRichardImage of the article hero asset.
Returns: A MrRichardImage of the article main image.
Returns: The article’s meta title as a string.
Returns: The article’s meta title as a string.
Returns: The month the article was created.
Returns: The article promo text content.
Returns: A MrRichardImage of the article promo image, which could be used on list pages or the homepage.
Returns: A string URL friendly link name for the Article.
Returns: The Article’s title as a string.
Returns: The topic of the Article as a string.
Returns: An array of topics for the article if they are comma seperated.
Returns: The year the article was created.
Below are the methods available on the BannerDrop, what they return and also what they expect to be passed when calling the method.
Returns: The name of the Banner as a String
Returns: An Array of BannerMenuItemDrop objects
Below are the methods available on the BranchDrop, what they return and also what they expect to be passed when calling the method.
Returns: The Branch address with line breaks
Returns: A collection of the latest lettings properties, including those with all statuses (including ‘sold’ etc).
Limit: 5
Returns: A collection of the latest sales properties, including those with all statuses (including ‘sold’ etc).
Limit: 5
Returns: The AgencyDrop for that Branch
Returns: The branch manager as a StaffMemberDrop
Returns: A string valud for the Branch sales telephone number
Returns: A string valud for the Branch lettings telephone number
Returns: A string valud for the Branch telephone number based on the channel
Expects: A string channel of ‘sales’ or ‘lettings’
Returns: A boolean to check if a staff member is assigned to the Branch
Expects A StaffMemberDrop
Returns: An array of content chunks, as hashes, where the branch has been set to this one.
Returns: An array of content chunks, as ContentBlockDrops, where the branch has been set to this one.
Returns: The default VOX telephone number as a string
Returns: The Branch description as text
Returns: The Branch description as text and if this is blank then the Branch Agency description is returned
Returns: A string URL for the Branch’s facebook page
Returns: A string URL for the Branch’s googleplus page
Returns: A boolean if any social links are set
Returns: The hero image for the Branch as a MrRichardImage
Returns: A collection of StaffProfileDrop’s of any lettings negotiators
Returns: A string URL for the Branch’s linkedin page
Returns:
Returns: A specific node associated with the branch.
Returns: An array of nodes associated with the branch.
Returns: The default photo for the Branch as a MrRichardImage
Returns: A collection of MrRichardImage’s for the Branch photos
Returns: A collection of the latest sales properties
Limit: 5
Returns: A collection of the latest lettings properties
Limit: 5
Returns: A collection of the latest properties
Limit: 5
Returns: A collection of StaffMemberDrops of any sales negotiators
Returns: A collection of StaffMemberDrops for all the Branch employees
Returns: An individual staff member’s StaffMemberDrop
Expects: A string staff_member_id
Returns: A collection of the latest lettings properties
Limit: 10
Returns: A collection of the latest sales properties
Limit: 10
Returns: A string URL for the Branch’s twitter page
Returns: A collection of VOX number strings for the branch
Returns: A MrRichardImage for the CarouselItem image
Returns: A string link URL
Returns: The price for the CarouselItem if it is a property type
Returns: The primary channel [‘sales’,’lettings’] if the type is a property
Returns: The promo content text
Returns: The property status if CarouselItem type is property
Returns: The main title of the CarouselItem. If a property type then this is the address
Returns: Whether the CarouselItem is a property or CMS content
Returns:
Returns:
Returns: The CountyDrop that the Location belongs to
Returns: Boolean whether the Location has a polygon or not
Returns: A collection of AgencyDrop’s nearby Limit 10 results
Returns: A collection of BranchDrop’s nearby Limit 10 results
Returns: A collection of LocationDrop’s nearby Limit 10 results
Returns: The closest BranchDrop to the center point for the Location
Returns: The name as a string
Returns: A collection of polygons that make up the Location
Returns:
Returns: A string value of the title of the Node
Returns: The node meta_title as a string
Returns: The meta_description of the node as a string
Returns: A string with the Node’s description
Returns: The type of the Node
Returns: The slug for the Node as a string
Returns: The current action name as a string. Example use of this would be to target CSS content for certain pages of the site.
Returns: The current controller name as a string. A typical use of this would be to target CSS content for areas of the site.
Returns: The URL to the Hero asset
Returns:
Returns:
Returns:
Returns::
Returns:
Returns:
Returns:
Returns: A boolean stating whether there are any sidebars that can be rendered on the page
Returns: HTML content for the sidebar for that page
Returns:
Returns: An integer value for the current page number
Returns:
Returns: An integer value for the record number of the first listing on that page
Returns: A boolean if there is another page of results
Returns: A boolean if there is a previous page of results
Returns:
Returns:
Returns: An integer value for the total number of pages
Returns: An integer value for the number of records per page
Returns:
Returns: An integer value for the record number of the last listing on that page
Returns: An integer value for the total number of records
Returns: A specific ArticleDrop
Expects String article_id
Returns:
Returns: A collection of PropertyDrop’s that have been set to be featured
Returns: A boolean whether the site has a menu
Returns:
Returns: A collection of MenuItemDrop’s
Returns: A collection of BranchDrop’s near the Portal’s center point Limit 10
Returns: A specific PageDrop
Expects String page_id
Returns: A boolean if the website has gone live
Returns: A MrRichardImage of the Portal’s website specific logo. This can be used if the original logo does not work well on the site
Updated 2/2/2017
This is a comprehensive list of the methods available to theme templates as Liquid variables from property pages. To use these within the infinite scroll template on the properties index page, they will need to be added to the _properties_list.ljson file.
Returns: The url for the property’s audio tour as a string, if it has one.
Returns: The total acreage of the property, as an integer.
Returns: The total acreage of the property, as a float.
Returns: The full property address as a string, with the lines separated by commas.
Returns: A random staff member from those associated with the property.
Returns: An array of staff members associated with the property.
Returns: An array of staff members associated with the property who have avatar images.
Returns: A random staff member from those associated with the property who have avatar images.
Returns: A random staff member from those associated with the property who are contactable for sales.
Returns: An array of staff members associated with the property who are contactable for sales.
Returns: A random staff member from those associated with the property who are contactable for lettings.
Returns: An array of staff members associated with the property who are contactable for lettings.
Returns: If supplied, the date the property is available.
Returns: An integer for number of bathrooms that sometimes comes in as zero or empty so needs to be checked.
Returns: Return the associated branch for the property as a BranchDrop.
Returns: the name of the associated branch as a string.
Returns: the associated branch’s url label (the last part of the url for linking to a branch).
Returns: the associated branch’s ID.
Returns: An integer for bedroom count that sometimes comes in as zero or empty so needs to be checked.
Returns: A string of the number of bedrooms followed by the correctly pluralized word. e.g “1 bedroom” / “2 bedrooms”
Returns: This for loop would output all the brochures supplied.
Example use:
{% for brochure in property.brochures %}
<li><a href="{{ brochure | url_for_property_asset }}">Download brochure</a></li>
{% endfor %}Returns: The name of the property’s building, if it has one.
Returns: the property’s child properties, if it has any.
Returns: The property’s county.
Returns: The number of days the property has been available.
Returns: The property’s full description (short + long if the short description is not taken from the long description).
Returns: This for loop would output all the EPC charts supplied.
Example use:
{% for epc_chart in property.epc_charts %}
{% if forloop.first %}
<a href="{{ epc_chart | url_for_property_asset }}">
{% if property.epc_charts.size == 1 %}
View EPC chart
{% else %}
View EPC charts
{% endif %}
</a>
{% else %}
<a href="{{ epc_chart | url_for_property_asset }}" style="display:none"></a>
{% endif %}
{% endfor %}Returns: the url for the property’s first external link.
Returns: A list of property features that can be displayed as bullet points.
Returns: The collection of floor plans. This loop could output the floor plans to a light box e.g Fancybox, Colorbox, etc.
Example use:
{% for floorplan in property.floorplans %}
{% if forloop.first %}
<a href="http://mr0.homeflow-assets.co.uk/{{ floorplan.image }}" title="Floor plan">
{% if property.floorplans.size == 1 %}
View floor plan
{% else %}
View floor plans
{% endif %}
</a>
{% else %}
<a href="http://mr0.homeflow-assets.co.uk/{{ floorplan.image }}" style="display:none;" title="Floor plan"></a>
{% endif %}
{% endfor %}Returns: A boolean value for whether the property has an audio tour.
Returns: A boolean value for whether the property has an external link.
Returns: A boolean value for whether the property has a video.
Returns: A boolean value for whether the property has a virtual tour.
Returns: an array of high resolution photos for the property, if available.
Returns: An array of home reports for the property, if there are any.
Returns: EPC charts that are images.
Returns: The investment yield for the property, if available (defaults to 0).
Returns: a boolean value for whether the property’s tags contains ‘auction’
Returns: a boolean value for whether the property’s tags contains ‘commercial’
Returns: a boolean value for whether the property’s tags contains ‘new homes’
Returns: A Boolean if the property is a short let property
Returns: a boolean value for whether the property’s tags contains ‘premium’
Returns: The body of a content chunk named ‘lettings_fee_text’ if it exists and the property’s primary channel is lettings.
Returns: Any links for the property.
Returns: the long description for the property.
Returns: the typical repayment according to the mortgage advice bureau.
Returns: the property’s first photo.
Returns: the property’s nearest location, as a LocationDrop.
Returns: The nodes for the property, if there are any.
Returns: an array of the photos for the property.
Returns: the property’s price.
Returns: the property’s price without the ‘£’ or any preceding qualified like ‘Offers in the region of’.
Returns: ‘sales’ or ‘lettings’
Returns: The agent’s supplied property reference.
Returns: The type of property as a string (‘house’, ‘flat’ etc)
Returns: The property’s description, with any HTML tags stripped out.
Returns: The property’s short description, with any HTML tags stripped out.
Returns: A numerical figure that sometimes comes in as zero or empty so needs to be checked.
Returns: The property’s rent calculated for one week.
Returns: The property’s road name.
Returns: a short description for the property, if it has one.
Returns: The short description, if it has one. Otherwise, the long description.
Returns: The total area of the property, in square feet.
Returns: An array of the tags set for the property.
Returns: A slug for the property - using bedrooms, type, road name and postcode and joined with hyphens.
Returns: Homeflow is able to generate recorded telephone numbers for properties. Doing a check on this drop can see whether one is available.
Returns: The url for the property’s first video, if it has one (as a string).
Returns: the url for the property’s virtual tour, if it has one (as a string).
Returns: The alert frequency set for a saved search, as a string.
Returns: The bedrooms as a String in a more titled format. i.e ‘between 6 and 9 bedrooms’
Returns: The search channel as a String. Either ‘sales’ or ‘lettings’
Returns: A string of the price description and bedrooms combined
Returns: The search fragment as a string, e.g. ‘/up-to-800/most-recent-first’
Returns: The geospacial description from the location searched
Requires The search to have a location
Returns: The max acreage
Returns: The min acreage
Returns: The max square feet
Returns: The min square feet
Returns: The min bedrooms with the price qualifier as a String
Returns: The max bedrooms with the price qualifier as a String
Returns: The Integer value of the min bedrooms
Returns: The Integer value of the max bedrooms
Returns: The min price value as an Integer
Returns: The max price value as an Integer
Returns: The query string for the search
Returns: The order to return properties as a string, e.g. ‘most-recent-first’
Returns: Either the location or county for the search as a String
Returns: The price as a String in a more titled format. i.e ‘between £150,000 and £200,000’
Returns: The search radius in kilometres, as an integer.
Returns: The search radius in miles, as an integer.
Returns: The search radius in miles as a String, formatted. E.g. ‘1/2 mile’ or ‘50’ miles
Returns: The search radius in meters, as a float.
Returns: The status for searched properties, e.g. ‘sold’.
Returns: A String representation of the tags used for the search. These are often used for property type filtering.
Returns: The AgencyDrop associated with the StaffMember
Returns: A MrRichardDrop image for the StaffMember’s avatar
Returns: The BranchDrop for the StaffMember
Returns: If entered on the system, the staff member’s direct dial number.
Returns: A boolean for whether the StaffMember has an avatar available
Returns: A boolean whether any of the StaffMember’s social page URL’s have been set
Returns: The staff member’s Twitter URI.
Returns: The staff member’s linkedin URI.
Returns: The staff member’s Facebook URI.
Returns: The staff member’s Google+ URI.
Returns: The staff member’s Instagram URI.
Returns: The long biography for the StaffMember
Returns: The full name as a string for the StaffMember
Returns: Some staff names contain lengthy qualification acronyms that can cause layout problems - use this to strip these acronyms.
Returns: A collection of comments against properties made by the StaffMember
Returns: The articles where the author is the staff member.
Returns: If the staff member has a video URL entered on the system, this field will retrieve it. Note there’s no guarantee what format or type of link this will be.
Returns: The name of the person with which the Testimonial was from as a String
Returns: The Testimonial content as Text
Returns: A String representation of the channel (sales, lettings)
Returns: A BranchDrop for the Testimonial, if available
Returns: The data and time the Testimonial was created as a String
Returns: The name of the business, eg “Aldi”
Returns: The umbrella category to which the business belongs, eg “Groceries, Supermarkets & Food Shops”
Returns: The specific category to which the business belongs, eg “Supermarkets”
Returns: The type of business, eg “Multiple”
Returns: The umbrella company to which the business belongs, eg “Hofer KG”
Returns: The classification in which the business falls, eg “Convenience”
Returns: A short description outlining what the business does, eg “Aldi sell a wide range of groceries, fresh fruit and vegetables, chilled and frozen foods, alcohol and household goods.”
Returns: A url that links to an image of the business
Returns: The opening times for that business, eg “Sun: 10:00-16:00 Mon: 08:00-22:00 Tue: 08:00-22:00 Wed: 08:00-22:00 Thu: 08:00-22:00 Fri: 08:00-22:00 Sat: 08:00-22:00”
Returns: The formatted address of the business , eg
“unit”: null,
“building”: “A5”,
“street_number”: null,
“street_name”: “Watling Street”,
“town”: “Hinckley”,
“county”: “Leicestershire”,
“region”: “East Midlands”,
“postcode”: “LE10 3ED”
Returns: Returns the distance that the business is from the property, branch or location.
To access the additional information about the property, just reference property.facets, e.g.
{{ property.facets.council_tax_amount }}These are the available values:
Returns: The cost of the property’s council tax.
Returns: The single-letter designation for the property’s council tax band.
Returns: The property’s local council, e.g. “London Borough of Brent”
Returns: a 1 if the property is chain-free.
Returns: the actual CO2 rating for the property.
Returns: the potential CO2 rating for the property.
Returns: the actual EPC rating for the property.
Returns: the landlord registration number, if applicable.
Returns: the type of heating for the property.
Returns: a 1 if couples occupancy is accepted.
Returns: a 1 if single occupancy is accepted.
Returns: a 1 if the property is a studio.
Returns: the maximum let duration.
Returns: a 1 if the rent includes rates tax.