Phoenix v1.3.0-rc.3 Phoenix.Naming View Source
Conveniences for inflecting and working with names in Phoenix.
Link to this section Summary
Functions
Converts String to camel case
Converts an attribute/form field into its humanize version
Extracts the resource name from an alias
Converts String to underscore case
Removes the given suffix from the name if it exists
Link to this section Functions
Converts String to camel case.
Takes an optional :lower
option to return lowerCamelCase.
Examples
iex> Phoenix.Naming.camelize("my_app")
"MyApp"
iex> Phoenix.Naming.camelize("my_app", :lower)
"myApp"
In general, camelize
can be thought of as the reverse of
underscore
, however, in some cases formatting may be lost:
Phoenix.Naming.underscore "SAPExample" #=> "sap_example"
Phoenix.Naming.camelize "sap_example" #=> "SapExample"
Converts an attribute/form field into its humanize version.
iex> Phoenix.Naming.humanize(:username)
"Username"
iex> Phoenix.Naming.humanize(:created_at)
"Created at"
iex> Phoenix.Naming.humanize("user_id")
"User"
Link to this function
resource_name(alias, suffix \\ "")
View Source
resource_name(String.Chars.t, String.t) :: String.t
Extracts the resource name from an alias.
Examples
iex> Phoenix.Naming.resource_name(MyApp.User)
"user"
iex> Phoenix.Naming.resource_name(MyApp.UserView, "View")
"user"
Converts String to underscore case.
Examples
iex> Phoenix.Naming.underscore("MyApp")
"my_app"
In general, underscore
can be thought of as the reverse of
camelize
, however, in some cases formatting may be lost:
Phoenix.Naming.underscore "SAPExample" #=> "sap_example"
Phoenix.Naming.camelize "sap_example" #=> "SapExample"